Scope
objectThe ID of the scope
The name of the scope
>= 1 characters
Description of the scope
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
Specifies whether to include the scope in the metadata document
Default:false
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
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
ScopeList
objectShow Child Parameters
returns the pagination information
Show Child Parameters
ClientName
stringThe name of the client
>= 1 characters
Client
objectThe OAuth 2.0 client ID
Match pattern:[-_\w]+
>= 1 characters<= 36 characters
Example:kYa9iQFU5xPDSIUH9z1z
The name of the client
>= 1 characters
OAuth 2.0 grant type
Allowed values:implicitclient_credentials
The URIs that the client is allowed to redirect to after authentication in interactive flows. All redirect URIs must be absolute URIs, be secure (HTTPS), and must not include a fragment component.
The URI of the login page where the user is redirected to authenticate in interactive flows. The login page must be secure (HTTPS).
The duration of the minted token is valid for, in seconds
Default:300
>= 60<= 2592000
The duration of the minted token is valid for, in seconds
Default:300
>= 60<= 2592000
Specifies whether the client is allowed to request all scopes
Default:false
Specifies the scopes IDs that the client is allowed to request
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}
OAuth 2.0 response type
Allowed values:nonetokencodeid_token
Requested authentication method for OAuth 2.0 endpoints.
Allowed values:client_secret_postnone
Default:client_secret_post
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
CreatedClient
The OAuth 2.0 client ID
Match pattern:[-_\w]+
>= 1 characters<= 36 characters
Example:kYa9iQFU5xPDSIUH9z1z
The name of the client
>= 1 characters
OAuth 2.0 grant type
Allowed values:implicitclient_credentials
The URIs that the client is allowed to redirect to after authentication in interactive flows. All redirect URIs must be absolute URIs, be secure (HTTPS), and must not include a fragment component.
The URI of the login page where the user is redirected to authenticate in interactive flows. The login page must be secure (HTTPS).
The duration of the minted token is valid for, in seconds
Default:300
>= 60<= 2592000
The duration of the minted token is valid for, in seconds
Default:300
>= 60<= 2592000
Specifies whether the client is allowed to request all scopes
Default:false
Specifies the scopes IDs that the client is allowed to request
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}
OAuth 2.0 response type
Allowed values:nonetokencodeid_token
Requested authentication method for OAuth 2.0 endpoints.
Allowed values:client_secret_postnone
Default:client_secret_post
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
The OAuth 2.0 client secret
Example:YAzsyUlNZ5gNGeKS9H3VAdxVPzhPo4ae