SCscalekit
Permissions

Update permission details

Modifies an existing permission's attributes including description and metadata. Use this endpoint to update permission descriptions or clarify permission purposes after creation. The permission is identified by its unique name in the path parameter, and only the fields you specify in the request body will be updated. Note that the permission name itself cannot be changed as it serves as the immutable identifier. This operation is useful for maintaining clear documentation of permission purposes or updating descriptions to reflect changes in system functionality. Returns the updated permission object with modified timestamps.

put/api/v1/permissions/{permission_name}

Request

Path parameters

permission_namestring required

Name of the permission

Request body

descriptionstring

Description of the permission

namestring

Unique name/ID of the permission. Must be 1–64 characters using only letters, numbers, underscores (_), and colons (:).

Example request

{
  "description": "Allows user to read documents from the system",
  "name": "read:documents"
}

Response

Permission updated successfully. Returns the modified permission object with updated description and timestamps.

Example response

{
  "permission": {
    "is_scalekit_permission": true
  }
}

Changes

No recorded changes to this operation across all 16 revisions of this API.