Read User by ID
GET {{apiPath}}/environments/{{envID}}/users/{{userID}}?expand=population
To get data for a single user resource, the GET /environments/{{envID}}/users/{{userID}} operation returns data only for the user resource with the ID specified in the request URL.
You must have the Identity Data Admin role to read group membership. For more information about groups, see Groups.
Important: If the user authenticates with an authoritative identity provider (the identity provider has a registration.population.id value set), their password state will not be returned with a self-service request.
| Parameter | Description |
|---|---|
expand=population | Returns information about the user's population assignment. |
include=memberOfGroupNames | Includes all groups to which the user belongs, by group name. |
include=memberOfGroupIDs | Includes all groups to which the user belongs, by group ID. |
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
expand | string | Returns information about the user's population assignment. | |
include | string | Includes all groups to which the user belongs. See documentation for usage. |
RESPONSES
status: OK
{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/2f9c3699-217e-4acb-9e80-9649311b3eb5"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"population":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/populations/706ff5fd-c2bc-4c2d-9037-bfa39112a651"},"devices":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/2f9c3699-217e-4acb-9e80-9649311b3eb5/devices"},"roleAssignments":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/2f9c3699-217e-4acb-9e80-9649311b3eb5/roleAssignments"},"password":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/2f9c3699-217e-4acb-9e80-9649311b3eb5/password"},"password.reset":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/2f9c3699-217e-4acb-9e80-9649311b3eb5/password"},"password.set":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/2f9c3699-217e-4acb-9e80-9649311b3eb5/password"},"password.check":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/2f9c3699-217e-4acb-9e80-9649311b3eb5/password"},"password.recover":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/2f9c3699-217e-4acb-9e80-9649311b3eb5/password"},"linkedAccounts":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/2f9c3699-217e-4acb-9e80-9649311b3eb5/linkedAccounts"},"account.sendVerificationCode":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/2f9c3699-217e-4acb-9e80-9649311b3eb5"}},"_embedded":{"population":{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/populations/706ff5fd-c2bc-4c2d-9037-bfa39112a651"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"id":"706ff5fd-c2bc-4c2d-9037-bfa39112a651"}},"id":"2f9c3699-217e-4acb-9e80-9649311b3eb5","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"population":{"id":"706ff5fd-c2bc-4c2d-9037-bfa39112a651"},"createdAt":"2020-03-11T18:50:09.074Z","enabled":true,"lifecycle":{"status":"ACCOUNT_OK"},"mfaEnabled":false,"updatedAt":"2020-03-11T18:50:09.074Z","username":"jamesjoyce"}