API docs by Redocly

Consent Management API (2024-05-24)

Download OpenAPI specification:Download

ListServiceUserConsent

List consents a user has granted to a given service.

path Parameters
serviceId
required
string

Unique identifier for a service.

userId
required
string

Unique identifier for a user.

query Parameters
limit
number

Optional. Maximum number of Consents to return in a single response.

pageToken
string

Optional. The nextPageToken returned from the previous list request.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "nextPageToken": "string"
}

CreateServiceUserConsent

Create a user Consent for a given service.

path Parameters
serviceId
required
string

Unique identifier for a service.

userId
required
string

Unique identifier for a user.

Request Body schema: application/json
required
status
required
string (ConsentStatus)
Enum: "ACTIVE" "EXPIRED" "REVOKED"

Current status of a Consent.

object (ConsentData) <= 32 properties

Consent data represented by string key-value pairs. Keys must be between 1-64 characters long, values must be between 1-256 characters long, and up to 32 key-value pairs may be provided.

expiryTime
string <date-time>

Time when the Consent automatically expires, using the ISO 8601 format.

Responses

Request samples

Content type
application/json
{
  • "status": "ACTIVE",
  • "consentData": {
    },
  • "expiryTime": "2019-08-24T14:15:22Z"
}

GetServiceUserConsent

Retrieve a user Consent for a given service.

path Parameters
consentId
required
string

Unique identifier for a Consent.

serviceId
required
string

Unique identifier for a service.

userId
required
string

Unique identifier for a user.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

UpdateServiceUserConsent

Update a user Consent for a given service.

path Parameters
consentId
required
string

Unique identifier for a Consent.

serviceId
required
string

Unique identifier for a service.

userId
required
string

Unique identifier for a user.

Request Body schema: application/json
status
string (ConsentStatus)
Enum: "ACTIVE" "EXPIRED" "REVOKED"

Current status of a Consent.

object (ConsentData) <= 32 properties

Consent data represented by string key-value pairs. Keys must be between 1-64 characters long, values must be between 1-256 characters long, and up to 32 key-value pairs may be provided.

expiryTime
string <date-time>

Time when the Consent automatically expires, using the ISO 8601 format.

Responses

Request samples

Content type
application/json
{
  • "status": "ACTIVE",
  • "consentData": {
    },
  • "expiryTime": "2019-08-24T14:15:22Z"
}