Sign On with a Username
POST {{authPath}}/{{envID}}/flows/{{flowID}}
The POST /{{envID}}/flows/{{flowID}} operation initiates an action to allow users to sign on with a username. The request body requires only the username attribute. The username value is verified in this action. This operation uses the application/vnd.pingidentity.user.lookup+json custom media type as the content type in the request header.
Prerequisites
See Flows for important overview information.
Send an authorize request to get a flow ID: Authorize. See also PingOne basic login authentication flow and Authentication workflow walkthrough.
Start the flow: Read Flow.
See also the
SIGN_ON_REQUIREDflow state in the Flow status values table.
Note: You must create a new sign-on policy with the appropriate sign-on policy actions to use this sign-on flow.
The status property value in the response indicates that the one-time password validation step used in a multi-factor authentication flow is a required action. The response includes the validateOTP link to initiate this required step.
| Property | Type | Required? |
|---|---|---|
username | String | Required |
Request Body
{"username"=>"xxxxx"}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
Cookie | string |
RESPONSES
status: OK
{"_links":{"otp.check":{"href":"https://auth.pingone.com/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/flows/037243b1-7ae9-4b6b-ad11-028250650f02"},"device.select":{"href":"https://auth.pingone.com/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/flows/037243b1-7ae9-4b6b-ad11-028250650f02"},"self":{"href":"https://auth.pingone.com/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/flows/037243b1-7ae9-4b6b-ad11-028250650f02"}},"id":"037243b1-7ae9-4b6b-ad11-028250650f02","resumeUrl":"https://auth.pingone.com/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/as/resume?flowId=037243b1-7ae9-4b6b-ad11-028250650f02","status":"OTP_REQUIRED","createdAt":"2021-07-13T19:00:08.426Z","expiresAt":"2021-07-13T19:15:21.241Z","_embedded":{"devices":[{"id":"203fe40d-1b4a-419b-947b-d59fe4d62405","type":"SMS","status":"ACTIVE","phone":"*******01"}],"application":{"name":"WebAppWithMFA_1626202732"}},"bypassAllowed":false,"selectedDevice":{"id":"203fe40d-1b4a-419b-947b-d59fe4d62405"}}