Complete traditional login

Completes traditional login using an email address and a password.

Authentication

No authentication is required to call this operation.

Base URL

The base URL for this operation is your Identity Cloud Capture domain; for example:

https://educationcenter.us- dev.janraincapture.com

Your Capture domain (also known as the Registration domain) can be found in Console on the Manage Application page.

Examples

Example: Complete Traditional Authentication

This command carries out a traditional login (i.e., a login employing a username and password) for the user johndoe@example.com.

curl -X POST \
  --data-urlencode 'client_id=12345abcde12345abcde12345abcde12'\
  --data-urlencode 'flow=standard'\
  --data-urlencode 'flow_version=20190618143040022299'\
  --data-urlencode 'locale=en-US'\
  --data-urlencode 'redirect_uri=http://localhost'\
  --data-urlencode 'response_type=token'\
  --data-urlencode 'form=signInForm'\
  --data-urlencode 'signInEmailAddress=johndoe@example.com'\
  --data-urlencode 'currentPassword=password123'\
  https://my-app.janraincapture.com/oauth/auth_native_traditional

Parameters

All parameters need to be configured as x-www-form-urlencoded body parameters.

Responses

200 OK

Successful Response

A successful response returns the user profile in the capture_user object along with an access_token or authorization_code depending on the response_type parameter you included in the call.

{
  "capture_user": {
    "created": "2016-04-20 17:02:18.649505 +0000",
    "uuid": "67890def-6789-defg-6789-67890defgh67",
    // additional profile data...
  },
  "stat": "ok",
  "access_token": "z0y98xv76u5t4rs3"
}

Error - Invalid Credentials

The example error response below indicates that traditional authentication failed. The same error message is returned if the email address is not registered or if the email address is registered but the password entered is incorrect.

{
  "stat": "error",
  "code": 210,
  "error_description": "some inputs are invalid",
  "error": "invalid_credentials",
  "request_id": "5442cd9rdkcayy3p",
  "invalid_fields": {
    "signInForm": [
      "Incorrect username or password. Please try again."
    ]
  }
}

Error - Invalid Form

The example error response below indicates that the form value is not valid for the flow included in the call. Form names are case-sensitive, so signinform fails if signInForm is the valid form name.

{
  "stat": "error",
  "code": 200,
  "error_description": "no such form 'signinform'",
  "error": "invalid_argument",
  "request_id": "rdfbsavfvzb2sxud"
}

Error - Missing Required Parameters

The example error response below indicates that one of the required parameters for the call wan't included. The error message describes which parameter is missing.

{
  "stat": "error",
  "code": 100,
  "error_description": "missing arguments: flow",
  "error": "missing_argument",
  "request_id": "uyeem84bmqmnjuu4"
}

Error - Invalid Flow Value

The example error response below indicates that the value provided for one or more of the flow, flow_version, or locale parameters is invalid. Flow versions are unique across environments, so check that the version value included in the call is for the correct environment (that is, your development or production application).

{
  "stat": "error",
  "code": 500,
  "error_description": "could not find a flow named 'standard' with version '12345abc-1234-abcd-1234-12345abcde12' and locale 'en-US'",
  "error": "unexpected_error",
  "request_id": "murynd7fhpysq6um"
}

Error - Invalid API Client Permissions

The example error response below indicates that the API client used to make the call is not configured with the login_client feature.

{
  "stat": "error",
  "code": 403,
  "error_description": "This client does not support log in and registration.",
  "error": "permission_error",
  "request_id": "y3sthb9dey6mv65e"
}