Get Consents By Organization Id Using GET
Get all active and requested consents for a particular organization
Access Policy
| Role | User Accounts | Service Accounts (Client Credentials Applications) |
|---|---|---|
| Organization Admin | ✔️ | ❌ |
| Organization Owner | ✔️ | ❌ |
Request
URI
GET
https://{api_host}/csp/gateway/am/api/orgs/{orgId}/consents
COPY
Path Parameters
string
orgId
Required
Unique identifier (GUID) of the organization.
Responses
200
Valid consent request.
Returns Array of ConsentDto of type(s) application/json
[
{
"target": {
"orgOwnerEmail": "string",
"orgId": "string"
},
"consentId": "string",
"source": {
"userId": "string"
},
"status": "string"
}
]
401
The user is not authorized to use the API
Returns CspErrorResponse of type(s) application/json
"CspErrorResponse Object"string
cspErrorCode
Optional
cspErrorCode
string
message
Optional
message
string
errorCode
Optional
errorCode
string
requestId
Optional
requestId
integer As int32 As int32
moduleCode
Optional
moduleCode
integer As int32 As int32
statusCode
Optional
statusCode
403
The user is forbidden to use the API
Returns CspErrorResponse of type(s) application/json
"CspErrorResponse Object"string
cspErrorCode
Optional
cspErrorCode
string
message
Optional
message
string
errorCode
Optional
errorCode
string
requestId
Optional
requestId
integer As int32 As int32
moduleCode
Optional
moduleCode
integer As int32 As int32
statusCode
Optional
statusCode
404
Consent is not present.
Returns CspErrorResponse of type(s) application/json
"CspErrorResponse Object"string
cspErrorCode
Optional
cspErrorCode
string
message
Optional
message
string
errorCode
Optional
errorCode
string
requestId
Optional
requestId
integer As int32 As int32
moduleCode
Optional
moduleCode
integer As int32 As int32
statusCode
Optional
statusCode
429
The user has sent too many requests
Returns CspErrorResponse of type(s) application/json
"CspErrorResponse Object"string
cspErrorCode
Optional
cspErrorCode
string
message
Optional
message
string
errorCode
Optional
errorCode
string
requestId
Optional
requestId
integer As int32 As int32
moduleCode
Optional
moduleCode
integer As int32 As int32
statusCode
Optional
statusCode
500
An unexpected error has occurred while processing the request
Returns CspErrorResponse of type(s) application/json
"CspErrorResponse Object"string
cspErrorCode
Optional
cspErrorCode
string
message
Optional
message
string
errorCode
Optional
errorCode
string
requestId
Optional
requestId
integer As int32 As int32
moduleCode
Optional
moduleCode
integer As int32 As int32
statusCode
Optional
statusCode
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/csp/gateway/am/api/orgs/{orgId}/consents