API ReferenceManagementAccess Keys
POST
/v1/mgmt/accesskey/update

Update an existing access key, using a valid management key.

This API endpoint allows administrators to update an existing access key. With this endpoint, you can only update the access key's name.

See also

Endpoint Authentication

Use authorization bearer header with the following format:

Authorization: Bearer \<ProjectId:ManagementKey\>

Try it

/v1/mgmt/accesskey/update

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

< Project ID >:< Management Key > as bearer

In: header

Request Body

idstring

namestring

descriptionstring

Status codeDescription
200OK
curl -X POST "https://api.descope.com/v1/mgmt/accesskey/update" \
  -d '{
  "id": "string",
  "name": "string",
  "description": "string"
}'

{
  "key": {
    "id": "string",
    "name": "string",
    "roleNames": [
      "string"
    ],
    "keyTenants": [
      {
        "tenantId": "string",
        "roleNames": [
          "string"
        ],
        "tenantName": "string"
      }
    ],
    "status": "string",
    "createdTime": 0,
    "expireTime": 0,
    "createdBy": "string",
    "clientId": "string",
    "boundUserId": "string",
    "customClaims": {},
    "editable": true,
    "description": "string",
    "permittedIps": [
      "string"
    ]
  }
}

Was this helpful?

Previous

Create Access Key

Next

Activate Access Key