Auth Server Scopes

Scopes define the extent of access that an access token grants to a Client. The management API will give you the ability to create, configure and manage multiple Scopes per Auth Server, and restrict their usage by Client.

List all auth server scopes

List all the scopes for a given auth server.

get

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

sortstring

The asc suffix is optional as the default sort order is ascending.
The desc suffix is used to specify a descending order.
Multiple sort attributes may be provided via a comma separated list.
JSONPath notation may be used to specify a sub-attribute (eg: ‘foo.bar desc’).

Example:created_at desc

filterobject

Filter scopes returned in the response.

Show Child Parameters

Path Parameters

authServerIdstring(uuid)required

The auth server ID

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Response

application/json

List of scopes

ScopeList

dataarray[object]required
Show Child Parameters
metaobjectrequired

returns the pagination information

Show Child Parameters
get/auth-servers/{authServerId}/scopes
 
application/json

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

Path Parameters

authServerIdstring(uuid)required

The auth server ID

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Body

application/json

Scope to be created

namestringrequired

The name of the scope

>= 1 characters

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.

Default:false

include_in_metadataboolean

Specifies whether to include the scope in the metadata document

Default:false

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.

Default:true

Response

application/json

A scope

Scope

idstring(uuid)required

The ID of the scope

namestringrequired

The name of the scope

>= 1 characters

descriptionstringrequired

Description of the scope

defaultbooleanrequired

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.

Default:false

include_in_metadatabooleanrequired

Specifies whether to include the scope in the metadata document

Default:false

enabledbooleanrequired

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.

Default:true

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

post/auth-servers/{authServerId}/scopes

Body

{ "name": "Scope", "description": "Scope Description", "default": false, "include_in_metadata": false, "enabled": true }
 
application/json

Get an auth server scope

Get a scope for given auth server.

get

Path Parameters

authServerIdstring(uuid)required

The auth server ID

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

scopeIdstring(uuid)required

The scope ID

Example:c5e12516-182c-4928-ae04-05374b3b1cca

Response

application/json

A scope

Scope

idstring(uuid)required

The ID of the scope

namestringrequired

The name of the scope

>= 1 characters

descriptionstringrequired

Description of the scope

defaultbooleanrequired

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.

Default:false

include_in_metadatabooleanrequired

Specifies whether to include the scope in the metadata document

Default:false

enabledbooleanrequired

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.

Default:true

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

get/auth-servers/{authServerId}/scopes/{scopeId}
 
application/json

Update an auth server scope

Update a scope for a given auth server.

patch

Path Parameters

authServerIdstring(uuid)required

The auth server ID

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

scopeIdstring(uuid)required

The scope ID

Example:c5e12516-182c-4928-ae04-05374b3b1cca

Body

application/json

Scope to be update

namestring

The name of the scope

>= 1 characters

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

application/json

A scope

Scope

idstring(uuid)required

The ID of the scope

namestringrequired

The name of the scope

>= 1 characters

descriptionstringrequired

Description of the scope

defaultbooleanrequired

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.

Default:false

include_in_metadatabooleanrequired

Specifies whether to include the scope in the metadata document

Default:false

enabledbooleanrequired

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.

Default:true

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

patch/auth-servers/{authServerId}/scopes/{scopeId}

Body

{ "name": "Updated Scope", "description": "Updated Scope Description", "default": true, "include_in_metadata": true, "enabled": false }
 
application/json