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

Approve Consent

Description

Approve or reject the consent.

Access Policy

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

Request

Request

URL

URL


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

Path Parameters

Path Parameters

string
orgId Required

Unique identifier (GUID) of the organization.

Parameter Serialization Style: simple Explode:false

string
consentId Required

The unique identifier of the CONSENT.

Parameter Serialization Style: simple Explode:false

Query Parameters

Query Parameters

string
action Required

Action taken by Customer on consent request. It can have only two values APPROVE|REJECT.

Parameter Serialization Style: form Explode:true

Request Body

Request Body

ConsentApproval of mimetype application/json Required
{
    "expiry": "2004-07-25T06:18:20.541Z"
}
string as date-time
expiry Optional

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

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns ConsentDto of type application/json

Valid consent approval contract.

{
	"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.


409

The request could not be processed due to a conflict


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 -X POST -H "Content-Type: application/json" -d '{"expiry":"2004-07-25T06:18:20.541Z"}' https://{api_host}/csp/gateway/am/api/orgs/{orgId}/consents/{consentId}?action=string
Vendor Extensions

Vendor Extensions

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


Feedback

Was this page helpful?