LogoLogo
HOMEBLOG
  • Getting Started
  • Connect to Data
    • Projects
    • Data Connectors
      • Google BigQuery
      • Google Cloud Storage
      • Iceberg
      • Snowflake
      • AWS S3
      • AWS Athena
      • AWS Redshift
      • Databricks Delta
      • Azure Blob
      • Salesforce
      • SAP Hana
      • File Path Options
      • SQL Server
      • Trino
    • Connection Modes
    • Triggering Scans
    • Configuring a Data Source
  • Profiling Data
    • Data Health Metrics
    • Data Health Overview Page
    • Interactive Profiling Tool: Investigator
    • Data Diff
    • Compound Attributes
      • List of Supported Functions
  • Monitoring Data
    • Data Quality Metrics
    • Alert Policies
    • Data Trends and Alerts
    • Metrics Inspector
  • Data Quality Rules
    • Rules Expression Examples
  • PII Data Detection
  • Remediation
    • Data Binning
    • Circuit Breaker
  • Integrations
    • Jira Integration
    • Slack
    • Jobs Status Notification
  • User Management
    • Microsoft Entra IDP Setup
    • Auth0 Setup
    • Okta SSO Setup
    • SSO Configuration
  • API Reference
    • Authentication API
    • API Keys
    • Telmai IP List
    • Get Google Service Account API
  • Source APIs
    • Source APIs
  • Upload Data APIs
    • Upload data from Cloud
      • RedShift Request data
      • GCS Request data
      • Azure Request data
      • GBQ Request data
      • Snowflake Request data
      • Amazon S3 Request data
      • Delta Lake Request
      • Trino Request data
    • Track upload job
    • Check for alerts
  • Admin APIs
    • User Management
  • Telmai Releases
    • Release Notes
      • 25.2.1
      • 25.2.0
      • 25.1.3
      • 25.1.2
      • 25.1.0
Powered by GitBook
On this page
  • Get all users assigned to this tenant
  • Get a user's details
  • Create User
  • Update User details
  • Delete user
  • Assign user to tenant
  • Change Password for a specific user email
  • Reset Password
  1. Admin APIs

User Management

APIs to manage users

Get all users assigned to this tenant

GET https://env1.telm.ai/api/auth/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>

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

Get a user's details

GET hhttps://env1.telm.ai/api/auth/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>

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

Create User

POST https://env1.telm.ai/api/auth/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}

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

Update User details

PUT https://env1.telm.ai/api/auth/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}

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

Delete user

DELETE https://env1.telm.ai/api/auth/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}

{
    "message":string
}

Assign user to tenant

PUT https://env1.telm.ai/api/auth/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"

{
    "message":string
}

Change Password for a specific user email

PUT https://env1.telm.ai/api/auth/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>

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

Reset Password

DELETE https://env1.telm.ai/api/auth/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>

{    
    "message": string
}
PreviousCheck for alertsNextRelease Notes

Last updated 1 month ago