Skip to main content

Create a scope type

Enable custom scopes for your applications

Request Body
nrn string

NRN (at or below) where the runtime configuration applies

type enum

Possible values: [custom]

The scope type to be defined

name string

The name to be displayed to the developers to identify the type scope to be created

description string

Short description of how the scope type works or what it does

status enum

Possible values: [active, inactive]

Whether this scope type is enabled to be used

provider_type enum

Possible values: [service]

It tells the source entity that implements the scope type

provider_id string

The id of the entity that implements the scope type

Responses
200

The operation was successful

Schema OPTIONAL
id number OPTIONAL

The id of the scope type

nrn string OPTIONAL

NRN (at or below) where the runtime configuration applies

type enum OPTIONAL

Possible values: [custom]

The scope type to be defined

name string OPTIONAL

The name to be displayed to the developers to identify the type scope to be created

description string OPTIONAL

Short description of how the scope type works or what it does

status enum OPTIONAL

Possible values: [active, inactive]

Whether this scope type is enabled to be used

provider_type enum OPTIONAL

Possible values: [service]

It tells the source entity that implements the scope type

provider_id string OPTIONAL

The id of the entity that implements the scope type