Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.

Introduction

SDK (beta)

API Reference

Slack

Metadata

GET
Get org metadata
GET
Get app metadata

Authentication

POST
Create User By Email and Password
POST
Sign In By Email and Password
POST
Request password reset code by email
PUT
Update user password using email and verification code
PUT
Accept user invite with email and verification code
GET
Get User JWKs
POST
Generate Access Token for Machine User
GET
Get user organizations by email
PUT
Update User Password using current password
DEL
Sign Out user by sessionId
GET
Get user information by token
GET
Get User Manager Roles by token
GET
Get user information by user id
PUT
Update user information
POST
Request to send email verification code
POST
Verify user email

IDP Authentication

POST
Create Idp Intent by id
POST
Validate Idp Intent
POST
Authenticate user using LDAP protocol with LDAP IDP and username/password

V2 : Authentication

POST
Sign In By Email and Password
PATCH
Verify session using MFA

Authorization

GET
Get all users
POST
Create User
POST
Invite User with privileged IAM Role
POST
Invite User in organization
POST
Invite Org Admin in organization
POST
Invite Org User managers in organization
POST
Setup Organization
PUT
Add/Update Roles and Permissions of organization
PUT
Update Member Roles
GET
Get User Roles for logged in user
GET
Get User Roles by user id
POST
Check Permissions of User
POST
Add Identity Provider for Google
POST
Add Identity Provider for Microsoft AzureAD
GET
Get Organization Identity Providers List
POST
Add LDAP Identity Provider and link to Organization
PUT
Update LDAP Identity Provider
DEL
Delete Identity Provider
POST
Creates a Machine/ Service User
GET
Get All Organizations
DEL
Delete User
GET
Get Organization Events
POST
Search Users of an organization
POST
Add user to org
DEL
Delete user from org
GET
Get All Users of an organization
POST
Search users
GET
Get Organization Data
PATCH
Udpate Organization Data
POST
Advanced User Search
POST
Get all users with advance parameters
POST
Search Organizations
POST
Verify email and enable MFA for user
GET
List of Active and Expired Sessions
GET
Get User Sessions of an organization
GET
Get organization login settings
PATCH
Update organization login settings
PATCH
Extend existing Session
POST
Add / Update Organization Custom Settings
GET
List/Search Organization's Groups
POST
Setup Organization Group
POST
Add/Update Roles and Permissions of organization group
DEL
Delete roles from the group
GET
Get privileged member from organization group
POST
Invite Group Admin in organization group
GET
Get All Users of an organization group
POST
Invite User in organization group
POST
Add/Update Group Users Roles
DEL
Delete User from organization group
POST
Activate inactive user from organization group
DEL
Delete privileged member from organization group
PUT
Update Group
DEL
Delete Group
GET
Get User's Groups in an Organization
GET
Get pre-defined application roles
POST
Add/Update pre-defined application roles
DEL
Delete pre-defined application roles

V2 : Authorization

POST
Create User In Organization

Probes

GET
Health Check
GET
Dependency Health Check

Authorization

Get All Organizations

Please note that passing the additional query params like includeMetadata, includeMembers etc. adds up to latency Therefore use them only if required Roles Allowed: ** SUPER_ADMIN ** GENERIC_MACHINE_USER

Creates a Machine/ Service User Delete User

⌘I

Powered byThis documentation is built and hosted on Mintlify, a developer documentation platform