--- title: List users with an identity provider override description: Get all users in the organization whose login method has been overridden to use the specified identity provider. breadcrumbs: Docs > API > List users with an identity provider override --- > For the complete documentation index, see [llms.txt](https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/llms.txt). # List users with an identity provider override ## v2 (latest) | Datadog site | API endpoint | | ----------------- | -------------------------------------------------------------------------- | | app.datadoghq.com | GET https://api.datadoghq.com/api/v2/identity_providers/{idp_id}/users | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/identity_providers/{idp_id}/users | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/identity_providers/{idp_id}/users | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/identity_providers/{idp_id}/users | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/identity_providers/{idp_id}/users | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/identity_providers/{idp_id}/users | | uk1.datadoghq.com | GET https://api.uk1.datadoghq.com/api/v2/identity_providers/{idp_id}/users | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/identity_providers/{idp_id}/users | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v2/identity_providers/{idp_id}/users | ### Overview Get all users in the organization whose login method has been overridden to use the specified identity provider. This endpoint requires the `org_management` permission. OAuth apps require the `org_management` authorization [scope](https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/api/latest/scopes.md#identity-providers) to access this endpoint. ### Arguments #### Path Parameters | Field | Type | Description | | ------------------- | ------ | -------------------------------- | | idp_id [*required*] | string | The ID of the identity provider. | #### Query Strings | Field | Type | Description | | -------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------- | | page[size] | integer | Number of items to return per page. The maximum allowed value is 100. Default: `10`. | | page[number] | integer | Specific page number to return. Default: `0`. | | sort | string | User attribute to order results by. Options include `email` and `name`. Default: `email`. | | sort_dir | enum | Direction of sort. Options: `asc`, `desc`. Allowed enum values: `asc`, `desc`. Default: `desc`. | | 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. | ### Response {% tabs %} {% tab label="200" %} OK {% tabs %} {% tab label="Model" %} Response containing information about multiple users. | Parent field | Field | Type | Description | | ------------------ | ------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | data | [object] | Array of returned users. | | data | attributes | object | Attributes of user object returned by the API. | | attributes | created_at | date-time | The ISO 8601 timestamp of when the user account was created. | | attributes | disabled | boolean | Whether the user account is deactivated. Disabled users cannot log in. | | attributes | email | string | The email address of the user, used for login and notifications. | | attributes | handle | string | The unique handle (username) of the user, typically matching their email prefix. | | attributes | icon | string | URL of the user's profile icon, typically a Gravatar URL derived from the email address. | | attributes | last_login_time | date-time | The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in. Read-only. | | attributes | mfa_enabled | boolean | Whether multi-factor authentication (MFA) is enabled for the user's account. Read-only. | | attributes | modified_at | date-time | The ISO 8601 timestamp of when the user account was last modified. | | attributes | name | string | The full display name of the user as shown in the Datadog UI. | | attributes | service_account | boolean | Whether this is a service account rather than a human user. Service accounts are used for programmatic API access. | | attributes | status | string | The current status of the user account (for example, `Active`, `Pending`, or `Disabled`). | | attributes | title | string | The job title of the user (for example, "Senior Engineer" or "Product Manager"). | | attributes | uuid | string | The globally unique identifier (UUID) of the user. Read-only. | | attributes | verified | boolean | Whether the user's email address has been verified. | | data | id | string | ID of the user. | | data | relationships | object | Relationships of the user object returned by the API. | | relationships | org | object | Relationship to an organization. | | org | data [*required*] | object | Relationship to organization object. | | data | id [*required*] | string | ID of the organization. | | data | type [*required*] | enum | Organizations resource type. Allowed enum values: `orgs`. Default: `orgs`. | | relationships | other_orgs | object | Relationship to organizations. | | other_orgs | data [*required*] | [object] | Relationships to organization objects. | | data | id [*required*] | string | ID of the organization. | | data | type [*required*] | enum | Organizations resource type. Allowed enum values: `orgs`. Default: `orgs`. | | relationships | other_users | object | Relationship to users. | | other_users | data [*required*] | [object] | Relationships to user objects. | | data | id [*required*] | string | A unique identifier that represents the user. | | data | type [*required*] | enum | Users resource type. Allowed enum values: `users`. Default: `users`. | | relationships | roles | object | Relationship to roles. | | roles | data | [object] | An array containing type and the unique identifier of a role. | | data | id | string | The unique identifier of the role. | | data | type | enum | Roles type. Allowed enum values: `roles`. Default: `roles`. | | data | type | enum | Users resource type. Allowed enum values: `users`. Default: `users`. | | | included | [] | Array of objects related to the users. | | included | | object | Organization object. | | | attributes | object | Attributes of the organization. | | attributes | created_at | date-time | Creation time of the organization. | | attributes | description | string | Description of the organization. | | attributes | disabled | boolean | Whether or not the organization is disabled. | | attributes | modified_at | date-time | Time of last organization modification. | | attributes | name | string | Name of the organization. | | attributes | public_id | string | Public ID of the organization. | | attributes | sharing | string | Sharing type of the organization. | | attributes | url | string | URL of the site that this organization exists at. | | | id | string | ID of the organization. | | | type [*required*] | enum | Organizations resource type. Allowed enum values: `orgs`. Default: `orgs`. | | included | | object | Permission object. | | | attributes | object | Attributes of a permission. | | attributes | created | date-time | Creation time of the permission. | | attributes | description | string | Description of the permission. | | attributes | display_name | string | Displayed name for the permission. | | attributes | display_type | string | Display type. | | attributes | group_name | string | Name of the permission group. | | attributes | name | string | Name of the permission. | | attributes | name_aliases | [string] | List of alias names for the permission. | | attributes | restricted | boolean | Whether or not the permission is restricted. | | | id | string | ID of the permission. | | | type [*required*] | enum | Permissions resource type. Allowed enum values: `permissions`. Default: `permissions`. | | included | | object | Role object returned by the API. | | | attributes | object | Attributes of the role. | | attributes | created_at | date-time | Creation time of the role. Read-only. | | attributes | modified_at | date-time | Time of last role modification. Read-only. | | attributes | name | string | The name of the role. The name is neither unique nor a stable identifier of the role. | | attributes | receives_permissions_from | [string] | The managed role from which this role automatically inherits new permissions. Specify one of the following: "Datadog Admin Role", "Datadog Standard Role", or "Datadog Read Only Role". If empty or not specified, the role does not automatically inherit permissions from any managed role. | | attributes | user_count | int64 | Number of users with that role. Read-only. | | | id | string | The unique identifier of the role. | | | relationships | object | Relationships of the role object returned by the API. | | relationships | permissions | object | Relationship to multiple permissions objects. | | permissions | data | [object] | Relationships to permission objects. | | data | id | string | ID of the permission. | | data | type | enum | Permissions resource type. Allowed enum values: `permissions`. Default: `permissions`. | | | type [*required*] | enum | Roles type. Allowed enum values: `roles`. Default: `roles`. | | | meta | object | Object describing meta attributes of response. | | meta | page | object | Pagination object. | | page | total_count | int64 | Total count. | | page | total_filtered_count | int64 | Total count of elements matched by the filter. | {% /tab %} {% tab label="Example" %} ```json { "data": [ { "attributes": { "created_at": "2019-09-19T10:00:00.000Z", "disabled": false, "email": "string", "handle": "string", "icon": "string", "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", "service_account": false, "status": "string", "title": "string", "uuid": "string", "verified": false }, "id": "string", "relationships": { "org": { "data": { "id": "00000000-0000-beef-0000-000000000000", "type": "orgs" } }, "other_orgs": { "data": [ { "id": "00000000-0000-beef-0000-000000000000", "type": "orgs" } ] }, "other_users": { "data": [ { "id": "00000000-0000-0000-2345-000000000000", "type": "users" } ] }, "roles": { "data": [ { "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", "type": "roles" } ] } }, "type": "users" } ], "included": [ { "attributes": { "created_at": "2019-09-19T10:00:00.000Z", "description": "string", "disabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", "public_id": "string", "sharing": "string", "url": "string" }, "id": "string", "type": "orgs" } ], "meta": { "page": { "total_count": "integer", "total_filtered_count": "integer" } } } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="400" %} Bad Request {% tabs %} {% tab label="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------- | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="403" %} Authentication error {% tabs %} {% tab label="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------- | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="404" %} Not found {% tabs %} {% tab label="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------- | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="429" %} Too many requests {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% /tabs %} ### Code Example {% tabs %} {% tab label="Curl" %} ```bash # Path parameters export idp_id="00000000-0000-0000-0000-000000000001" # Set your Datadog site and credentials export DD_SITE="datadoghq.com" # Or us3.datadoghq.com, us5.datadoghq.com, datadoghq.eu, ap1.datadoghq.com, ap2.datadoghq.com, uk1.datadoghq.com, ddog-gov.com, us2.ddog-gov.com # Use a Personal Access Token or Service Access Token export DD_BEARER_TOKEN="" curl -X GET "https://api.${DD_SITE}/api/v2/identity_providers/${idp_id}/users" \ -H "Accept: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" ``` {% /tab %} {% tab label="Go" %} ```go // List users with an identity provider override returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV2" ) func main() { ctx := datadog.NewDefaultContext(context.Background()) ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN")) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewIdentityProvidersApi(apiClient) resp, r, err := api.ListIdentityProviderUsers(ctx, "00000000-0000-0000-0000-000000000001", *datadogV2.NewListIdentityProviderUsersOptionalParameters()) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `IdentityProvidersApi.ListIdentityProviderUsers`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `IdentityProvidersApi.ListIdentityProviderUsers`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" go run "main.go" ``` {% /tab %} {% tab label="Java" %} ```java // List users with an identity provider override returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.IdentityProvidersApi; import com.datadog.api.client.v2.model.UsersResponse; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN")); IdentityProvidersApi apiInstance = new IdentityProvidersApi(defaultClient); try { UsersResponse result = apiInstance.listIdentityProviderUsers("00000000-0000-0000-0000-000000000001"); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling IdentityProvidersApi#listIdentityProviderUsers"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" java "Example.java" ``` {% /tab %} {% tab label="Python" %} ```python """ List users with an identity provider override returns "OK" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.identity_providers_api import IdentityProvidersApi configuration = Configuration() configuration.access_token = environ["DD_BEARER_TOKEN"] with ApiClient(configuration) as api_client: api_instance = IdentityProvidersApi(api_client) response = api_instance.list_identity_provider_users( idp_id="00000000-0000-0000-0000-000000000001", ) print(response) ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" python3 "example.py" ``` {% /tab %} {% tab label="Ruby" %} ```ruby # List users with an identity provider override returns "OK" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.access_token = ENV["DD_BEARER_TOKEN"] end api_instance = DatadogAPIClient::V2::IdentityProvidersAPI.new p api_instance.list_identity_provider_users("00000000-0000-0000-0000-000000000001") ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" rb "example.rb" ``` {% /tab %} {% tab label="Rust" %} ```rust // List users with an identity provider override returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_identity_providers::IdentityProvidersAPI; use datadog_api_client::datadogV2::api_identity_providers::ListIdentityProviderUsersOptionalParams; #[tokio::main] async fn main() { let configuration = datadog::Configuration::new(); let api = IdentityProvidersAPI::with_config(configuration); let resp = api .list_identity_provider_users( "00000000-0000-0000-0000-000000000001".to_string(), ListIdentityProviderUsersOptionalParams::default(), ) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: ```bash DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ``` {% /tab %} {% tab label="TypeScript" %} ```typescript /** * List users with an identity provider override returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration({ authMethods: { AuthZ: { accessToken: process.env.DD_BEARER_TOKEN as string, }, }, }); const apiInstance = new v2.IdentityProvidersApi(configuration); const params: v2.IdentityProvidersApiListIdentityProviderUsersRequest = { idpId: "00000000-0000-0000-0000-000000000001", }; apiInstance .listIdentityProviderUsers(params) .then((data: v2.UsersResponse) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" tsc "example.ts" ``` {% /tab %} {% /tabs %}