identity_provider_users

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

Overview

Name	identity_provider_users
Type	Resource
Id	datadog.organization.identity_provider_users

Fields

The following fields are returned by SELECT queries:

list_identity_provider_users

Name	Datatype	Description
id	string	ID of the user.
attributes	object	Attributes of user object returned by the API.
relationships	object	Relationships of the user object returned by the API.
type	string	Users resource type. (users) (default: users, example: users)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_identity_provider_users	select	idp_id	page[size], page[number], sort, sort_dir, filter, filter[status]	Get all users in the organization whose login method has been overridden<br />to use the specified identity provider.

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
idp_id	string	The ID of the identity provider.
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 users by the given string. Defaults to no filtering.
filter[status]	string	Filter on status attribute. Comma-separated list, with possible values Active, Pending, and Disabled. Defaults to no filtering.
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.
sort	string	User attribute to order results by. Options include email and name.
sort_dir	string	Direction of sort. Options: asc, desc.

SELECT examples

list_identity_provider_users

Get all users in the organization whose login method has been overridden<br />to use the specified identity provider.

SELECT
id,
attributes,
relationships,
type
FROM datadog.organization.identity_provider_users
WHERE idp_id = '{{ idp_id }}' -- required
AND page[size] = '{{ page[size] }}'
AND page[number] = '{{ page[number] }}'
AND sort = '{{ sort }}'
AND sort_dir = '{{ sort_dir }}'
AND filter = '{{ filter }}'
AND filter[status] = '{{ filter[status] }}'
;