Sign in

v28

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-263064641.4 MB
Auth Server Scopes

Create a new auth server scope

Create a new scope for a given auth server. The name attribute must be unique within the auth server.

post/v1/auth-servers/{authServerId}/scopes

Request body

namestring required

The name of the scope

descriptionstring

Description of the scope

defaultboolean

Specifies whether the scope is included by default in access tokens without being explicitly requested by the client. If the scope is not allowed by the client, it will not be included in the access token.

include_in_metadataboolean

Specifies whether to include the scope in the metadata document

enabledboolean

Specifies whether the scope is enabled. If the scope is not enabled, it cannot be requested by clients and will not be included in the access token.

Response

A scope

idstring uuid required

The ID of the scope

namestring required

The name of the scope

descriptionstring required

Description of the scope

defaultboolean required

Specifies whether the scope is included by default in access tokens without being explicitly requested by the client. If the scope is not allowed by the client, it will not be included in the access token.

include_in_metadataboolean required

Specifies whether to include the scope in the metadata document

enabledboolean required

Specifies whether the scope is enabled. If the scope is not enabled, it cannot be requested by clients and will not be included in the access token.

created_atstring date-time required

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time required

An ISO-8601 timestamp representation of entity update date.

Example response

{
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}