API docs by Redocly

User Management Service (1.0.0)

Download OpenAPI specification:Download

Organization

Endpoints to manage organizations

create an organization

Creates an organization. This operation can only be performed by a superadmin.

Authorizations:
SessionCookie
header Parameters
User-ID
string

The User ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

Organization-ID
string

The Organization ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

X-Request-ID
string

The ID associated with the request. If requests are made through API Gateway, this header will be pre filled.

Request Body schema: application/json
required
name
required
string

name of the organization

code
string

code of the organization

contact_email
required
string

contact email of the organization

updates_email
string

email for sending updates to organization's customer

parent_organization_id
required
string

id of the parent organization

updates_email_for_escalations_from_parent
Array of strings

list of email addresses to notify when case is escalated from parent organization

can_have_child_organizations
required
boolean

flag indicating whether the new organization can further have child organizations

parent_has_access_to_descendants
boolean

whether parent organization has access to descendant organizations of the created organization

parent_has_access
boolean

whether parent organization has access to organization's entities. Default is True. If False, parent will also not have access to descendants

updates_email_for_escalations_from_children
Array of strings

list of email addresses to notify when case is escalated from child organizations

logo_url
string

url of the organization's logo

object or null (OrganizationSSOConfiguration)

sso configuration set for the organization

object or null (OrganizationDarrylConfigurationRequest)
rbac_template_id
required
string

id of the rbac template to be used for the organization

object

additional metadata of the organization

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "code": "string",
  • "contact_email": "string",
  • "updates_email": "string",
  • "parent_organization_id": "string",
  • "updates_email_for_escalations_from_parent": [
    ],
  • "can_have_child_organizations": true,
  • "parent_has_access_to_descendants": true,
  • "parent_has_access": true,
  • "updates_email_for_escalations_from_children": [
    ],
  • "logo_url": "string",
  • "sso_configuration": {
    },
  • "darryl_configuration": {
    },
  • "rbac_template_id": "string",
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    }
}

get list of organizations

Get list of organizations accessible to the logged in user.

Authorizations:
SessionCookie
header Parameters
User-ID
string

The User ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

Organization-ID
string

The Organization ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

X-Request-ID
string

The ID associated with the request. If requests are made through API Gateway, this header will be pre filled.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ]
}

filter organizations

Get list of organizations with respect to given filters and accessible to logged in user.

Authorizations:
SessionCookie
header Parameters
User-ID
string

The User ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

Organization-ID
string

The Organization ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

X-Request-ID
string

The ID associated with the request. If requests are made through API Gateway, this header will be pre filled.

Request Body schema: application/json
required
user_permissions
Array of strings

Returns the organizations on which user has access for the given permissions

include_organization_configuration
boolean

If true, configuration for organizations will be included in the response. Default value is false.

root_organization_id
string

Organization ID for which descendants are to be fetched.

can_have_child_organizations
boolean

flag indicating whether the organization can further have child organizations

include_organizations_with_no_access
boolean

flag indicating whether to include organizations with parent_has_access flag as false. The default value is false for backward compatibility.

include_organizations_with_inaccessible_descendants
boolean

flag indicating whether to include organizations with parent_has_access_to_descendants flag as false. The default value is true.

feature
string

Feature for which accessible organizations will be fetched.

Responses

Request samples

Content type
application/json
{
  • "user_permissions": [
    ],
  • "include_organization_configuration": true,
  • "root_organization_id": "string",
  • "can_have_child_organizations": true,
  • "include_organizations_with_no_access": true,
  • "include_organizations_with_inaccessible_descendants": true,
  • "feature": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ]
}

get details of an organization

Get details of an organization.

Authorizations:
SessionCookie
path Parameters
organization_identifier
required
string

The identifier (id or code) of the organization to be fetched

header Parameters
User-ID
string

The User ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

Organization-ID
string

The Organization ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

X-Request-ID
string

The ID associated with the request. If requests are made through API Gateway, this header will be pre filled.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    }
}

update an organization

Updates an organization. This operation can only be performed by a superadmin.

Authorizations:
SessionCookie
path Parameters
organization_identifier
required
string

The unique identifier (id or code) of the organization

header Parameters
User-ID
string

The User ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

Organization-ID
string

The Organization ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

X-Request-ID
string

The ID associated with the request. If requests are made through API Gateway, this header will be pre filled.

