Skip to content
Dashboard
Theme
Theme

Define or redescribe an OAuth scope

PUT /v1/oauth/scopes/{scope}: Define or redescribe an OAuth scope.

View Markdown

PUT /v1/oauth/scopes/{scope}

Scope
oauth:write
Auth
Secret key (sk_…)
Since
1.0
  • scope string Required

  • OhAuthCat-Version string

    Minor version; defaults to the environment’s pin.

  • description string Required

    min length 1 · max length 300

Errors share one shape; see the error code catalogue.

curl -X PUT \
"https://api.ohauthcat.com/v1/oauth/scopes/organizations%3Aread" \
-H "Authorization: Bearer $OHAUTHCAT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"description": "Primary SSO connection for Acme Corp."
}'
Response 200
{
"object": "oauth_scope",
"name": "Acme Corp",
"description": "Primary SSO connection for Acme Corp.",
"created_at": "2026-01-15T09:30:00Z"
}