Get domain users

Edit online

Purpose - Export the list of all users in an authentication domain.

URL - https://<frontdoor-url>/api//v2/users/search?domainName={name}

Note: Replace <frontdoor-url> with the Frontdoor URL for the region your Apptio product is hosted in.

Method - GET

Query parameters:

Parameter Description Required? Type Default
domainName Authentication domain to query users from (for example, acme). Yes String
hideInactive Boolean flag to toggle filtering of inactive users from the results. Optional Boolean false
start Index at which to get the next page of results. Optional String 0
pageSize Number of users to return. Optional String 100
sortBy A comma-separated list of sort parameters. Acceptable values are "login", "email", and "full_name". Denote descending sort with a "-" before the sort parameter. Optional String login

Required permissions:

  • A logged-in user must belong to the same authentication domain and have permissions to read users in the authentication domain.
  • A user can read users in an authentication domain if they have the manageUser or readUser permission in an environment shared with the user's authentication domain.
  • If the user is in an authentication domain that is different from the caller's authentication domain, then the caller must have manageDomainUsers or readDomainUsers permission in the environment of that authentication domain to read those users.

Sample request URL -

GET https://frontdoor.apptio.com/api/v2/users/search?domainName=acme&hideInactive=false&start=0&pageSize=100&sortBy=login

Return codes:

HTTP Status Code Reason
200 Requested users for domain
403 You don't have the required permissions to perform this operation
404 Requested domain not found