Consents

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.

Download OpenAPI description

consents.openapi.json

consents.openapi.yaml

Servers

Production environment (US, worldwide, except EU & Canada)

https://api.transmitsecurity.io/cis/

Production environment (EU)

https://api.eu.transmitsecurity.io/cis/

Production environment (CA)

https://api.ca.transmitsecurity.io/cis/

Get all consents

Request

Retrieve all consents.

Required permissions: apps:read, [appId]:read, consents:read.

Security

ClientAccessToken

Query

client_idstring

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

user_idstring

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

curl -i -X GET \
  'https://api.transmitsecurity.io/cis/v1/consents?client_id=string&user_id=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

resultArray of objectsrequired

result[].consent_idstringrequired

ID of the consent

result[].tenant_idstringrequired

ID of the tenant

result[].app_idstringrequired

ID of the app

result[].client_idstringrequired

ID of the client

result[].user_idstringrequired

ID of the user

result[].scopestringrequired

Configures the consent scope of the user

result[].created_atnumberrequired

Date the consent was created in the tenant

result[].expires_atnumberrequired

Date the consent will be expired

result[].updated_atnumberrequired

Date the consent will be expired

Response

application/json

{
  "result": [
    { … }
  ]
}

Get consent by ID

Request

Retrieve a consent by ID.

Required permissions: apps:read, [appId]:read, consents:read.

Security

ClientAccessToken

Path

consentIdstringrequired

ID of the consent to retrieve

curl -i -X GET \
  'https://api.transmitsecurity.io/cis/v1/consents/{consentId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

resultobjectrequired

result.consent_idstringrequired

ID of the consent

result.tenant_idstringrequired

ID of the tenant

result.app_idstringrequired

ID of the app

result.client_idstringrequired

ID of the client

result.user_idstringrequired

ID of the user

result.scopestringrequired

Configures the consent scope of the user

result.created_atnumberrequired

Date the consent was created in the tenant

result.expires_atnumberrequired

Date the consent will be expired

result.updated_atnumberrequired

Date the consent will be expired

Response

application/json

{
  "result": {
    "consent_id": "string",
    "tenant_id": "string",
    "app_id": "string",
    "client_id": "string",
    "user_id": "string",
    "scope": "string",
    "created_at": 0,
    "expires_at": 0,
    "updated_at": 0
  }
}

Delete consents by user ID

Request

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

Required permissions: apps:delete, [appId]:delete, consents:delete.

Security

ClientAccessToken

Path

clientIdstringrequired

ID of the client

userIdstringrequired

ID of the user

Query

consent_idstring

ID of the consent to delete

curl -i -X DELETE \
  'https://api.transmitsecurity.io/cis/v1/consents/clients/{clientId}/users/{userId}?consent_id=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Response

No content

Get all consents for an app

Request

Retrieve all consents for an app.

Required permissions: apps:read, [appId]:read, consents:read.

Security

ClientAccessToken

Query

client_idstring

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

user_idstring

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

app_idstringrequired

curl -i -X GET \
  'https://api.transmitsecurity.io/cis/v1/manage/consents?client_id=string&user_id=string&app_id=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

resultArray of objectsrequired

result[].consent_idstringrequired

ID of the consent

result[].tenant_idstringrequired

ID of the tenant

result[].app_idstringrequired

ID of the app

result[].client_idstringrequired

ID of the client

result[].user_idstringrequired

ID of the user

result[].scopestringrequired

Configures the consent scope of the user

result[].created_atnumberrequired

Date the consent was created in the tenant

result[].expires_atnumberrequired

Date the consent will be expired

result[].updated_atnumberrequired

Date the consent will be expired

result[].client_namestringrequired

Name of the client

Response

application/json

{
  "result": [
    { … }
  ]
}

Delete consents by client ID

Request

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

Required permissions: apps:delete, [appId]:delete, consents:delete.

Security

ClientAccessToken

Path

clientIdstringrequired

The consent ID to search for

userIdstringrequired

ID of the user

Query

consent_idstring

ID of the consent to delete

app_idstringrequired

curl -i -X DELETE \
  'https://api.transmitsecurity.io/cis/v1/manage/consents/clients/{clientId}/users/{userId}?consent_id=string&app_id=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Response

No content

Get all consents for current user

Request

Get all consents for current user

Security

UserAccessToken

curl -i -X GET \
  https://api.transmitsecurity.io/cis/v1/consents/me \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

resultArray of objectsrequired

result[].consent_idstringrequired

ID of the consent

result[].tenant_idstringrequired

ID of the tenant

result[].app_idstringrequired

ID of the app

result[].client_idstringrequired

ID of the client

result[].user_idstringrequired

ID of the user

result[].scopestringrequired

Configures the consent scope of the user

result[].created_atnumberrequired

Date the consent was created in the tenant

result[].expires_atnumberrequired

Date the consent will be expired

result[].updated_atnumberrequired

Date the consent will be expired

Response

application/json

{
  "result": [
    { … }
  ]
}

Revoke a consent by ID for current user

Request

Revoke a consent by ID for current user.

Security

UserAccessToken

Path

clientIdstringrequired

ID of the client

Query

consent_idstring

ID of the consent to delete

curl -i -X DELETE \
  'https://api.transmitsecurity.io/cis/v1/consents/me/clients/{clientId}?consent_id=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

messagestringrequired

error_codenumberrequired

Example: 404

Response

application/json

{
  "message": "string",
  "error_code": 404
}