instance_secrets

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

Overview

Name	instance_secrets
Type	Resource
Id	okta.integrations.instance_secrets

Fields

The following fields are returned by SELECT queries:

list_api_service_integration_instance_secrets

Name	Datatype	Description
id	string	The ID of the API Service Integration instance Secret (example: ocs2f4zrZbs8nUa7p0g4)
_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.
client_secret	string	The OAuth 2.0 client secret string. The client secret string is returned in the response of a Secret creation request. In other responses (such as list, activate, or deactivate requests), the client secret is returned as an undisclosed hashed value. (example: DRUFXGF9XbLnS9k-Sla3x3POBiIxDreBCdZuFs5B)
created	string	Timestamp when the API Service Integration instance Secret was created (example: 2023-02-21T20:08:24.000Z)
lastUpdated	string	Timestamp when the API Service Integration instance Secret was updated (example: 2023-02-21T20:08:24.000Z)
secret_hash	string	OAuth 2.0 client secret string hash (example: yk4SVx4sUWVJVbHt6M-UPA)
status	string	Status of the API Service Integration instance Secret (ACTIVE, INACTIVE) (example: ACTIVE)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_api_service_integration_instance_secrets	select	apiServiceId, subdomain		Lists all client secrets for an API Service Integration instance by apiServiceId
create_api_service_integration_instance_secret	insert	apiServiceId, subdomain		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.
delete_api_service_integration_instance_secret	delete	apiServiceId, secretId, subdomain		Deletes an API Service Integration instance Secret by secretId. You can only delete an inactive Secret.
activate_api_service_integration_instance_secret	exec	apiServiceId, secretId, subdomain		Activates an API Service Integration instance Secret by secretId
deactivate_api_service_integration_instance_secret	exec	apiServiceId, secretId, subdomain		Deactivates an API Service Integration instance Secret by secretId

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)
secretId	string	id of the API Service Integration instance Secret (example: ocs2f4zrZbs8nUa7p0g4)
subdomain	string	(default: my-org)

SELECT examples

list_api_service_integration_instance_secrets

Lists all client secrets for an API Service Integration instance by apiServiceId

SELECT
id,
_links,
client_secret,
created,
lastUpdated,
secret_hash,
status
FROM okta.integrations.instance_secrets
WHERE apiServiceId = '{{ apiServiceId }}' -- required
AND subdomain = '{{ subdomain }}' -- required
;

INSERT examples

create_api_service_integration_instance_secret

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.

INSERT INTO okta.integrations.instance_secrets (
apiServiceId,
subdomain
)
SELECT 
'{{ apiServiceId }}',
'{{ subdomain }}'
RETURNING
id,
_links,
client_secret,
created,
lastUpdated,
secret_hash,
status
;

Manifest

# Description fields are for documentation purposes
- name: instance_secrets
props:
  - name: apiServiceId
    value: "{{ apiServiceId }}"
    description: Required parameter for the instance_secrets resource.
  - name: subdomain
    value: "{{ subdomain }}"
    description: Required parameter for the instance_secrets resource.

DELETE examples

delete_api_service_integration_instance_secret

Deletes an API Service Integration instance Secret by secretId. You can only delete an inactive Secret.

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

Lifecycle Methods

activate_api_service_integration_instance_secret

Activates an API Service Integration instance Secret by secretId

EXEC okta.integrations.instance_secrets.activate_api_service_integration_instance_secret 
@apiServiceId='{{ apiServiceId }}' --required, 
@secretId='{{ secretId }}' --required, 
@subdomain='{{ subdomain }}' --required
;

deactivate_api_service_integration_instance_secret

Deactivates an API Service Integration instance Secret by secretId

EXEC okta.integrations.instance_secrets.deactivate_api_service_integration_instance_secret 
@apiServiceId='{{ apiServiceId }}' --required, 
@secretId='{{ secretId }}' --required, 
@subdomain='{{ subdomain }}' --required
;