v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

Identity Providers

List users with an identity provider override

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

get/api/v2/identity_providers/{idp_id}/users

Path parameters

idp_idstring required

Example:00000000-0000-0000-0000-000000000001

The ID of the identity provider.

Query parameters

page[size]integer

Example:10

Size for a given page. The maximum allowed value is 100.

page[number]integer

Specific page number to return.

sortstring

Example:email

User attribute to order results by. Options include email and name.

sort_dir'asc' | 'desc'

Direction of sort.

Direction of sort. Options: asc, desc.

filterstring

Filter users by the given string. Defaults to no filtering.

filter[status]string

Example:Active

Filter on status attribute. Comma-separated list, with possible values Active, Pending, and Disabled. Defaults to no filtering.

Response

Example response

{
  "data": [
    {
      "relationships": {
        "org": {
          "data": {
            "id": "00000000-0000-beef-0000-000000000000",
            "type": "orgs"
          }
        },
        "other_orgs": {
          "data": []
        },
        "other_users": {
          "data": []
        },
        "roles": {
          "data": [
            {
              "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d",
              "type": "roles"
            }
          ]
        }
      },
      "type": "users"
    }
  ],
  "included": [
    {
      "type": "orgs"
    }
  ]
}