Interface AcceptConsentRequest

interface AcceptConsentRequest {
    accepted_by?: string;
    accepted_fields?: string[];
    action_id?: string;
    action_type?: string;
    client_id: string;
    consent_id: string;
    consent_version_id: string;
    field_key?: string;
    q?: string;
    revoked?: boolean;
    scopes?: string[];
    skipped?: boolean;
    sub?: string;
    url?: string;
}

Properties

accepted_by? accepted_fields? action_id? action_type? client_id consent_id consent_version_id field_key? q? revoked? scopes? skipped? sub? url?

Properties

Optionalaccepted_by

accepted_by?: string

Sub of user, which will accept the consent

Optionalaccepted_fields

accepted_fields?: string[]

List of field_keys which has been accepted

Optionalaction_id

action_id?: string

Unique identifier for action, which trigger consent acceptance

Optionalaction_type

action_type?: string

Describe how the consent acceptance is triggered. E.g. "register", "login"

client_id

client_id: string

Unique identifier of client app, can be found in app setting under admin ui

consent_id

consent_id: string

Unique identifier for consent to be accepted

consent_version_id

consent_version_id: string

Unique identifier for version of the consent to be accepted

Optionalfield_key

field_key?: string

Unique name of field. Required to be passed when consent is field consent

Optionalq

q?: string

Masked sub (id of user), who will accept the consent. Either sub or q have to be provided, depends on what is given from the query parameter.

Optionalrevoked

revoked?: boolean

True, if consent has been revoked

Optionalscopes

scopes?: string[]

Scopes are list of functional definition. Required to be passed on scope consent (Ex: email, profile, openid)

Optionalskipped

skipped?: boolean

True if consent is optional and not accepted in consent accept page

Optionalsub

sub?: string

Masked sub (id of user), who will accept the consent. Either sub or q have to be provided, depends on what is given from the query parameter.

Optionalurl

url?: string

Consent url for user to accept terms or privacy policy

Settings

Member Visibility

On This Page

Properties