This API provides operations to manage API service integration instances in your organization.
For a current list of available API service integrations, see the Okta Integration Network catalog.
See Add an API Service Integration for corresponding admin instructions using the Admin Console. If you want to build an API service integration, see API service integrations in the OIN.
Lists all API Service Integration instances with a pagination option
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
| type required | string The type of the API service integration. This string is an underscore-concatenated, lowercased API service integration name. For example, |
| 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. |
object (AppProperties) App instance properties | |
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"
]
}
},
}
}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"
]
}
},
}
}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": [ ]
}Lists all client secrets for an API Service Integration instance by apiServiceId
OK
Unauthorized
Forbidden
Not Found
Too Many Requests
[- {
- "id": "ocs2f4zrZbs8nUa7p0g4",
- "status": "INACTIVE",
- "client_secret": "***DhOW",
- "secret_hash": "yk4SVx4sUWVJVbHt6M-UPA",
- "created": "2023-02-21T20:08:24.000Z",
- "lastUpdated": "2023-02-21T20:08:24.000Z",
- "_links": {
- "activate": {
- "hints": {
- "allow": [
- "POST"
]
}
}, - "delete": {
- "hints": {
- "allow": [
- "DELETE"
]
}
}
}
}, - {
- "id": "ocs2f50kZB0cITmYU0g4",
- "status": "ACTIVE",
- "client_secret": "***MQGQ",
- "secret_hash": "0WOOvBSzV9clc4Nr7Rbaug",
- "created": "2023-04-06T21:32:33.000Z",
- "lastUpdated": "2023-04-06T21:32:33.000Z",
- "_links": {
- "deactivate": {
- "hints": {
- "allow": [
- "POST"
]
}
}
}
}
]Creates an API Service Integration instance Secret object with a new active client secret. You can create up to two Secret objects. An error is returned if you attempt to create more than two Secret objects.
Created
Bad Request
Unauthorized
Forbidden
Too Many Requests
{- "id": "ocs2f50kZB0cITmYU0g4",
- "status": "ACTIVE",
- "client_secret": "DRUFXGF9XbLnS9k-Sla3x3POBiIxDreBCdZuFs5B",
- "secret_hash": "FpCwXwSjTRQNtEI11I00-g",
- "created": "2023-04-06T21:32:33.000Z",
- "lastUpdated": "2023-04-06T21:32:33.000Z",
- "_links": {
- "deactivate": {
- "hints": {
- "allow": [
- "POST"
]
}
}
}
}Deletes an API Service Integration instance Secret by secretId. You can only delete an inactive Secret.
No Content
Unauthorized
Forbidden
Not Found
Too Many Requests
{- "errorCode": "E0000011",
- "errorSummary": "Invalid token provided",
- "errorLink": "E0000011",
- "errorId": "sampleQPivGUj_ND5v78vbYWW",
- "errorCauses": [ ]
}Activates an API Service Integration instance Secret by secretId
OK
Unauthorized
Forbidden
Not Found
Too Many Requests
{- "id": "ocs2f50kZB0cITmYU0g4",
- "status": "ACTIVE",
- "client_secret": "***MQGQ",
- "secret_hash": "0WOOvBSzV9clc4Nr7Rbaug",
- "created": "2023-04-06T21:32:33.000Z",
- "lastUpdated": "2023-04-06T21:32:33.000Z",
- "_links": {
- "deactivate": {
- "hints": {
- "allow": [
- "POST"
]
}
}
}
}Deactivates an API Service Integration instance Secret by secretId
OK
Unauthorized
Forbidden
Not Found
Too Many Requests
{- "id": "ocs2f4zrZbs8nUa7p0g4",
- "status": "INACTIVE",
- "client_secret": "***DhOW",
- "secret_hash": "yk4SVx4sUWVJVbHt6M-UPA",
- "created": "2023-02-21T20:08:24.000Z",
- "lastUpdated": "2023-02-21T20:08:24.000Z",
- "_links": {
- "activate": {
- "hints": {
- "allow": [
- "POST"
]
}
}, - "delete": {
- "hints": {
- "allow": [
- "DELETE"
]
}
}
}
}