Request consent

Request

Send a consent request to give the requesting user (the actor) permissions to act on behalf of another user (the subject) when needed. An email will be sent to the subject with a link to your consent page. The consent URI will include a query param named consent_id used to grant the consent, permissions array, and the subject's user ID as subject_id. Since this call must be initiated by a logged-in user, it's authorized using a user access token of the actor.

Security

UserAccessToken

Bodyapplication/jsonrequired

permissionsArray of stringsrequired

Names of permissions

consent_uristringrequired

URI of your consent page, which the browser will redirect to when the user clicks the link in the consent email. The URI must accept the following query parameters: consent_id used to grant the consent, permissions array of permissions to present the user to approve, subject_id and actor_id. This URI must also be configured as an allowed redirect URI in the Admin Portal.

Example:"https://www.example.com/consent"

subject_idstringrequired

ID of the user that grants permissions to another user to act on their behalf

consent_expirationnumber

Validity period of the consent in seconds. Once expired, new consent must be granted to obtain the permissions

curl -i -X POST \
  https://api.sbx.transmitsecurity.io/cis/v1/delegated-access/consents/me/request \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "permissions": [
      "string"
    ],
    "consent_uri": "https://www.example.com/consent",
    "subject_id": "string",
    "consent_expiration": 0
  }'

Responses

Consent request has been sent

Response

No content