Secure Auth

This endpoint authenticates a user and log them into the community.

Authorization

API Key required.

Found in community settings > Login Management > API key
Include an X-API-Key in the request header with the key.

Fields

action

Specifies the action to perform.
Use "login" to log a user into the community.
ie: "action": "login"

userId

The username of the user logging in.

accessLevel

Defines the starting role assigned to the user in the community (including the @all role).

Note: For existing users, their roles will not be changed.

Configure in Community Settings → Login Management. Click the + next to Login API to add access levels.

The value entered when creating an access level becomes the identifier used in this API.Example set up:

Use case

This endpoint works for both existing and new users, but the required fields differ.

Required fields (For existing users)

Logs an existing user into the community.

{
    "action": "login",
    "userId": "johndoe",
    "accessLevel": 1
}

Flow example:

User logs into your platform.

Call Get User Data with the user’s email to check if they exist.

If the user exists, use the username from the response as the userId to log them in.

If the user does not exist, create one with Create New User.

After creation, use the new username to log in.

Redirect users to the URL in the response

Best Practice!

Save the username along with your user’s information in your own database.

This prevents unnecessary repeated calls to the Get User Data API and ensures you always have a reliable reference for logging users in.

Required fields (For new users)

Creates a new user in the community and logs them in with the roles in the access level.

Important!!

Do not rely on this endpoint to create new users directly unless you can guarantee unique usernames. If a duplicate username is used here, the user may be logged into the wrong account. Use the dedicated Create User API instead, since it provides proper error handling.

{
    "action": "login",
    "userId": "johndoe",
    "accessLevel": 1
    "email": "johndoe@gmail.com",
    "firstname": "john".
    "lastname": "doe",
    "displayname": "john doe" 
}

Redirect users to the URL in the response.

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

application/json

Body

Example

{
    "error": false,
    "loginUrl": "https://cname.yourdomain.com/v2/app/loginApi/[API_KEY]/2?token= [token]&host=[cname.yourdomain.com]",
    "sessionId": "xxxxxxxxxxxxxxxxx"
}

Authorization#

Fields#

action#

userId#

accessLevel#

Use case#

Required fields (For existing users)#

Flow example:#

Required fields (For new users)#

Request

Request Code Samples

Responses

Authorization

Fields

action

userId

accessLevel

Use case

Required fields (For existing users)

Flow example:

Required fields (For new users)