Complete traditional registration

Completes traditional registration. After registration is complete the user will be able to authenticate using a username and 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 a Registration domain) can be found in Console on the Manage Application page.

Examples

Example: Complete traditional registration

This command creates a user account for the user johndoe@example.com using traditional registration (that is, by employing a username and password).

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=registrationForm' \
  --data-urlencode 'emailAddress=johndoe@example.com' \
  --data-urlencode 'newPassword=password123' \
  --data-urlencode 'newPasswordConfirm=password123' \
  --data-urlencode 'lastName=Doe' \
  --data-urlencode 'firstName=John' \
  --data-urlencode 'displayName=JohnDoe' \
  --data-urlencode 'birthdate[dateselect_year]=1930' \
  --data-urlencode 'birthdate[dateselect_month]=11' \
  --data-urlencode 'birthdate[dateselect_day]=3' \
  https://my-app.janraincapture.com/oauth/register_native_traditional

Parameters

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

Responses

200 OK

Successful Response

A successful response return 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 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 registrationform fails if registrationForm is the valid form name.

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

Error - Field Validation Errors

The example error response below indicates that validation failed for some fields configured with the form used in the call. All validation rules for these fields are checked, so you may receive errors for multiple fields and multiple errors on a single field. Validation errors are commonly encountered when a required field is missing, the email address or another unique field is already taken, or the user input doesn't pass the formatting validation applied to a field. The invalid_fields object includes field names mapped to a list of localized error messages from the flow for each validation that failed.

{
  "stat": "error",
  "code": 390,
  "error_description": "some inputs are invalid",
  "error": "invalid_form_fields",
  "request_id": "eyt2p5thkwch5h2h",
  "invalid_fields": {
    "displayName": [
      "That display name is already taken."
    ],
    "emailAddress": [
      "Email address is required."
    ],
    "newPasswordConfirm": [
      "Passwords do not match."
    ]
  }
}

Error - Missing Required Parameters

The example error response below indicates that one of the required parameters for the call wasn'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 isn't 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"
}