Skip to content

Create an API service integration instance

Request

OAuth 2.0 scope:
  • okta.oauthIntegrations.manage

Creates and authorizes an API Service Integration instance

Bodyapplication/jsonrequired
grantedScopesArray of stringsrequired

The list of Okta management scopes granted to the API Service Integration instance. See Okta management OAuth 2.0 scopes.

Example:
[ "okta.logs.read" ]
propertiesobject(AppProperties)

App instance properties

typestringrequired

The type of the API service integration. This string is an underscore-concatenated, lowercased API service integration name. For example, my_api_log_integration.

Example:"my_app_cie"
curl -i -X POST \
  https://subdomain.okta.com/integrations/api/v1/api-services \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "my_app_cie",
    "grantedScopes": [
      "okta.logs.read",
      "okta.groups.read",
      "okta.users.read"
    ]
  }'

Responses

Created

Bodyapplication/json
configGuideUrlstringread-only

The URL to the API service integration configuration guide

Example:"https://{docDomain}/my-app-cie/configuration-guide"
createdAtstringread-only

Timestamp when the API Service Integration instance was created

Example:"2023-02-21T20:08:24.000Z"
createdBystringread-only

The user ID of the API Service Integration instance creator

Example:"00uu3u0ujW1P6AfZC2d5"
grantedScopesArray of strings

The list of Okta management scopes granted to the API Service Integration instance. See Okta management OAuth 2.0 scopes.

Example:
[ "okta.logs.read" ]
idstringread-only

The ID of the API Service Integration instance

Example:"0oa72lrepvp4WqEET1d9"
namestringread-only

The name of the API service integration that corresponds with the type property. This is the full name of the API service integration listed in the Okta Integration Network (OIN) catalog.

Example:"My App Cloud Identity Engine"
propertiesobject(AppProperties)

App instance properties

typestring

The type of the API service integration. This string is an underscore-concatenated, lowercased API service integration name. For example, my_api_log_integration.

Example:"my_app_cie"
clientSecretstringread-only

The client secret for the API Service Integration instance. This property is only returned in a POST response.

Response
{ "id": "0oa72lrepvp4WqEET1d9", "type": "my_app_cie", "name": "My App Cloud Identity Engine", "createdAt": "2023-02-21T20:08:24.000Z", "createdBy": "00uu3u0ujW1P6AfZC2d5", "clientSecret": "CkF69kXtag0q0P4pXU8OnP5IAzgGlwx6eqGy7Fmg", "configGuideUrl": "https://{docDomain}/my-app-cie/configuration-guide", "grantedScopes": [ "okta.logs.read", "okta.groups.read", "okta.users.read" ], "_links": { "self": { … }, "client": { … }, "logo": { … } } }