This API provides operations to manage API Service Integration instances in your organization. See API service integrations in the OIN.
okta.oauthIntegrations.read
Lists all API Service Integration instances with a pagination option
after | string The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the |
OK
Unauthorized
Forbidden
Too Many Requests
[- {
- "id": "0oa72lrepvp4WqEET1d9",
- "type": "my_app_cie",
- "name": "My App Cloud Identity Engine",
- "createdAt": "2023-02-21T20:08:24.000Z",
- "createdBy": "00uu3u0ujW1P6AfZC2d5",
- "grantedScopes": [
- "okta.logs.read",
- "okta.groups.read",
- "okta.users.read"
], - "_links": {
- "self": {
- "hints": {
- "allow": [
- "GET",
- "DELETE"
]
}
}, - "client": {
- "hints": {
- "allow": [
- "GET"
]
}
},
}
}
]
Creates and authorizes an API Service Integration instance
grantedScopes required | Array of strings The list of Okta management scopes granted to the API Service Integration instance. See Okta management OAuth 2.0 scopes. |
type required | string The type of the API service integration. This string is an underscore-concatenated, lowercased API service integration name. For example, |
Created
Bad Request
Unauthorized
Forbidden
Too Many Requests
{- "type": "my_app_cie",
- "grantedScopes": [
- "okta.logs.read",
- "okta.groups.read",
- "okta.users.read"
]
}
{- "id": "0oa72lrepvp4WqEET1d9",
- "type": "my_app_cie",
- "name": "My App Cloud Identity Engine",
- "createdAt": "2023-02-21T20:08:24.000Z",
- "createdBy": "00uu3u0ujW1P6AfZC2d5",
- "clientSecret": "CkF69kXtag0q0P4pXU8OnP5IAzgGlwx6eqGy7Fmg",
- "grantedScopes": [
- "okta.logs.read",
- "okta.groups.read",
- "okta.users.read"
], - "_links": {
- "self": {
- "hints": {
- "allow": [
- "GET",
- "DELETE"
]
}
}, - "client": {
- "hints": {
- "allow": [
- "GET"
]
}
},
}
}
okta.oauthIntegrations.read
Retrieves an API Service Integration instance by id
OK
Unauthorized
Forbidden
Not Found
Too Many Requests
{- "id": "0oa72lrepvp4WqEET1d9",
- "type": "my_app_cie",
- "name": "My App Cloud Identity Engine",
- "createdAt": "2023-02-21T20:08:24.000Z",
- "createdBy": "00uu3u0ujW1P6AfZC2d5",
- "grantedScopes": [
- "okta.logs.read",
- "okta.groups.read",
- "okta.users.read"
], - "_links": {
- "self": {
- "hints": {
- "allow": [
- "GET",
- "DELETE"
]
}
}, - "client": {
- "hints": {
- "allow": [
- "GET"
]
}
},
}
}
okta.oauthIntegrations.manage
Deletes an API Service Integration instance by id
. This operation also revokes access to scopes that were previously granted to this API Service Integration instance.
No Content
Unauthorized
Forbidden
Not Found
Too Many Requests
{- "errorCode": "E0000011",
- "errorSummary": "Invalid token provided",
- "errorLink": "E0000011",
- "errorId": "sampleQPivGUj_ND5v78vbYWW",
- "errorCauses": [ ]
}