Request Body schema: application/json
required
name
string

name of the organization

contact_email
string or null

contact email of the organization

updates_email
string or null

email for sending updates to organization's customer

updates_email_for_escalations_from_parent
Array of strings or null

list of email addresses to notify when case is escalated from parent organization

updates_email_for_escalations_from_children
Array of strings or null

list of email addresses to notify when case is escalated from child organizations

logo_url
string or null

url of the organization's logo

enable_metabase
boolean or null

whether metabase is enabled for the organization

object or null (OrganizationSSOConfiguration)

sso configuration set for the organization

object or null (OrganizationDarrylConfigurationRequest)
rbac_template_id
string

id of the rbac template to be used for the organization

object or null

additional metadata of the organization

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "contact_email": "string",
  • "updates_email": "string",
  • "updates_email_for_escalations_from_parent": [
    ],
  • "updates_email_for_escalations_from_children": [
    ],
  • "logo_url": "string",
  • "enable_metabase": true,
  • "sso_configuration": {
    },
  • "darryl_configuration": {
    },
  • "rbac_template_id": "string",
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    }
}

delete an organization

Deletes an organization. This operation can only be performed by a superadmin, and a user cannot delete their own organization. Deleting an organization also deletes all descendant organizations, along with their users and user groups.

Authorizations:
SessionCookie
path Parameters
organization_identifier
required
string

The unique identifier (id or code) of the organization

header Parameters
User-ID
string

The User ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

Organization-ID
string

The Organization ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

X-Request-ID
string

The ID associated with the request. If requests are made through API Gateway, this header will be pre filled.

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

upload logo of an organization

Upload logo of an organization.

Authorizations:
SessionCookie
header Parameters
User-ID
string

The User ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

Organization-ID
string

The Organization ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

X-Request-ID
string

The ID associated with the request. If requests are made through API Gateway, this header will be pre filled.

Request Body schema: multipart/form-data
required
logo
string <binary>

Image of the logo of the organization

usage_type
string (LogoUsageType)
Enum: "login" "darryl"

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    }
}

deletes and recreates metabase resources

Deletes and recreates metabase resources.

Authorizations:
SessionCookie
path Parameters
organization_identifier
required
string

The unique identifier (id or code) of the organization

header Parameters
User-ID
string

The User ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

Organization-ID
string

The Organization ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

X-Request-ID
string

The ID associated with the request. If requests are made through API Gateway, this header will be pre filled.

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

gets metabase session

Gets metabase session.

Authorizations:
SessionCookie
header Parameters
User-ID
string

The User ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

Organization-ID
string

The Organization ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

X-Request-ID
string

The ID associated with the request. If requests are made through API Gateway, this header will be pre filled.

Responses

Response samples

Content type
application/json
{
  • "jwt": "string"
}

User

Endpoints to manager users

create user

Creates a user in an organization. This action can only be performed by superadmin or admin accounts. An admin cannot create a superadmin in their own organization, but they can create a superadmin in their accessible organizations.

Authorizations:
SessionCookie
header Parameters
User-ID
string

The User ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

Organization-ID
string

The Organization ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

X-Request-ID
string

The ID associated with the request. If requests are made through API Gateway, this header will be pre filled.

Request Body schema: application/json
first_name
string

first name of the user

last_name
string

last name of the user

preferred_name
string

preferred name of the user

email
required
string

email address of the user

password
string

password to set for the account

organization_id
required
string

id of the organization in which the user needs to be added

role
string (UserRole)
Enum: "user" "admin" "superadmin"

role of the user. A user can view data in accessible organizations but cannot create or modify organizations or user accounts. An admin can view data and manage users in accessible organizations but cannot create or modify organizations. A superadmin can view data, manage users, and manage descendant organizations in their accessible organizations.

Responses

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "preferred_name": "string",
  • "email": "string",
  • "password": "string",
  • "organization_id": "string",
  • "role": "user"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    }
}

filter users

Filter users by organization ids and user ids accessible to the logged in user. If no filter is provided, all users in all accessible organizations are returned.

Authorizations:
SessionCookie
query Parameters
page
required
integer

Page number for paginated results.

size
required
integer

Number of results per page.

header Parameters
User-ID
string

The User ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

Organization-ID
string

The Organization ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

X-Request-ID
string

