Authenticate with Email Address or Mobile Number and Password

Digital Identity Management provides user authentication with an email address or mobile number and password. A user navigates to the organization’s login page to login, and once authenticated, they can access and start using the services associated with their account.

User Authentication Flow

Preconditions

The User ID exists in Digital Identity Management.
The user has a password.

Following is a typical user authentication example for this flow:

The user visits the organization’s login page.
The user enters a previously verified AuthN ID such as their mobile number or email.
If the password is expired, the user is prompted to update their credentials (optional).
The user is logged in after Digital Identity Management’s successful identity verification.

Authenticate User with Password

[product: dim]

Authenticate user with email or mobile and password authentication flow

[/product: dim]

Response Parameters

Depending on where the user is on their journey, the Onboard and Authenticate Process records events and returns these properties as required:

Name	Trigger	CustomPayload	Admin UI	Description
PROCESS_START	Process initiation	`relayingPartyId` (if available)	`uiFlowType: LOGIN`	User selected to authenticate into the service.
`uiFlowType: COMBINED`	User selected to either onboard or authenticate into the service.
PROCESS_END	Process ends normally	`userId` (if created) `identifier`	`uiFlowType: LOGIN` Result: signed in with password	Successfully authenticated with {identifier}.
`uiFlowType: LOGIN` Result: not signed in, OTP sent to end user.	Verification code was sent to {identifier}. User must provide code to sign in.
`uiFlowType: COMBINED` Result: signed in (no OTP)	Successfully authenticated with {identifier}.
`uiFlowType: COMBINED` Result: Neither flow has signed in or onboarded, OTP sent to user	Verification code was sent to {identifier}and the user must provide this code to complete their onboarding or sign-in attempt.
PROCESS_TIMEOUT	After the process times out	`userId` (if created) identifier
GET_PROD_INFO_SUCCESS	After the process successfully retrieves product information from PLM	`productId` `produceName`		Retrieved product information for for {productName} ({productId}).
VALIDATE_ACCOUNT_SUCCESS	After the process successfully validates account.	`identifier`		Successfully validated account for {identifier}.
PROCESS_SEND_VERIFICATION	After request for verification is sent to destination.	`identifier`		Request for verification sent to {identifier}.
USER_AUTHENTICATED	After the user is successfully authenticated.			User successfully authenticated.
GET_SUBSCRIPTIONS_SUCCESS	After the user has successfully retrieved the subscription information.			Successfully get subscriptions for account {accountId}.

Example

Request Process Start

`POST{url}/process/start?authentication.OnboardAndAuthenticate.v2.0?productId=Product_One`
Response Process Start

HttpStatus 200 { "processId": "b33d8abc-d777-4848-800e-6b8dab25954d", "processName": "authentication.OnboardAndAuthenticate.v2.0", "stepName": "IdentifierPrompt", "stepName": "EndStep", "lastStep": true, "runtimeId": 6723, "userId": 4865, "userAuthenticated": true, "output": { "purchasePromptFlag": true, "productDetailsDTO": { "productId": "Product_One", "productName": "Subscription One", "productDescription": "Sample Description Subscription One", "productPrice": "100", "productCurrency": "USD", "productTrialPeriod": "P30D", "productBillingCycle": "P1M", "appleDownloadLink": "https://apps.apple.com/us/app/example%A3%B3n/id444456788", "androidDownloadLink": "https://play.google.com/store/apps/details?id=com.example", "subscriptionName": "Streaming Subscription", "shortServiceName": "Sub stream", "serviceDescription": "example of service description, includes online straming services and access", "appTagLine": "Streaming Selection", "appName": "Stream Package", "subscriptionNameSms": "Streaming Subscription", "eligibilityWindow": 30, "eligibilityThreshold": 2, "checkEligibility": false } } }
Request Step

`PUT {url}/process/step { "processId": "b33d8abc-d777-4848-800e-6b8dab25954d", "parameters": { "identifier": "24355342" } }`
Response Step

`HttpStatus 202 { "processId": "b33d8abc-d777-4848-800e-6b8dab25954d", "processName": "authentication.OnboardAndAuthenticate.v2.0", "stepName": "PasswordPrompt", "parameters": { "password": "String" } }`
Request Step

`PUT {url}/process/step { "processId": "b33d8abc-d777-4848-800e-6b8dab25954d", "parameters": { "password": "12345" } }`
Response Step

HttpStatus 200 { "processId": "b33d8abc-d777-4848-800e-6b8dab25954d ", "processName": "authentication.OnboardAndAuthenticate.v2.0", "stepName": "IdentifierPrompt", "stepName": "EndStep", "lastStep": true, "runtimeId": 6723, "userId": 4865, "userAuthenticated": true, "output": { "purchasePromptFlag": true, "productDetailsDTO": { "productId": "Product_One", "productName": "Subscription One", "productDescription": "Sample Description Subscription One", "productPrice": "100", "productCurrency": "USD", "productTrialPeriod": "P30D", "productBillingCycle": "P1M", "appleDownloadLink": "https://apps.apple.com/us/app/example%A3%B3n/id444456788", "androidDownloadLink": "https://play.google.com/store/apps/details?id=com.example", "subscriptionName": "Streaming Subscription", "shortServiceName": "Sub stream", "serviceDescription": "example of service description, includes online straming services and access", "appTagLine": "Streaming Selection", "appName": "Stream Package", "subscriptionNameSms": "Streaming Subscription", "eligibilityWindow": 30, "eligibilityThreshold": 2, "checkEligibility": false } } }
Parent topic:Onboard and Authenticate Process

Home

Guides

APIs

User Authentication Flow

Authenticate User with Password

Response Parameters

Example

​User Authentication Flow

​Authenticate User with Password

​Response Parameters

​Example

User Authentication Flow

Authenticate User with Password

Response Parameters

Example