okta_accounts

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

Overview

Name	okta_accounts
Type	Resource
Id	datadog.integrations.okta_accounts

Fields

The following fields are returned by SELECT queries:

get_okta_account

Name	Datatype	Description
id	string	The ID of the Okta account, a UUID hash of the account name. (example: f749daaf-682e-4208-a38d-c9b43162c609)
attributes	object	Attributes object for an Okta account.
type	string	Account type for an Okta account. (okta-accounts) (default: okta-accounts, example: okta-accounts)

list_okta_accounts

Name	Datatype	Description
id	string	The ID of the Okta account, a UUID hash of the account name. (example: f749daaf-682e-4208-a38d-c9b43162c609)
attributes	object	Attributes object for an Okta account.
type	string	Account type for an Okta account. (okta-accounts) (default: okta-accounts, example: okta-accounts)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_okta_account	select	account_id		Get an Okta account.
list_okta_accounts	select			List Okta accounts.
create_okta_account	insert	data		Create an Okta account.
update_okta_account	update	account_id, data		Update an Okta account.
delete_okta_account	delete	account_id		Delete an Okta account.

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
account_id	string	None
site	string	The Datadog site (region) for your organization, for example datadoghq.com, us3.datadoghq.com, us5.datadoghq.com, ap1.datadoghq.com, ap2.datadoghq.com, datadoghq.eu, ddog-gov.com. Resolved from the DD_SITE environment variable when set. Optional: defaults to datadoghq.com, or the value of the DD_SITE environment variable when set; a WHERE value overrides both.

SELECT examples

get_okta_account

Get an Okta account.

SELECT
id,
attributes,
type
FROM datadog.integrations.okta_accounts
WHERE account_id = '{{ account_id }}' -- required
;

list_okta_accounts

List Okta accounts.

SELECT
id,
attributes,
type
FROM datadog.integrations.okta_accounts
;

INSERT examples

create_okta_account

Create an Okta account.

INSERT INTO datadog.integrations.okta_accounts (
data
)
SELECT 
'{{ data }}' /* required */
RETURNING
data
;

Manifest

# Description fields are for documentation purposes
- name: okta_accounts
props:
  - name: data
    description: |
      Schema for an Okta account.
    value:
      attributes:
        api_key: "{{ api_key }}"
        auth_method: "{{ auth_method }}"
        client_id: "{{ client_id }}"
        client_secret: "{{ client_secret }}"
        domain: "{{ domain }}"
        name: "{{ name }}"
      id: "{{ id }}"
      type: "{{ type }}"

UPDATE examples

update_okta_account

Update an Okta account.

UPDATE datadog.integrations.okta_accounts
SET 
data = '{{ data }}'
WHERE 
account_id = '{{ account_id }}' --required
AND data = '{{ data }}' --required
RETURNING
data;

DELETE examples

delete_okta_account

Delete an Okta account.

DELETE FROM datadog.integrations.okta_accounts
WHERE account_id = '{{ account_id }}' --required
;