The ID associated with the request. If requests are made through API Gateway, this header will be pre filled.

Request Body schema: application/json
object (ListUserFilter)
Array of objects (SortFields)

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "sort": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "total": 0
}

filter logged in users

Filter logged in users by organization ids and user ids accessible to the logged in user. If no filter is provided, all users in all accessible organizations are returned.

Authorizations:
SessionCookie
query Parameters
page
required
integer

Page number for paginated results.

size
required
integer

Number of results per page.

header Parameters
User-ID
string

The User ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

Organization-ID
string

The Organization ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

X-Request-ID
string

The ID associated with the request. If requests are made through API Gateway, this header will be pre filled.

Request Body schema: application/json
accessible_organization_list
Array of strings

The list of organization IDs for which user information is needed.

Responses

Request samples

Content type
application/json
{
  • "accessible_organization_list": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "total": 0
}

bulk delete users

Bulk delete users in an organization. This action can only be performed by superadmin or admin accounts.

Authorizations:
SessionCookie
header Parameters
User-ID
string

The User ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

Organization-ID
string

The Organization ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

X-Request-ID
string

The ID associated with the request. If requests are made through API Gateway, this header will be pre filled.

Request Body schema: application/json
user_id_list
Array of strings

The list of user IDs that need to deleted.

Responses

Request samples

Content type
application/json
{
  • "user_id_list": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string"
}

fetch user details

Fetches details of a user. This action can only be performed by superadmin or admin accounts; however, users can view their own details regardless of their role.

Authorizations:
SessionCookie
path Parameters
user_id
required
string

The ID of User

header Parameters
User-ID
string

The User ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

Organization-ID
string

The Organization ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

X-Request-ID
string

The ID associated with the request. If requests are made through API Gateway, this header will be pre filled.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    }
}

update user details

Updates the details of a user. First name, last name, and preferred name can be updated by any user. Role can only be updated by admin or superadmin accounts; however, admins are not permitted to assign superadmin role to a user.

Authorizations:
SessionCookie
path Parameters
user_id
required
string

The ID of User

header Parameters
User-ID
string

The User ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

Organization-ID
string

The Organization ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

X-Request-ID
string

The ID associated with the request. If requests are made through API Gateway, this header will be pre filled.

Request Body schema: application/json
first_name
string

first name of the user

last_name
string

last name of the user

preferred_name
string

preferred name of the user

role
string (UserRole)
Enum: "user" "admin" "superadmin"

role of the user. A user can view data in accessible organizations but cannot create or modify organizations or user accounts. An admin can view data and manage users in accessible organizations but cannot create or modify organizations. A superadmin can view data, manage users, and manage descendant organizations in their accessible organizations.

Responses

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "preferred_name": "string",
  • "role": "user"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    }
}

delete user

Deletes a user. A user cannot delete their own account. This action can only be performed by superadmin or admin accounts; however, an admin cannot delete a superadmin.

Authorizations:
SessionCookie
path Parameters
user_id
required
string

The id of User

header Parameters
User-ID
string

The User ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

Organization-ID
string

The Organization ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

X-Request-ID
string

The ID associated with the request. If requests are made through API Gateway, this header will be pre filled.

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

fetch user details from email

Fetches details of a user with given email.

Authorizations:
SessionCookie
path Parameters
email_id
required
string

The email of User to be fetched

header Parameters
User-ID
string

The User ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

Organization-ID
string

The Organization ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

X-Request-ID
string

The ID associated with the request. If requests are made through API Gateway, this header will be pre filled.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    }
}

verify email and domain from email

verify if user exists for a given email and organization exists for domain in the email.

Authorizations:
SessionCookie
header Parameters
User-ID
string

The User ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

Organization-ID
string

The Organization ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

X-Request-ID
string

The ID associated with the request. If requests are made through API Gateway, this header will be pre filled.

Request Body schema: application/json
required
email_ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "email_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ]
}

User Group

Endpoints to manage user groups

create user group

Creates a user group. This group can only be granted access to descendant organizations. Only users from the same parent organization can be added to the user group. This action can only be performed by superadmin or admin accounts.

Authorizations:
SessionCookie
header Parameters
User-ID
string

The User ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

Organization-ID
string

The Organization ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

X-Request-ID
string

The ID associated with the request. If requests are made through API Gateway, this header will be pre filled.

