Class ConsentService

Index

Constructors

constructor

Methods

acceptClaimConsent acceptConsent acceptScopeConsent getConsentDetails getConsentVersionDetails revokeClaimConsent

Constructors

constructor

new ConsentService(configUserProvider: ConfigUserProvider): ConsentService
Parameters
- configUserProvider: ConfigUserProvider
Returns ConsentService
- Defined in src/main/consent-service/ConsentService.ts:11

Methods

acceptClaimConsent

acceptClaimConsent(
options: AcceptClaimConsentRequest,
headers?: HTTPRequestHeader,
): Promise<any>
To accept claim consent, call acceptClaimConsent().
Parameters
- options: AcceptClaimConsentRequest
- Optionalheaders: HTTPRequestHeader
Returns Promise<any>
Example
```
cidaasConsentService.acceptClaimConsent({
  client_id: 'your client id',
  sub: 'masked sub',
  accepted_claims: [your claim consents]
 });
```
- Defined in src/main/consent-service/ConsentService.ts:110

acceptConsent

acceptConsent(
options: AcceptConsentRequest,
headers?: HTTPRequestHeader,
): Promise<any>

To accept consent, call acceptConsent().

Parameters

options: AcceptConsentRequest
Optionalheaders: HTTPRequestHeader

Returns Promise<any>

Example

cidaasConsentService.acceptConsent({
  client_id: 'your client id',
  consent_id: 'consent id',
  consent_version: 'consent version id',
  sub: 'masked sub'
}).then((response) => {
  // the response will give you details of accepted consent.
}).catch((err) => {
  // your failure code here
});

acceptScopeConsent

acceptScopeConsent(
options: AcceptScopeConsentRequest,
headers?: HTTPRequestHeader,
): Promise<any>
To accept scope consent, call acceptScopeConsent().
Parameters
- options: AcceptScopeConsentRequest
- Optionalheaders: HTTPRequestHeader
Returns Promise<any>
Example
```
cidaasConsentService.acceptScopeConsent({
  client_id: 'your client id',
  sub: 'masked sub',
  scopes: [your scope consents]
 });
```
- Defined in src/main/consent-service/ConsentService.ts:94

getConsentDetails

getConsentDetails(
options: GetConsentDetailsRequest,
headers?: HTTPRequestHeader,
): Promise<any>
To get consent details , call getConsentDetails(). Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/858fbeb51c62b-find-consent-info for more details.
Parameters
- options: GetConsentDetailsRequest
- Optionalheaders: HTTPRequestHeader
Returns Promise<any>
Example
```
cidaasConsentService.getConsentDetails({
  consent_id: 'consent id',
  consent_version_id: 'consent version id',
  sub: 'masked sub'
})
.then(function (response) {
 // type your code here
})
.catch(function (ex) {
 // your failure code here
});
```
- Defined in src/main/consent-service/ConsentService.ts:34

getConsentVersionDetails

getConsentVersionDetails(
options: GetConsentVersionDetailsRequest,
headers?: HTTPRequestHeader,
): Promise<any>
To get version details of consent, call getConsentVersionDetails(). Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/7e24ac2113315-get-consent-version-details for more details.
Parameters
- options: GetConsentVersionDetailsRequest
- Optionalheaders: HTTPRequestHeader
Returns Promise<any>
Example
```
cidaasConsentService.getConsentVersionDetails({
  consentid: 'your consent id',
  locale: 'browser accept language or custom language',
}).then((response) => {
  // type your code here
}).catch((err) => {
  // your failure code here
});
```
- Defined in src/main/consent-service/ConsentService.ts:75

revokeClaimConsent

revokeClaimConsent(options: RevokeClaimConsentRequest): Promise<any>
To revoke claim consent, call revokeClaimConsent(). Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/9ae62e98842fe-revoke-user-consent-claim for more details.
Parameters
- options: RevokeClaimConsentRequest
Returns Promise<any>
Example
```
cidaasConsentService.revokeClaimConsent({
   client_id: 'your client id',
   sub: 'masked sub'
   revoked_claims: [your claim consents]
 }).then((response) => {
   // the response will give you revoked claim consent.
 }).catch((err) => {
   // your failure code here 
 }); 
```
- Defined in src/main/consent-service/ConsentService.ts:131

Class ConsentService

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns ConsentService

Methods

acceptClaimConsent

Parameters

Returns Promise<any>

Example

acceptConsent

Parameters

Returns Promise<any>

Example

acceptScopeConsent

Parameters

Returns Promise<any>

Example

getConsentDetails

Parameters

Returns Promise<any>

Example

getConsentVersionDetails

Parameters

Returns Promise<any>

Example

revokeClaimConsent

Parameters

Returns Promise<any>

Example

Settings

On This Page