saml_configurations

Creates, updates, deletes, gets or lists a saml_configurations resource.

Overview

Name	saml_configurations
Type	Resource
Id	datadog.organization.saml_configurations

Fields

The following fields are returned by SELECT queries:

get_samlconfiguration

Name	Datatype	Description
id	string	The UUID of the SAML configuration. (example: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d)
attributes	object	Attributes of a SAML configuration.
relationships	object	Relationships of a SAML configuration.
type	string	SAML configurations resource type. (saml_configurations) (default: saml_configurations, example: saml_configurations)

list_samlconfigurations

Name	Datatype	Description
id	string	The UUID of the SAML configuration. (example: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d)
attributes	object	Attributes of a SAML configuration.
relationships	object	Relationships of a SAML configuration.
type	string	SAML configurations resource type. (saml_configurations) (default: saml_configurations, example: saml_configurations)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_samlconfiguration	select	saml_config_uuid		Get a single SAML configuration for the current organization by its UUID.
list_samlconfigurations	select			Get the list of SAML configurations for the current organization. An organization has at most one SAML configuration.
update_samlconfiguration	update	saml_config_uuid, data		Update a single SAML configuration for the current organization.<br /><br />Use this endpoint to enable or disable identity-provider-initiated login, set the<br />just-in-time provisioning domains, and set the default role assigned to<br />just-in-time provisioned users. A default role is required to enable just-in-time provisioning.

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
saml_config_uuid	string	The UUID of the SAML configuration.
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_samlconfiguration

Get a single SAML configuration for the current organization by its UUID.

SELECT
id,
attributes,
relationships,
type
FROM datadog.organization.saml_configurations
WHERE saml_config_uuid = '{{ saml_config_uuid }}' -- required
;

list_samlconfigurations

Get the list of SAML configurations for the current organization. An organization has at most one SAML configuration.

SELECT
id,
attributes,
relationships,
type
FROM datadog.organization.saml_configurations
;

UPDATE examples

update_samlconfiguration

Update a single SAML configuration for the current organization.<br /><br />Use this endpoint to enable or disable identity-provider-initiated login, set the<br />just-in-time provisioning domains, and set the default role assigned to<br />just-in-time provisioned users. A default role is required to enable just-in-time provisioning.

UPDATE datadog.organization.saml_configurations
SET 
data = '{{ data }}'
WHERE 
saml_config_uuid = '{{ saml_config_uuid }}' --required
AND data = '{{ data }}' --required
RETURNING
data,
included;