Request Body schema: application/json
name
required
string

name of the user group

description
string

description of the user group

parent_organization_id
required
string

id of the organization where the user group needs to be created

user_ids
Array of strings

list of id of the users to add to the user group

Array of objects (AccessibleOrganizationsRequest)

list of organization ids and future child organizations setting the user group will have access to

can_assign_cases
boolean

flag indicating whether cases can be assigned to user group

case_categories
Array of strings

list of case catgeory names which can be assigned to users of the group

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "parent_organization_id": "string",
  • "user_ids": [
    ],
  • "accessible_organizations": [
    ],
  • "can_assign_cases": true,
  • "case_categories": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    }
}

filter user groups

Filter user groups by organization ids and user ids accessible to the logged in user. If no filter is provided, all user groups in all accessible organizations are returned. This action can only be performed by superadmin or admin accounts.

Authorizations:
SessionCookie
query Parameters
page
required
integer

Page number for paginated results.

size
required
integer

Number of results per page.

header Parameters
User-ID
string

The User ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

Organization-ID
string

The Organization ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

X-Request-ID
string

The ID associated with the request. If requests are made through API Gateway, this header will be pre filled.

Request Body schema: application/json
object (ListUserGroupFilter)
Array of objects (SortFields)

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "sort": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "total": 0
}

get user group

Get details of a user group. This action can only be performed by superadmin or admin accounts.

Authorizations:
SessionCookie
path Parameters
user_group_id
required
string

The ID of the user group to update

header Parameters
User-ID
string

The User ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

Organization-ID
string

The Organization ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

X-Request-ID
string

The ID associated with the request. If requests are made through API Gateway, this header will be pre filled.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    }
}

update user group

Updates a user group. This group can only be granted access to descendant organizations. Only users from the same parent organization can be added to the user group. This action can only be performed by superadmin or admin accounts.

Authorizations:
SessionCookie
path Parameters
user_group_id
required
string

The ID of the user group to update

header Parameters
User-ID
string

The User ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

Organization-ID
string

The Organization ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

X-Request-ID
string

The ID associated with the request. If requests are made through API Gateway, this header will be pre filled.

Request Body schema: application/json
name
string

name of the user group

description
string

description of the user group

user_ids
Array of strings

list of id of the users to add to the user group

Array of objects (AccessibleOrganizationsRequest)

list of organization ids and future child organizations setting the user group will have access to

can_assign_cases
boolean

flag indicating whether cases can be assigned to user group

case_categories
Array of strings

list of case catgeory names which can be assigned to users of the group

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "user_ids": [
    ],
  • "accessible_organizations": [
    ],
  • "can_assign_cases": true,
  • "case_categories": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    }
}

delete user group

Deletes a user group. This action can only be performed by superadmin or admin accounts.

Authorizations:
SessionCookie
path Parameters
user_group_id
required
string

The ID of the user group to update

header Parameters
User-ID
string

The User ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

Organization-ID
string

The Organization ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

X-Request-ID
string

The ID associated with the request. If requests are made through API Gateway, this header will be pre filled.

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Token

Endpoints to manage tokens

create API token

Creates API Token for the Requestor. Api tokens are user level and permissions associated with a token are the same as that of the user who created that token. This action can only be performed by superadmin or admin accounts.

Authorizations:
SessionCookie
query Parameters
return_active_token_if_exists
boolean
Default: false

If true, returns an existing active token instead of creating a new one. Defaults to false.

header Parameters
User-ID
required
string

The User ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

Organization-ID
required
string

The Organization ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

X-Request-ID
string

The ID associated with the request. If requests are made through API Gateway, this header will be pre filled.

Request Body schema: application/json
name
required
string

Name of the Token to be created

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "token_id": "string",
  • "name": "string",
  • "token": "string",
  • "created_at": 0,
  • "last_used_at": 0
}

list all API Tokens created by a user

List all API Tokens created by a User. This action can only be performed by superadmin or admin accounts.

Authorizations:
SessionCookie
header Parameters
User-ID
required
string

The User ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

Organization-ID
required
string

The Organization ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

X-Request-ID
string

The ID associated with the request. If requests are made through API Gateway, this header will be pre filled.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "total": 0
}

delete an API Token

Deletes API Token. Only creator can delete their token. This action can only be performed by superadmin or admin accounts.

