instances

Creates, updates, deletes, gets or lists an instances resource.

Overview

Name	instances
Type	Resource
Id	okta.integrations.instances

Fields

The following fields are returned by SELECT queries:

get_api_service_integration_instance

Name	Datatype	Description
id	string	The ID of the API Service Integration instance (example: 0oa72lrepvp4WqEET1d9)
name	string	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)
_links	object	Specifies link relations (see Web Linking) available for the current status of an application using the JSON Hypertext Application Language specification. This object is used for dynamic discovery of related resources and lifecycle operations.
configGuideUrl	string	The URL to the API service integration configuration guide (example: https://{docDomain}/my-app-cie/configuration-guide)
createdAt	string	Timestamp when the API Service Integration instance was created (example: 2023-02-21T20:08:24.000Z)
createdBy	string	The user ID of the API Service Integration instance creator (example: 00uu3u0ujW1P6AfZC2d5)
grantedScopes	array	The list of Okta management scopes granted to the API Service Integration instance. See [Okta management OAuth 2.0 scopes]https://developer.okta.com/docs/api/oauth2/#okta-admin-management.
properties	object	App instance properties
type	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. (example: my_app_cie)

list_api_service_integration_instances

Name	Datatype	Description
id	string	The ID of the API Service Integration instance (example: 0oa72lrepvp4WqEET1d9)
name	string	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)
_links	object	Specifies link relations (see Web Linking) available for the current status of an application using the JSON Hypertext Application Language specification. This object is used for dynamic discovery of related resources and lifecycle operations.
configGuideUrl	string	The URL to the API service integration configuration guide (example: https://{docDomain}/my-app-cie/configuration-guide)
createdAt	string	Timestamp when the API Service Integration instance was created (example: 2023-02-21T20:08:24.000Z)
createdBy	string	The user ID of the API Service Integration instance creator (example: 00uu3u0ujW1P6AfZC2d5)
grantedScopes	array	The list of Okta management scopes granted to the API Service Integration instance. See [Okta management OAuth 2.0 scopes]https://developer.okta.com/docs/api/oauth2/#okta-admin-management.
properties	object	App instance properties
type	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. (example: my_app_cie)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_api_service_integration_instance	select	apiServiceId, subdomain		Retrieves an API Service Integration instance by id
list_api_service_integration_instances	select	subdomain	after	Lists all API Service Integration instances with a pagination option
create_api_service_integration_instance	insert	subdomain, type, grantedScopes		Creates and authorizes an API Service Integration instance
delete_api_service_integration_instance	delete	apiServiceId, subdomain		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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
apiServiceId	string	id of the API Service Integration instance (example: 000lr2rLjZ6NsGn1P0g3)
subdomain	string	(default: my-org)
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 and Link header.

SELECT examples

get_api_service_integration_instance

Retrieves an API Service Integration instance by id

SELECT
id,
name,
_links,
configGuideUrl,
createdAt,
createdBy,
grantedScopes,
properties,
type
FROM okta.integrations.instances
WHERE apiServiceId = '{{ apiServiceId }}' -- required
AND subdomain = '{{ subdomain }}' -- required
;

list_api_service_integration_instances

Lists all API Service Integration instances with a pagination option

SELECT
id,
name,
_links,
configGuideUrl,
createdAt,
createdBy,
grantedScopes,
properties,
type
FROM okta.integrations.instances
WHERE subdomain = '{{ subdomain }}' -- required
AND after = '{{ after }}'
;

INSERT examples

create_api_service_integration_instance

Creates and authorizes an API Service Integration instance

INSERT INTO okta.integrations.instances (
grantedScopes,
properties,
type,
subdomain
)
SELECT 
'{{ grantedScopes }}' /* required */,
'{{ properties }}',
'{{ type }}' /* required */,
'{{ subdomain }}'
RETURNING
id,
name,
_links,
clientSecret,
configGuideUrl,
createdAt,
createdBy,
grantedScopes,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: instances
props:
  - name: subdomain
    value: "{{ subdomain }}"
    description: Required parameter for the instances resource.
  - name: grantedScopes
    value:
      - "{{ grantedScopes }}"
    description: |
      The list of Okta management scopes granted to the API Service Integration instance. See [Okta management OAuth 2.0 scopes]https://developer.okta.com/docs/api/oauth2/#okta-admin-management.
  - name: properties
    value: "{{ properties }}"
    description: |
      App instance properties
  - name: type
    value: "{{ type }}"
    description: |
      The type of the API service integration. This string is an underscore-concatenated, lowercased API service integration name. For example, `my_api_log_integration`.

DELETE examples

delete_api_service_integration_instance

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.

DELETE FROM okta.integrations.instances
WHERE apiServiceId = '{{ apiServiceId }}' --required
AND subdomain = '{{ subdomain }}' --required
;