Consents

Download OpenAPI specification:Download

Manage consent requests and consents. These APIs allow third party clients to request consent from app users. They also allow users to grant consent requests, view all consents related to their account, and revoke any granted permissions.

Get all consents

Retrieve all consents.

SecurityOAuth2: ClientAccessToken
Request
query Parameters
client_id
string

ID of the client whose consents are to be retrieved. If not provided, all consents will be retrieved.

user_id
string

ID of the user whose consents are to be retrieved. If not provided, all consents will be retrieved.

Responses
200
get/v1/consents
Request samples
Response samples
application/json
{
  • "result": [
    ]
}

Get consent by ID

Retrieve a consent by ID.

SecurityOAuth2: ClientAccessToken
Request
path Parameters
consentId
required
string

ID of the consent to retrieve

Responses
200
404
get/v1/consents/{consentId}
Request samples
Response samples
application/json
{
  • "result": {
    }
}

Delete consents by user ID

Delete consents by user ID. If no consent ID is provided, all consents for the user are deleted.

SecurityOAuth2: ClientAccessToken
Request
path Parameters
clientId
required
string

ID of the client

userId
required
string

ID of the user

query Parameters
consent_id
string

ID of the consent to delete

Responses
200
404
delete/v1/consents/clients/{clientId}/users/{userId}
Request samples
Response samples
application/json
{
  • "message": "string",
  • "error_code": 404
}

Get all consents for an app

Retrieve all consents for an app.

SecurityOAuth2: ClientAccessToken
Request
query Parameters
client_id
string

ID of the client whose consents are to be retrieved. If not provided, all consents will be retrieved.

user_id
string

ID of the user whose consents are to be retrieved. If not provided, all consents will be retrieved.

app_id
required
string
Responses
200
get/v1/manage/consents
Request samples
Response samples
application/json
{
  • "result": [
    ]
}

Delete consents by client ID

Delete consents by client ID. If no consent ID is provided, all consents for the client are deleted.

SecurityOAuth2: ClientAccessToken
Request
path Parameters
clientId
required
string

The consent ID to search for

userId
required
string

ID of the user

query Parameters
consent_id
string

ID of the consent to delete

app_id
required
string
Responses
200
404
delete/v1/manage/consents/clients/{clientId}/users/{userId}
Request samples
Response samples
application/json
{
  • "message": "string",
  • "error_code": 404
}

Get all consents for current user

Get all consents for current user

SecurityHTTP: UserAccessToken
Responses
200
get/v1/consents/me
Request samples
Response samples
application/json
{
  • "result": [
    ]
}

Revoke a consent by ID for current user

Revoke a consent by ID for current user.

SecurityHTTP: UserAccessToken
Request
path Parameters
clientId
required
string

ID of the client

query Parameters
consent_id
string

ID of the consent to delete

Responses
404
delete/v1/consents/me/clients/{clientId}
Request samples
Response samples
application/json
{
  • "message": "string",
  • "error_code": 404
}