POST /api/v1/authorizationServers/{authServerId}/scopes
Creates a custom token scope
Servers
- https://{yourOktaDomain}
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
authServerId |
String | Yes |
|
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | No |
Scope object ID |
_links |
Object | No |
Specifies link relations (see Web Linking) available using the JSON Hypertext Application Language specification. This object is used for dynamic discovery of related resources and lifecycle operations. |
name |
String | Yes |
Scope name |
description |
String | No |
Description of the Scope |
default |
Boolean | No |
Indicates if this Scope is a default scope Default value: false |
system |
Boolean | No |
Indicates if Okta created the Scope Default value: false |
consent |
String | No |
Indicates whether a consent dialog is needed for the Scope Possible values:
Default value: "IMPLICIT" |
displayName |
String | No |
Name of the end user displayed in a consent dialog |
metadataPublish |
String | No |
Indicates whether the Scope is included in the metadata Possible values:
Default value: "NO_CLIENTS" |
optional |
Boolean | No |
Indicates whether the Scope is optional. When set to Default value: false |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.