> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blinkops.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Users

Get a list of all users in the vault.

**Required Permissions for using this action**:

* `Audit users`

<Note>
  External Documentation

  To learn more, visit the [CyberArk documentation](https://docs.cyberark.com/pam-self-hosted/latest/en/content/sdk/get-users-api.htm).
</Note>

## Basic Parameters

<div className="integrations-table">
  | Parameter        | Description                                                                                                                                           |
  | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
  | Component User   | Filter users by type. Select `true` to include only component users, `false` to include only non-component users, or leave empty to return all users. |
  | Extended Details | Select to include additional detailed information in the response.                                                                                    |
  | Search           | Search users by username, first name, or last name.                                                                                                   |
  | Sort             | The property by which to sort the retrieved results.                                                                                                  |
</div>

## Advanced Parameters

<div className="integrations-table">
  | Parameter | Description                                                                                                                                                                                              |
  | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | Limit     | The maximum number of items to retrieve per request.<br /><br />**Note**: This parameter can only be used with **CyberArk - Privilege Cloud connection** and **cannot be used without an offset value**. |
  | Offset    | The index of the first result to retrieve.<br /><br />**Note**: This parameter can only be used with **CyberArk - Privilege Cloud connection** and **cannot be used without a limit value**.             |
</div>

## Example Output

```json theme={"dark"}
{
	"Users": [
		{
			"id": 2,
			"username": "Administrator",
			"source": "CyberArk",
			"userType": "Built-InAdmins",
			"componentUser": false,
			"groupsMembership": [
				{
					"groupID": 16,
					"groupName": "PVWAMonitor",
					"groupType": "Vault"
				},
				{
					"groupID": 17,
					"groupName": "PVWAUsers",
					"groupType": "Vault"
				},
				{
					"groupID": 11,
					"groupName": "Vault Admins",
					"groupType": "Vault"
				}
			],
			"vaultAuthorization": [
				"AddUpdateUsers",
				"AddSafes",
				"AddNetworkAreas",
				"ManageDirectoryMapping",
				"ManageServerFileCategories",
				"AuditUsers",
				"BackupAllSafes",
				"RestoreAllSafes",
				"ResetUsersPasswords",
				"ActivateUsers"
			],
			"allowedAuthenticationMethods": [
				"SAML",
				"PKI"
			],
			"location": "\\",
			"personalDetails": {
				"firstName": "Jen",
				"middleName": "R",
				"lastName": "Grey"
			}
		}
	],
	"Total": 1
}
```

## Workflow Library Example

[List Users with Cyberark and Send Results Via Email](https://library.blinkops.com/workflows/list-users-with-cyberark-and-send-results-via-email)

<div className="iframe-wrapper">
  <div className="iframe-media">
    <img src="https://mintcdn.com/blinkops-2/ojHYuDeYX5FWuN8a/img/Icons/play-box.svg?fit=max&auto=format&n=ojHYuDeYX5FWuN8a&q=85&s=b8af968e71438a9499c3223c9bd29fb2" alt="Workflow Library" width="16" height="16" data-path="img/Icons/play-box.svg" />

    Preview this Workflow on desktop
  </div>

  <iframe className="iframe" src="https://library.blinkops.com/workflows/list-users-with-cyberark-and-send-results-via-email/canvas" />
</div>