[{"label":"Latest (v1.0)","version":"latest"}]
csp

Get Consents By Organization ID

Description

Get all active and requested consents for a particular organization

Access Policy

Role User Accounts Service Accounts (Client Credentials Applications)
Organization Owner ✔️

Request

Request

URL

URL


get
https://{api_host}/csp/gateway/am/api/orgs/{orgId}/consents
Copy

Path Parameters

Path Parameters

string
orgId Required

Unique identifier (GUID) of the organization.

Parameter Serialization Style: simple Explode:false

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns array of ConsentDto of type application/json

Valid consent request.

{
	"consentId": "string",
	"source": {
		"userId": "string"
	},
	"status": "ACTIVE",
	"target": {
		"orgId": "string",
		"orgOwnerEmail": "string"
	}
}
target Required

Target organization metadata


string
consentId Optional

The unique identifier of the CONSENT.


source Optional

Source organization metadata


string
status Optional

Possible values are: ACTIVEREQUESTEDREJECTED

Errors

Errors

401

The user is not authorized to use the API


403

The user is forbidden to use the API


404

Consent is not present.


429

The user has sent too many requests


500

An unexpected error has occurred while processing the request

Code Samples

Code Samples

cURL Command

curl https://{api_host}/csp/gateway/am/api/orgs/{orgId}/consents
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-required-roles: org_owner
x-slo-tier: TIER2


[{"label":"Latest (v1.0)","version":"latest"}]
csp
Feedback

Was this page helpful?