Qodex.ai

Read All MFA User Devices

GET {{apiPath}}/environments/{{envID}}/users/{{userID}}/devices

The GET /environments/{{envID}}/users/{{userID}}/devices operation returns a list of all device resources associated with the specified user.

If a device is inactive, the status property is set to ACTIVATION_REQUIRED and the _links property includes the activate link. The response shows data for an inactive device.

Note: If devices are ordered, GET /environments/{{envID}}/users/{{userID}}/devices returns the devices in their current order, with the default device listed first. If devices are not ordered, the device list returned by GET /environments/{{envID}}/users/{{userID}}/devices does not reflect any order. For more information, see Setting device order.

The results from this operation can be filtered and expanded. For more information, see Filtering result data and Expanding result data.

The following query parameters are allowed in the request:

ParameterDescription
expandUse expand=order to expand the response to contain an array of activated device IDs listed according to device order. If devices have no order, an empty array is returned.

Request Params

KeyDatatypeRequiredDescription
expandstringExpands the response to contain an array of activated device IDs listed according to device order. If devices have no order, an empty array is returned.

RESPONSES

status: OK

{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8376797d-641c-4e7b-8bc1-2fdf71916cab/devices"},"devices.reorder":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8376797d-641c-4e7b-8bc1-2fdf71916cab/devices"}},"_embedded":{"devices":[{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8376797d-641c-4e7b-8bc1-2fdf71916cab/devices/eaae1190-b42f-427c-bf92-d5fa5fd9c288"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"user":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8376797d-641c-4e7b-8bc1-2fdf71916cab"}},"id":"eaae1190-b42f-427c-bf92-d5fa5fd9c288","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"user":{"id":"8376797d-641c-4e7b-8bc1-2fdf71916cab"},"type":"SMS","nickname":"My phone","status":"ACTIVE","createdAt":"2020-10-30T19:42:02.562Z","updatedAt":"2020-12-16T22:04:31.284Z","phone":"15127881501"},{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8376797d-641c-4e7b-8bc1-2fdf71916cab/devices/b45713b4-1fbf-45b4-9fbf-54c32d63f0d6"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"user":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8376797d-641c-4e7b-8bc1-2fdf71916cab"}},"id":"b45713b4-1fbf-45b4-9fbf-54c32d63f0d6","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"user":{"id":"8376797d-641c-4e7b-8bc1-2fdf71916cab"},"type":"EMAIL","status":"ACTIVE","createdAt":"2020-10-30T19:39:25.180Z","updatedAt":"2020-10-30T19:39:25.180Z","email":"johnbudz@pingidentity.com"},{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8376797d-641c-4e7b-8bc1-2fdf71916cab/devices/09859da1-aed0-4be0-af1d-5583471b5d9c"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"user":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8376797d-641c-4e7b-8bc1-2fdf71916cab"},"device.activate":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8376797d-641c-4e7b-8bc1-2fdf71916cab/devices/09859da1-aed0-4be0-af1d-5583471b5d9c"}},"id":"09859da1-aed0-4be0-af1d-5583471b5d9c","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"user":{"id":"8376797d-641c-4e7b-8bc1-2fdf71916cab"},"type":"SECURITY_KEY","status":"ACTIVATION_REQUIRED","createdAt":"2020-10-29T19:30:08.768Z","updatedAt":"2020-10-29T19:30:08.768Z","rp":{"id":"pingone.com"}},{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8376797d-641c-4e7b-8bc1-2fdf71916cab/devices/3aee5588-db8f-4664-a637-97fbff757b81"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"user":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8376797d-641c-4e7b-8bc1-2fdf71916cab"},"device.activate":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8376797d-641c-4e7b-8bc1-2fdf71916cab/devices/3aee5588-db8f-4664-a637-97fbff757b81"}},"id":"3aee5588-db8f-4664-a637-97fbff757b81","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"user":{"id":"8376797d-641c-4e7b-8bc1-2fdf71916cab"},"type":"PLATFORM","status":"ACTIVATION_REQUIRED","createdAt":"2020-10-29T19:16:38.559Z","updatedAt":"2020-10-29T19:16:38.559Z","rp":{"id":"pingone.com"},"platform":"BIOMETRICS"},{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8376797d-641c-4e7b-8bc1-2fdf71916cab/devices/ef1a087f-45b8-4003-9bdd-a19d5b7723fa"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"user":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8376797d-641c-4e7b-8bc1-2fdf71916cab"},"device.activate":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8376797d-641c-4e7b-8bc1-2fdf71916cab/devices/ef1a087f-45b8-4003-9bdd-a19d5b7723fa"}},"id":"ef1a087f-45b8-4003-9bdd-a19d5b7723fa","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"user":{"id":"8376797d-641c-4e7b-8bc1-2fdf71916cab"},"type":"PLATFORM","status":"ACTIVATION_REQUIRED","createdAt":"2020-10-29T19:07:25.907Z","updatedAt":"2020-10-29T19:07:25.907Z","rp":{"id":"pingone.com"},"platform":"BIOMETRICS"}]},"count":5,"size":5}