Introduction

Some applications need to look up or update users directly against the user store or the repository of user accounts and credentials.

If you have had this type of workflow approved, your application team would already have access to a special type of API client called a direct access client. These calls will not work with your login clients.

If you have not been approved for these workflows but would like to have a user lookup or update of this type, please reach out to your integration consultant to help you evaluate this as a new project: adding workflows will not be a part of our integration effort.

Supported Use Cases

The following use cases are supported for direct database calls:

• Direct database user lookup
• Direct database user update

Direct database user lookup

📘

API reference for /account/users/find endpoint

In addition to the integration documentation in this section, refer to the API Reference for the /account/users/find endpoint for more details.

Some applications must look up users directly against the user store or the repository of user accounts and credentials.

One common use case is to view and manage resourceAccess attributes for a user.

Another common use case is determining if a user scheduled for an invitation has already been added to the system.

If you have had this type of workflow approved, your application team would already have access to a special type of API client called a direct access client; these calls will not work with your login clients. If your application has not been approved for these workflows but would like to have a user lookup of this type, please reach out to your integration consultant.

Sample API Call

This is a sample API call using the /account/user/find endpoint with the GET method.

curl --location -g --request GET 'https://id.eu.nextreason.com/idp/v1/account/users/find?client_id=c8462jyq9dnupu2q4j7sfjzvn6c87j92&attributes=[%22familyName%22,%20%22givenName%22,%20%22email%22]&query_filter=email=%27john%[email protected]%27&max_results=10&sort_on=[%22familyName%22]' \
--header 'Accept: application/json' \
--header 'Authorization: Basic XXXXXXXX'

Direct database user update

📘

API reference for /account/users/update endpoint

In addition to the integration documentation in this section, refer to the API Reference for the /account/users/update endpoint for more details.

This is the API call for logging users using their email addresses and passwords. If you use the Next Identity Journeys hosted screens for sign-in, you do not need to use this API call. This API endpoint is only for applications that are using their own custom sign-in screens.

Sample API Call

This is a sample API call using the /account/users/update endpoint with the PUT method.

curl --request PUT \
     --url https://id.eu.nextreason.com/idp/v1/account/users/update \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Basic XXXXXXXX' \
     --data '
{
     "client_id": "c8462jyq9dnupu2q4j7sfjzvn

6c87j92",
     "uuid": "69ed0122-f2d9-4c6e-a636-3670cab4f15f",
     "attributes": "{\"resourceAccess\":{\"LSMNAB2B\":null}}"
}
'