POST /Requests/GrantAccess

Creates a grant access request.

post

Authorizations

API Key

X-API-KEYstringRequired

Public API key used to identify the client application. It should be included in all requests.

Header parameters

X-API-SECRETstringRequired

API Secret is used to verify the integrity of the request and authenticate the client. It should be included in all requests. This value must be kept confidential and should never be exposed in client-side code or public repositories.

Example: YOUR_API_SECRET

Body

application/jsontext/jsonapplication/*+json

Request to create a new grant access request.

createdByUserIdstring · uuidRequired

User that appears as creator of the request.

targetUserIdstring · uuidRequired

Identifier of the user who will receive access.

workAppIdstring · uuidRequired

Identifier of the work app for which access is being requested.

grantAccessPurposestring · min: 1 · max: 1024Required

Purpose or reason for the grant access request.

permissionLevelIdstring · uuid · nullableOptional

Optional identifier of the permission level to request. It is mandatory if the work app has at least one permission level.

Responses

201

Created

text/plainapplication/jsontext/json

Result of a successful request creation.

requestIdstring · min: 1Required

Unique identifier of the created request.

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

409

Conflict

text/plainapplication/jsontext/json

500

Internal Server Error

post/api/v1/Requests/GrantAccess

HTTPcURLJavaScriptPython

POST /api/v1/Requests/GrantAccess HTTP/1.1
Host: open-api.getcakewalk.io
X-API-KEY: YOUR_API_KEY
X-API-SECRET: YOUR_API_SECRET
Content-Type: application/json
Accept: */*
Content-Length: 250

{
  "createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
  "targetUserId": "123e4567-e89b-12d3-a456-426614174000",
  "workAppId": "123e4567-e89b-12d3-a456-426614174000",
  "grantAccessPurpose": "text",
  "permissionLevelId": "123e4567-e89b-12d3-a456-426614174000"
}

application/jsontext/jsonapplication/*+json

{
  "requestId": "text"
}