User Management

APIs to manage users

Tenant Id can be retrieved from the UI as listed here.

Get all users assigned to this tenant

GET https://demo.auth.telm.ai/auth/{tenant}/users

Path Parameters

Name	Type	Description
tenant*	string	Name of Tenant

Headers

Name	Type	Description
Content-type	string	application/json
Authentication*	string	Bearer <access_token from authentication api>

200 List of users

[
  {
    "email": "string",
    "first_name": "string",
    "id": "string",
    "last_name": "string",
    "role": "string"
  }
]

Get a user's details

GET https://demo.auth.telm.ai/auth/{tenant}/users/{user_email}

Path Parameters

Name	Type	Description
tenant*	string	Name of Tenant
user_email*	String	User email

Headers

Name	Type	Description
Content-type	string	application/json
Authentication*	string	Bearer <access_token from authentication api>

200 User details

{
    "email": "string",
    "first_name": "string",
    "id": "string",
    "last_name": "string",
    "role": "string"
 }

Create User

POST https://demo.auth.telm.ai/auth/{tenant}/users

Path Parameters

Name	Type	Description
tenant*	string	Name of Tenant

Query Parameters

Name	Type	Description
password	string	Optional. If not provided, user will received an email to activate account and set a password
last_name*	string	Last name
first_name*	string	First name
email*	string	Email of the new user
role*	string	"admin" / "user"

Headers

Name	Type	Description
Content-type	string	application/json
Authentication*	string	Bearer {token}

200 Success message

{    
    "message": "User was added successfully"
}

Update User details

PUT https://demo.auth.telm.ai/auth/<tenant>/user/<user_email>

This endpoint allows you to update user details

Path Parameters

Name	Type	Description
user_email*	string	Email of user whose details are to be updated
tenant*	string	Name of tenant

Query Parameters

Name	Type	Description
last_name*	string	Updated last name
role*	string	“admin” / “user” Currently mandatory. Even if there are no updates to this field, it must be provided.
first_name*	string	Updated first name

Headers

Name	Type	Description
Content-type	string	application/json
Authentication*	string	Bearer {token}

200 Success message

{    
    "message": "User was updated successfully"
}

Delete user

DELETE https://demo.auth.telm.ai/auth/{tenant}/users/{user_email}

Path Parameters

Name	Type	Description
tenant*	string	Name of Tenant
user_email*	String	User email

Headers

Name	Type	Description
Content-type	string	application/json
Authentication*	string	Bearer {token}

200 Success message

{
    "message":string
}

Assign user to tenant

PUT https://demo.auth.telm.ai/auth/{tenant}/users/{user_email}/assign

Path Parameters

Name	Type	Description
tenant*	string	Name of Tenant
user_email*	String	User email

Headers

Name	Type	Description
Content-type	string	application/json
Authentication*	string	Bearer <access_token from authentication api>

Request Body

Name	Type	Description
role*	String	Role "user" or "admin"

200 Success message

{
    "message":string
}

Change Password for a specific user email

PUT https://demo.auth.telm.ai/auth/<tenant>/user/<user_email>/password

Path Parameters

Name	Type	Description
user_email*	string	Email of user whose password needs to be changed
tenant*	string	Name of tenant

Query Parameters

Name	Type	Description
old-password*	string	Current password
new-password*	string	New password

Headers

Name	Type	Description
Content-type	string	application/json
Authentication*	string	Bearer <access_toke from Authentication API>

200 Successful message

{    
    "message": "User was updated successfully"}

Reset Password

DELETE https://demo.auth.telm.ai/auth/<tenant>/user/<user_email>/password

This api will trigger an email being sent to reset their password

Path Parameters

Name	Type	Description
user_email*	string	Email of user whose password needs to be reset
tenant*	string	Name of tenant

Headers

Name	Type	Description
Content-type	string	application/json
Authentication*	string	Bearer <access_toke from Authentication API>

200 Successful message

{    
    "message": string
}