reach_five_identity_repo 0.4.1

OpenAPI API client

reach_five_identity_repo (EXPERIMENTAL)

Introduction

Welcome to the documentation reference for the ReachFive REST Identity API!

This API is documented in OpenAPI standard, and rendered using ReDoc.

If something is missing, incorrect, or unclear, reach us at [e-mail].

Environment

Endpoints are available at https://{YOUR_DOMAIN}{ENDPOINT}.

Find how to obtain your ReachFive domain here.

First and third-party clients

Except if you want to implement OpenID as a Service (OaaS), always use first-party clients.

In the context of OaaS, third-party clients are used to make calls to:

• /oauth/authorize
• /oauth/token

They cannot be used with other endpoints.

If you to call any other endpoint with a third-party client, you will get this error:

{
  \"error_id\": \"9z8h7JmIHU\",
  \"error_description\": \"Not a first party identity client\",
  \"error_message_key\": \"error.client.notFirstParty\",
  \"error\": \"unauthorized_client\",
  \"error_user_msg\": \"Not a first party identity client\"
}

Errors

The API uses standard HTTP status codes to indicate the success or failure of the API call.

Code	Notes
2xx	Success codes; indicates the request worked as expected.
4xx	Error codes; indicates a client (user) error and more information is provided. See the example below.
5xx	Server error codes; indicates an error with one of ReachFive's servers.

The error body is JSON and contains the following fields:

{
    \"error_id\": \"2hNBbvYecw\",
    \"error_description\": \"Invalid email or password\",
    \"error_message_key\": \"error.invalidEmailOrPassword\",
    \"error\": \"invalid_grant\",
    \"error_user_msg\": \"Invalid email or password\"
}

• error_id is the auto-generated ID of the error.
• error_description is the default error description.
• error_message_key is the unique key that can be used to bind specific behaviors on other services. This also acts as the i18n translation key.
• error is the error type. See the Error Types table below for more details.
• error_user_msg is a user-friendly error message that should be used in the UI. This can be overriden in certain configurations.

Error Type
server_error
invalid_request
invalid_state
invalid_grant
invalid_scope
insufficient_scope
access_denied
origin_not_allowed
ip_address_not_allowed
missing_config
invalid_config
resource_not_found
temporarily_unavailable
unsupported_grant_type
unsupported_algorithm
invalid_client
unauthorized_client
login_required
email_already_exists
external_id_already_exists
phone_number_already_exists
lite_profile_invalid_identifiers
lite_profile_missing_profile
password_too_weak
rate_limit_reached
webhook_host_unreachable
webhook_invalid_response

Tip: For more information, see the individual endpoints.

Security Schemes