# Get all users

Endpoint: GET /users
Version: 5.1.42
Security: api_key

## Query parameters:

  - `page_number` (integer)
    The page number for which to get users. This will default to the first page if excluded

  - `page_size` (integer)
    The maximum number of objects to return. This will default to the DefaultApiPageSize setting if not provided

## Response 200 fields (application/json):

  - `_pageInfo` (object)

  - `_pageInfo.numberOnPage` (integer)
    The number of items on this page. This should always match the page size unless it is the last page.

  - `_pageInfo.total` (integer)
    The total number of items

  - `responseList` (array)
    Example: [{"userName":"DelphixUser1","password":"Password_123","firstName":"First","lastName":"Last","email":"user@delphix.com","isAdmin":false,"showWelcome":true,"userStatus":"ACTIVE","nonAdminProperties":{"roleId":1,"environmentIds":[1,3,7]}}]

  - `responseList.userId` (integer)
    The ID of the User. This field will be generated by the Masking Engine.

  - `responseList.userName` (string, required)
    The name for this User. Note that it must be unique among Users.
    Example: "DelphixUser1"

  - `responseList.password` (string)
    The password for this User. NOTE: For updates, this field does not have to be set. If no password is provided on an update, then the current password will persist.
    Example: "Password_123"

  - `responseList.firstName` (string, required)
    The first name of this User. This does not need to match the user name.
    Example: "First"

  - `responseList.lastName` (string, required)
    The last name of this User. This does not need to match the user name.
    Example: "Last"

  - `responseList.email` (string, required)
    The email address for this User.
    Example: "user@delphix.com"

  - `responseList.isAdmin` (boolean, required)
    True for an administrative User, false for a non-administrative User.

  - `responseList.showWelcome` (boolean)
    Flag to enable and disable welcome page for user, default true for a newly created User.
    Example: true

  - `responseList.userStatus` (string, required)
    Status of user account.
    Enum: "ACTIVE", "LOCKED", "DISABLED"

  - `responseList.disableReason` (string)
    The reason why the user's account was locked.

  - `responseList.nonAdminProperties` (object)
    Example: {"roleId":1,"environmentIds":[1,3,7]}

  - `responseList.nonAdminProperties.roleId` (integer, required)
    The ID of the role assigned to this User.
    Example: 1

  - `responseList.nonAdminProperties.environmentIds` (array)
    The list of ID numbers that correspond to the environments that this User has access to.
    Example: [1,3,7]

  - `responseList.apiAccess` (boolean)
    For use with SSO only. Flag to enable and disable api access for users. When SSO is enabled, the value defaults to true for admins and false for non-admins. When SSO is disabled, the value defaults to true for all users. The value is only modifiable when SSO is enabled and only by admins. The value is immutable for admin users except with DCT enabled. When SSO is disabled, the value is ignored and the user will be granted API access.

  - `responseList.principal` (string)
    Identifies this user on external identity services. Used for OAuth2 API authentication when the principal is selected as the field to match users with access tokens.


## Response 400 fields

## Response 403 fields