Returning.AI
  1. Auth
Returning.AI
  • Returning.AI
    • Auth
      • register
        POST
      • verify email
        POST
      • login
        POST
      • secure auth
        GET
    • Server
      • create new server
      • get my servers
      • update server
      • role list of server
      • channel list of server
    • Role
      • create new role
      • update role
      • delete role
      • add role to a user on a server
      • remove role from a user on a server
      • get role list of user on a server
    • Channel
      • get channels list
      • create new channel
      • update channel
      • delete channel
    • Badge
      • get badges list
      • create new badge
      • update badge
      • delete badge
      • award badge to user
      • remove badge from user
    • Integration
      • users
        • create new user
        • manage user
        • user data
        • gamification stats
        • user bulk update
        • user bulk import
      • Messages
        • Send Message
        • Reply Message
        • React Message
      • Channels
        • Get Channels List
      • User Field Histories
        • Create user field history
        • Get user field histories
      • User Fields
        • Create user field
        • Get all user fields for a community
        • Delete user field
        • Update user field
        • Get specific user field
      • Users
        • Get user
    • Application
      • API Keys
        • Create API key
        • Read API keys
        • Delete API key
        • Update API key
      • Users
        • Get user
      • Community Users
        • Get community users
        • Get user
      • User Fields
        • Get all user fields for a community
        • Get specific user field
        • Create user field
        • Update user field
        • Delete user field
      • User Field Histories
        • Get all user field histories in a community
        • Get user field histories for a specific field
        • Get user field histories for a specific user
        • Get user field histories of specific user field and user
        • Create user field history for specific user
  1. Auth

secure auth

Developing
GET
https://cname.yourdomain.com/api/secureAuth

Request

Query Params
accessLevel
string 
required
Example:
0
action
string 
required
Example:
login
userId
array[string]
optional
user's username for authentication
Example:
["<Username>"]
userId_old
string 
optional
user's username , if userId and useId_old both existing , userId_old will be replaced by userId
Example:
<Username>
firstname
string 
optional
user's first name
Example:
<First Name>
lastname
string 
optional
user's last name
Example:
<Last Name>
displayname
string 
optional
user's displayname
Example:
<Display Name>
email
string 
optional
user's email
Example:
<Email>
sessionId
string 
optional
Example:
<Session ID>
Header Params
apiKey
string 
optional
Example:
API_KEY_HERE
hostname
string 
optional
Example:
cname.yourdomain.com

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://cname.yourdomain.com/api/secureAuth?accessLevel=0&action=login&userId=<Username>&userId_old=<Username>&firstname=<First Name>&lastname=<Last Name>&displayname=<Display Name>&email=<Email>&sessionId=<Session ID>' \
--header 'apiKey: API_KEY_HERE' \
--header 'hostname: cname.yourdomain.com'

Responses

🟢200Success
application/json
Body
error
boolean 
required
loginUrl
string 
required
sessionId
string 
required
Example
{
    "error": false,
    "loginUrl": "https://cname.yourdomain.com/v2/app/loginApi/[API_KEY]/2?token= [token]&host=[cname.yourdomain.com]",
    "sessionId": "xxxxxxxxxxxxxxxxx"
}
Modified at 2025-06-26 14:30:20
Previous
login
Next
create new server