API Service Integrations

This API provides operations to manage API Service Integration instances in your organization. See API service integrations in the OIN.

List all API Service Integration instances
Early Access
OAuth 2.0: okta.oauthIntegrations.read

Lists all API Service Integration instances with a pagination option

Request
query Parameters
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 Link response header. See Pagination for more information.

Responses
200

OK

401

Unauthorized

403

Forbidden

429

Too Many Requests

get/integrations/api/v1/api-services
Request samples
Response samples
application/json
[]

Create an API Service Integration instance
Early Access

Creates and authorizes an API Service Integration instance

Request
Request Body schema: application/json
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, my_api_log_integration.

Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

429

Too Many Requests

post/integrations/api/v1/api-services
Request samples
application/json
{
  • "type": "my_app_cie",
  • "grantedScopes": [
    • "okta.logs.read",
    • "okta.groups.read",
    • "okta.users.read"
    ]
}
Response samples
application/json
{}

Retrieve an API Service Integration instance
Early Access
OAuth 2.0: okta.oauthIntegrations.read

Retrieves an API Service Integration instance by id

Request
path Parameters
apiServiceId
required
string

id of the API Service Integration instance

Example: 000lr2rLjZ6NsGn1P0g3
Responses
200

OK

401

Unauthorized

403

Forbidden

404

Not Found

429

Too Many Requests

get/integrations/api/v1/api-services/{apiServiceId}
Request samples
Response samples
application/json
{}

Delete an API Service Integration instance
Early Access
OAuth 2.0: 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.

Request
path Parameters
apiServiceId
required
string

id of the API Service Integration instance

Example: 000lr2rLjZ6NsGn1P0g3
Responses
204

No Content

401

Unauthorized

403

Forbidden

404

Not Found

429

Too Many Requests

delete/integrations/api/v1/api-services/{apiServiceId}
Request samples
Response samples
application/json
{
  • "errorCode": "E0000011",
  • "errorSummary": "Invalid token provided",
  • "errorLink": "E0000011",
  • "errorId": "sampleQPivGUj_ND5v78vbYWW",
  • "errorCauses": [ ]
}