Skip to content
Dashboard
Theme
Theme

Change a permission's name or description

PATCH /v1/authorization/permissions/{permission}: Change a permission's name or description.

View Markdown

PATCH /v1/authorization/permissions/{permission}

Scope
authorization:write
Auth
Secret key (sk_…)
Since
1.0
  • permission string Required

  • OhAuthCat-Version string

    Minor version; defaults to the environment’s pin.

  • name string or null

    max length 200

  • description string or null

    max length 1000

Errors share one shape; see the error code catalogue.

curl -X PATCH \
"https://api.ohauthcat.com/v1/authorization/permissions/perm_01J9Z3K5V7W8X9Y0Z1A2B3C4D5" \
-H "Authorization: Bearer $OHAUTHCAT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Acme Corp",
"description": "Primary SSO connection for Acme Corp."
}'
Response 200
{
"id": "perm_01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
"object": "permission",
"slug": "acme",
"name": "Acme Corp",
"description": "Primary SSO connection for Acme Corp.",
"created_at": "2026-01-15T09:30:00Z",
"updated_at": "2026-01-15T09:30:00Z"
}