---
title: "List all users in a domain"
method: GET
path: "/gdc/account/domains/{domainId}/users"
tags: ["webapp-users"]
---

# List all users in a domain

`GET /gdc/account/domains/{domainId}/users`

## Request

- Base URL: `https://secure.gooddata.com`
- URL: `https://secure.gooddata.com/gdc/account/domains/{domainId}/users`
- Auth: none declared

Only a domain admin can list users for the domain.<br />If using query parameters, do not set `limit` and `offset` to 0 at the same time.

This resource is an alias of `/gdc/domains/{domainId}/users`.

## Path parameters

- `domainId` string, required

## Query parameters

- `login` string, email
- `offset` integer
- `count` integer
- `limit` integer

## Response `200`

list of users returned

- AccountSettings
  - `accountSettings` object, required: Pageable list of account settings
    - `items` AccountSetting[], required
      - `accountSetting` AccountSettingTypeResponse, required
        - `login` string, email, nullable: The user login. This property is assigned when a user is created. This property is read-only and cannot be updated. The login does not have to be an actual working email address but must follow the email format.
        - `email` string, email, nullable: The user's contact email. The email can (but does not have to) be the same as the login. Only a domain admin can update this property.
        - `firstName` string, required: The user's first name.
        - `lastName` string, required: The user's last name.
        - `companyName` string, nullable: The name of the company where the user works.
        - `position` string, nullable: The user’s job position in the company.
        - `created` string: Date and time string in the format `YYYY-MM-DD hh:mm:ss`
        - `updated` string: Date and time string in the format `YYYY-MM-DD hh:mm:ss`
        - `timezone` integer, nullable: This parameter is deprecated and not used.
        - `timezoneName` string, nullable: The timezone where the user belongs to. The timezone must be in the format specified in the [IANA Time Zone Database](https://www.iana.org/time-zones). If set, the user’s timezone overrides the [timezone set for the project](https://help.gooddata.com/pages/viewpage.action?pageId=86796802).
        - `country` string, nullable: The country where the user is located.
        - `phoneNumber` string, nullable: The user's phone number.
        - `old_password` string: The user's current password; used only when updating the user's password.
        - `password` string, nullable: The user's current password (when creating a user) or the user's new password (when updating the user's password).
        - `verifyPassword` string, nullable: The user's current password (when creating a user) or the user's new password (when updating the user's password) entered for verification.
        - `authenticationModes` string[]: Is authentication mode (`SSO`, `PASSWORD`, or both) allowed for the user. The value of this field overrides the global settings for the domain. Only a domain admin can update this property.
        - `ssoProvider` string, nullable: The identifier of the user's authentication provider. It can contain a single value or a comma-separated list of values (for example, `"ssoProvider"&#58; "sso_provider_1, sso_provider_2"`). Only a domain admin can update this property.
        - `language` string: The language used in the embedded dashboards that the user can view. If not set, defaults to English (`en-US`). Other available languages are Dutch (`nl-NL`), Spanish (`es-ES`), Portuguese/Brazil (`pt-BR`), Portuguese/Portugal (`pt-PT`), French (`fr-FR`), German (`de-DE`), Japanese (`ja-JP`), and Simplified Chinese (`zh-Hans`). **NOTE:** You can also apply the set language to the other parts of the GoodData Portal&#58; Dashboards, Reports, KPI dashboards, Analytical Designer, Manage, and user menu. To do so, contact GoodData Support.
        - `ipWhitelist` string[], nullable: An array of the IP address ranges (in the CIDR format), from which the user is allowed to access the GoodData platform. This property is a user-specific setting, and it overrides the domain IP whitelist settings, if any has been set. Only a domain admin can update this property. <ul><li>When set to <code>null</code>, the user has access to the GoodData platform regardless of their IP address.</li> <li>When set to an empty array (<code>[]</code>), the user has no access to the GoodData platform.</li> <li>When not set, the property defaults to <code>null</code>.</li></ul>
        - `links` LinksResponse
          - `projects` string, uri: Link to projects where the user is assigned to
          - `self` string, uri: Link to this account settings
          - `domain` string, uri: Link to domain where the user belongs to
          - `auditEvents` string, uri: Link to audit events of the user
        - `effectiveIpWhitelist` string[], nullable: An array of the IP address ranges (in the CIDR format), from which the user is allowed to access the platform. This property is read-only and cannot be updated. The content of this property is taken either from `ipWhitelist` of the user (if set) or from the IP address ranges defined for the domain (if set). <ul><li>If neither is set, <code>effectiveIpWhitelist</code> returns <code>null</code>, which means there are no IP address limitations set for this user.</li> <li>If both are set, <code>effectiveIpWhitelist</code> returns what is set in <code>ipWhitelist</code> for the user.</li></ul>
    - `paging` PagingWithOffset, required: Paging structure containing offset and count for items on the current page and the link to the next page
      - `offset` integer, required: Offset of the current page
      - `count` integer, required: Count of items in the current page
      - `next` string, uri, nullable: Uri to next page, when such page exists.

## Other responses

- `400`: The API call failed due to invalid parameters. Check the response for details.
- `403`: The API call failed because you are not a domain admin. Log in as a domain admin, and then re-issue the call.
- `default`: Common error

---

[API](https://skmtc.dev/gooddata/apis/gooddata-api-documentation.md) - [All operations](https://skmtc.dev/gooddata/apis/gooddata-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/gooddata/apis/gooddata-api-documentation/revisions/e5dc0ee6ab00?raw)