List Users

List and query all users.

External Documentation

To learn more, visit the PingOne documentation.

Basic Parameters

Parameter	Description
Cursor	Specifies the pagination cursor for the next page.
Filter	The filter to be applied on the results.
Limit	The amount of results per page. Valid range is 0 - 200.

Advanced Parameters

Parameter	Description
Expand	Expand certain fields and return additional information when available. For more information see the action’s external documentation.

Example Output

{
	"_links": {
		"self": {
			"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users?limit=100"
		}
	},
	"_embedded": {
		"users": [
			{
				"_links": {
					"self": {
						"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/27a68588-a2f4-4b67-a069-ce5c2caf8ecd"
					},
					"password": {
						"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/27a68588-a2f4-4b67-a069-ce5c2caf8ecd/password"
					},
					"password.set": {
						"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/27a68588-a2f4-4b67-a069-ce5c2caf8ecd/password"
					},
					"password.reset": {
						"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/27a68588-a2f4-4b67-a069-ce5c2caf8ecd/password"
					},
					"password.check": {
						"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/27a68588-a2f4-4b67-a069-ce5c2caf8ecd/password"
					},
					"password.recover": {
						"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/27a68588-a2f4-4b67-a069-ce5c2caf8ecd/password"
					},
					"account.sendVerificationCode": {
						"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/27a68588-a2f4-4b67-a069-ce5c2caf8ecd"
					},
					"linkedAccounts": {
						"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/27a68588-a2f4-4b67-a069-ce5c2caf8ecd/linkedAccounts"
					}
				},
				"_embedded": {
					"password": {
						"environment": {
							"id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
						},
						"user": {
							"id": "27a68588-a2f4-4b67-a069-ce5c2caf8ecd"
						},
						"passwordPolicy": {
							"id": "db388618-8c44-4d65-aa7e-0c8a1b96c993"
						},
						"status": "MUST_CHANGE_PASSWORD",
						"lastChangedAt": "2023-08-15T16:26:03.099Z"
					}
				},
				"id": "27a68588-a2f4-4b67-a069-ce5c2caf8ecd",
				"environment": {
					"id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
				},
				"account": {
					"canAuthenticate": true,
					"status": "OK"
				},
				"createdAt": "2023-08-15T16:26:02.104Z",
				"email": "[e-mail]",
				"enabled": true,
				"identityProvider": {
					"type": "PING_ONE"
				},
				"lifecycle": {
					"status": "ACCOUNT_OK"
				},
				"mfaEnabled": true,
				"name": {
					"given": "John",
					"family": "Smith"
				},
				"population": {
					"id": "f8fe355c-a901-4592-8a21-7003bcfada94"
				},
				"updatedAt": "2023-08-15T16:26:09.213Z",
				"username": "johnsmith",
				"verifyStatus": "NOT_INITIATED"
			},
			{
				"_links": {
					"self": {
						"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/75af2711-3361-4a3b-af10-7e399c5e08b1"
					},
					"password": {
						"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/75af2711-3361-4a3b-af10-7e399c5e08b1/password"
					},
					"password.set": {
						"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/75af2711-3361-4a3b-af10-7e399c5e08b1/password"
					},
					"password.reset": {
						"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/75af2711-3361-4a3b-af10-7e399c5e08b1/password"
					},
					"password.check": {
						"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/75af2711-3361-4a3b-af10-7e399c5e08b1/password"
					},
					"password.recover": {
						"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/75af2711-3361-4a3b-af10-7e399c5e08b1/password"
					},
					"account.sendVerificationCode": {
						"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/75af2711-3361-4a3b-af10-7e399c5e08b1"
					},
					"linkedAccounts": {
						"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/75af2711-3361-4a3b-af10-7e399c5e08b1/linkedAccounts"
					}
				},
				"_embedded": {
					"password": {
						"environment": {
							"id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
						},
						"user": {
							"id": "75af2711-3361-4a3b-af10-7e399c5e08b1"
						},
						"passwordPolicy": {
							"id": "db388618-8c44-4d65-aa7e-0c8a1b96c993"
						},
						"status": "OK",
						"lastChangedAt": "2023-09-19T16:48:44.015Z"
					}
				},
				"id": "75af2711-3361-4a3b-af10-7e399c5e08b1",
				"environment": {
					"id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
				},
				"account": {
					"canAuthenticate": true,
					"status": "OK"
				},
				"createdAt": "2023-09-19T16:47:43.112Z",
				"email": "[e-mail]",
				"enabled": true,
				"identityProvider": {
					"type": "PING_ONE"
				},
				"lastSignOn": {
					"at": "2023-09-19T16:54:18.246Z",
					"remoteIp": "65.152.119.108"
				},
				"lifecycle": {
					"status": "ACCOUNT_OK"
				},
				"mfaEnabled": false,
				"name": {
					"given": "User",
					"family": "Test"
				},
				"population": {
					"id": "f8fe355c-a901-4592-8a21-7003bcfada94"
				},
				"updatedAt": "2023-09-19T16:54:18.267Z",
				"username": "testuser",
				"verifyStatus": "NOT_INITIATED"
			}
		]
	},
	"count": 2,
	"size": 2
}

Workflow Library Example

List Users with Pingone and Send Results Via Email

Preview this Workflow on desktop