POST /api/v1/apps/{appId}/grants
Grants consent for the app to request an OAuth 2.0 Okta scope
Servers
- https://{yourOktaDomain}
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
appId |
String | Yes |
Application ID |
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 |
ID of the Grant object |
source |
String | No |
User type source that granted consent Possible values:
|
userId |
String | No |
User ID that granted consent (if |
_embedded |
Object | No |
Embedded resources related to the Grant |
_embedded.scope |
Object | No | |
_embedded.scope.id |
String | No |
The name of the Okta scope for which consent is granted |
created |
String | No |
Timestamp when the object was created |
issuer |
String | Yes |
The issuer of your org authorization server. This is typically your Okta domain. |
scopeId |
String | Yes |
The name of the Okta scope for which consent is granted |
status |
String | No |
Status Possible values:
|
clientId |
String | No |
Client ID of the app integration |
createdBy |
Object | No |
User that created the object |
createdBy.id |
String | No |
User ID |
createdBy.type |
String | No |
Type of user |
lastUpdated |
String | No |
Timestamp when the object was last updated |
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.