Authorizations:
SessionCookie
path Parameters
token_id
required
string

The id of the token to be deleted

header Parameters
User-ID
required
string

The User ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

Organization-ID
required
string

The Organization ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

X-Request-ID
string

The ID associated with the request. If requests are made through API Gateway, this header will be pre filled.

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Permission

Endpoints to read system permissions

list permissions

List of permissions available in the system.

Authorizations:
SessionCookie
header Parameters
User-ID
string

The User ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

Organization-ID
string

The Organization ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

X-Request-ID
string

The ID associated with the request. If requests are made through API Gateway, this header will be pre filled.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ]
}

list disabled permissions for user

List of disabled permissions in the system for user and organization.

Authorizations:
SessionCookie
header Parameters
User-ID
string

The User ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

Organization-ID
string

The Organization ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

X-Request-ID
string

The ID associated with the request. If requests are made through API Gateway, this header will be pre filled.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    }
}

List Organization RBAC templates

List the availableRBAC templates.

Authorizations:
SessionCookie
header Parameters
User-ID
string

The User ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

Organization-ID
string

The Organization ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

X-Request-ID
string

The ID associated with the request. If requests are made through API Gateway, this header will be pre filled.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ]
}

Create Organization RBAC template

Create a new organization RBAC template.

Authorizations:
SessionCookie
header Parameters
User-ID
string

The User ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

Organization-ID
string

The Organization ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

X-Request-ID
string

The ID associated with the request. If requests are made through API Gateway, this header will be pre filled.

Request Body schema: application/json
required
template_id
required
string

Unique identifier for the RBAC template

display_name
required
string

Display name for the RBAC template

required
object (ParentVisibility)

What parents are allowed to see

required
object (ChildVisibility)

What child orgs are allowed to see

required
object (OrgVisibility)

Organization-level visibility settings

Responses

Request samples

Content type
application/json
{
  • "template_id": "string",
  • "display_name": "string",
  • "parent_visibility": {
    },
  • "child_visibility": {
    },
  • "org_visibility": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    }
}

Get Organization RBAC template

Get the RBAC template for the organization.

Authorizations:
SessionCookie
path Parameters
template_id
required
string

The ID of the RBAC template

header Parameters
User-ID
string

The User ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

Organization-ID
string

The Organization ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

X-Request-ID
string

The ID associated with the request. If requests are made through API Gateway, this header will be pre filled.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    }
}

Update Organization RBAC template

Update the RBAC template for the organization.

Authorizations:
SessionCookie
path Parameters
template_id
required
string

The ID of the RBAC template

header Parameters
User-ID
string

The User ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

Organization-ID
string

The Organization ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

X-Request-ID
string

The ID associated with the request. If requests are made through API Gateway, this header will be pre filled.

Request Body schema: application/json
required
template_id
required
string

Unique identifier for the RBAC template

display_name
required
string

Display name for the RBAC template

required
object (ParentVisibility)

What parents are allowed to see

required
object (ChildVisibility)

What child orgs are allowed to see

required
object (OrgVisibility)

Organization-level visibility settings

Responses

Request samples

Content type
application/json
{
  • "template_id": "string",
  • "display_name": "string",
  • "parent_visibility": {
    },
  • "child_visibility": {
    },
  • "org_visibility": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    }
}

Delete Organization RBAC template

Delete the RBAC template for the organization.

Authorizations:
SessionCookie
path Parameters
template_id
required
string

The ID of the RBAC template

header Parameters
User-ID
string

The User ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

Organization-ID
string

The Organization ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

X-Request-ID
string

The ID associated with the request. If requests are made through API Gateway, this header will be pre filled.

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

List of allowed permissions for the organization RBAC template

List the permission for the organization RBAC template.

Authorizations:
SessionCookie
header Parameters
User-ID
string

The User ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

Organization-ID
string

The Organization ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

X-Request-ID
string

The ID associated with the request. If requests are made through API Gateway, this header will be pre filled.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    }
}

List allowed RBAC movement

List the allowed RBAC movement for the organization.

Authorizations:
SessionCookie
header Parameters
User-ID
string

The User ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

Organization-ID
string

The Organization ID of the requestor. If requests are made through API Gateway, this header will be pre filled.

X-Request-ID
string

The ID associated with the request. If requests are made through API Gateway, this header will be pre filled.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": "string"
}