API Reference

Krystal Identity API

Resources & Endpoints

Update OAuth scope details

Returns the details for the updated OAuth scope.

PATCH
https://identity.krystal.io/api/v1/oauth_scopes/{oauth_scope}

If successful, this endpoint will return a 200 OK status.

Scopes

One of the following scopes are required to use this endpoint.

Arguments

The following arguments are supported for this endpoint.

Name Type Default Value

oauth_scope Required

OAuth Scope Lookup None

properties Required

OAuthScopeUpdateProperties None

Potential Errors

The following errors may occur during this request.

Details HTTP status

oauth_scope_not_found

No scope was found matching any of the criteria provided in the arguments

 404 Not Found

validation_error

An error ocurred with the input provided

 422 Unprocessable Entity

Returned Object

When the request is successful, you can expect an object matching the specification below to be returned.

{
    oauth_scope: OAuthScope {
        name: String
        title: String
        description: String?
        read_only: Boolean
        restricted: Boolean
        sensitive: Boolean
        type: OAuthScopeTypeEnum
    }
}