API Reference

Krystal Identity API

Resources & Endpoints

Create an OAuth scope for an OAuth client

Returns the details of the newly created OAuth scope.

POST
https://identity.krystal.io/api/v1/oauth_scopes

If successful, this endpoint will return a 201 Created 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

properties Required

OAuthScopeCreateProperties None

Potential Errors

The following errors may occur during this request.

Details HTTP status

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
    }
}