authn_mappings

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

Overview

Name	authn_mappings
Type	Resource
Id	datadog.organization.authn_mappings

Fields

The following fields are returned by SELECT queries:

get_auth_nmapping

Name	Datatype	Description
id	string	ID of the AuthN Mapping. (example: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d)
attributes	object	Attributes of AuthN Mapping.
relationships	object	All relationships associated with AuthN Mapping.
type	string	AuthN Mappings resource type. (authn_mappings) (default: authn_mappings, example: authn_mappings)

list_auth_nmappings

Name	Datatype	Description
id	string	ID of the AuthN Mapping. (example: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d)
attributes	object	Attributes of AuthN Mapping.
relationships	object	All relationships associated with AuthN Mapping.
type	string	AuthN Mappings resource type. (authn_mappings) (default: authn_mappings, example: authn_mappings)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_auth_nmapping	select	authn_mapping_id		Get an AuthN Mapping specified by the AuthN Mapping UUID.
list_auth_nmappings	select		page[size], page[number], sort, filter, resource_type	List all AuthN Mappings in the org.
create_auth_nmapping	insert	data		Create an AuthN Mapping.
update_auth_nmapping	update	authn_mapping_id, data		Edit an AuthN Mapping.
delete_auth_nmapping	delete	authn_mapping_id		Delete an AuthN Mapping specified by AuthN Mapping UUID.

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
authn_mapping_id	string	The UUID of the AuthN Mapping.
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.
filter	string	Filter all mappings by the given string.
page[number]	integer (int64)	Specific page number to return.
page[size]	integer (int64)	Number of items to return per page. The maximum allowed value is 100.
resource_type	string	Filter by mapping resource type. Defaults to "role" if not specified.
sort	string	Sort AuthN Mappings depending on the given field.

SELECT examples

get_auth_nmapping

Get an AuthN Mapping specified by the AuthN Mapping UUID.

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

list_auth_nmappings

List all AuthN Mappings in the org.

SELECT
id,
attributes,
relationships,
type
FROM datadog.organization.authn_mappings
WHERE page[size] = '{{ page[size] }}'
AND page[number] = '{{ page[number] }}'
AND sort = '{{ sort }}'
AND filter = '{{ filter }}'
AND resource_type = '{{ resource_type }}'
;

INSERT examples

create_auth_nmapping

Create an AuthN Mapping.

INSERT INTO datadog.organization.authn_mappings (
data
)
SELECT 
'{{ data }}' /* required */
RETURNING
data,
included
;

Manifest

# Description fields are for documentation purposes
- name: authn_mappings
props:
  - name: data
    description: |
      Data for creating an AuthN Mapping.
    value:
      attributes:
        attribute_key: "{{ attribute_key }}"
        attribute_value: "{{ attribute_value }}"
      relationships:
        role:
          data:
            id: "{{ id }}"
            type: "{{ type }}"
        team:
          data:
            id: "{{ id }}"
            type: "{{ type }}"
      type: "{{ type }}"

UPDATE examples

update_auth_nmapping

Edit an AuthN Mapping.

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

DELETE examples

delete_auth_nmapping

Delete an AuthN Mapping specified by AuthN Mapping UUID.

DELETE FROM datadog.organization.authn_mappings
WHERE authn_mapping_id = '{{ authn_mapping_id }}' --required
;