Device Authentication (One-time Email)
POST {{authPath}}/{{envID}}/deviceAuthentications
For organizations that prefer to maintain their own user device information, you can call the {{apiPath}}/{{envID}}/deviceAuthentications endpoint and include the selectedDevice.oneTime object to provide the information required to contact the user for authentication. This example shows the use of the oneTime object for contacting the user by email.
| Property | Type | Required? |
|---|---|---|
user.id | String | Required |
selectedDevice.oneTime.type | String | Optional |
selectedDevice.oneTime.email | String | Optional |
See the Device authentications data model for full property descriptions.
Request Body
{"user"=>{"id"=>"{{userID}}"}, "selectedDevice"=>{"oneTime"=>{"type"=>"EMAIL", "email"=>"abc@ping.com"}}}
RESPONSES
status: Created
{"_links":{"self":{"href":"https://auth.pingone.eu/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/deviceAuthentications/0fa3daf8-499d-4d7a-8829-00d16ee84d5d"},"device.select":{"href":"https://auth.pingone.eu/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/deviceAuthentications/0fa3daf8-499d-4d7a-8829-00d16ee84d5d"},"otp.check":{"href":"https://auth.pingone.eu/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/deviceAuthentications/0fa3daf8-499d-4d7a-8829-00d16ee84d5d"}},"_embedded":{"devices":[{"type":"EMAIL","email":"ab****@ping.com"}]},"id":"0fa3daf8-499d-4d7a-8829-00d16ee84d5d","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"status":"OTP_REQUIRED","policy":{"id":"5a0a0950-8a81-4739-b12a-f4d6a11c7a82"},"selectedDevice":{"oneTime":{"type":"EMAIL","email":"ab****@ping.com"}},"user":{"id":"991776fd-145b-499e-8237-2c62aef35b2c"},"createdAt":"2022-06-16T14:13:36.601Z","updatedAt":"2022-06-16T14:13:36.649Z"}