Approve Consent
DescriptionApprove or reject the consent.
Access Policy
| Role | User Accounts | Service Accounts (Client Credentials Applications) |
|---|---|---|
| Organization Admin | ✔️ | ❌ |
| Organization Owner | ✔️ | ❌ |
Request
URLURL
Path Parameters
Path Parameters
Unique identifier (GUID) of the organization.
The unique identifier of the CONSENT.
Query Parameters
Query Parameters
Action taken by Customer on consent request. It can have only two values APPROVE|REJECT.
Request Body
{
"expiry": "2004-07-25T06:18:20.541Z"
}
The timestamp the consent expires at (provided in ISO 8601 format, yyyy-MM-dd’T’HH:mm:ss.SSSXXX e.g. 2004-07-25T06:18:20.541Z).
Authentication
Response
Response BodyResponse Body
200 OK
Valid consent approval contract.
{
"consentId": "string",
"source": {
"userId": "string"
},
"status": "ACTIVE",
"target": {
"orgId": "string",
"orgOwnerEmail": "string"
}
}
The unique identifier of the CONSENT.
Possible values are: ACTIVE , REQUESTED , REJECTED
Errors
The user is not authorized to use the API
The user is forbidden to use the API
Consent is not present.
The request could not be processed due to a conflict
The user has sent too many requests
An unexpected error has occurred while processing the request
Code Samples
cURL Command
Vendor Extensions
x-required-roles: org_owner,org_admin
x-slo-tier: TIER2
