Documentation is now available for the Fall 2020 Update release!

Tenancy and Access Controls

Endpoints associated with tenancy and access controls.

Leave Feedback

In this section

Users and user groups introduction

An introduction to user and user group endpoints.

Activate or deactivate client

This endpoint is used to activate or deactivate a client.

Activate user

The endpoint to assign agent policy for resources.

Add users to a user group

This endpoint is used to add users to an existing user group.

Change password

This endpoint is used to change the password.

Create client notes

This endpoint is used to create client notes.

Create clients

This endpoint is used to create a client.

Create credential sets

This endpoint is used to create a credential set.

Create or update custom branding

This endpoint is used to create or update custom branding.

Create roles

This endpoint is used to create a partner-level or client-level role.

Create user

This endpoint is used to create a user.

Create user group

This endpoint is used to create a partner-level or client-level user group.

Deactivate user

This endpoint is used to deactivate a user.

Delete a credential set

This endpoint is used to delete a credential set.

Delete a user group

This endpoint is used to delete a user group under a tenant.

Delete client note

This endpoint is used to delete a client note.

Delete role

This endpoint is used to delete a role.

Get alert technologies

This endpoint is used to retrieve the list of available custom (and email alert integration) alert sources.

Get channels

This endpoint is used to retrieve the list of channels.

Get client

This endpoint is used to retrieve the details of a client.

Get client note

This endpoint is used to retrieve the details of a client note.

Get countries

This endpoint is used to retrieve the list of countries based on country code.

Get credential set

This endpoint is used to fetch the details of a credential set.

Get credential sets

This endpoint is used to delete a credential set.

Get custom branding

This endpoint is used to get custom branding.

Get login audit report

This endpoint is used to retrieve the login history details of users.

Get minimal details of client credential sets

This endpoint is used to retrieve the minimal details of client credential sets.

Get minimal details of clients

This endpoint is used to retrieve the minimal details of clients.

Get minimal details of device credential sets

This endpoint is used to retrieve the minimal details of client credential sets.

Get minimal details of users

This endpoint is used to retrieve the minimal details of the users.

Get partner details

This API is used to get details of a partner.

Get role

This endpoint is used to retrieve the details of a role.

Get tenant NOCs

This endpoint is used to retrieve the list of NOCs of a tenant.

Get timezones

This endpoint is used to retrieve the list of timezones.

Get user

This endpoint is used to retrieve the details of a user.

Get user group

This endpoint is used to retrieve the details of a user group.

Get user groups

This endpoint is used to retrieve the details of the user groups.

Get users of a user group

This endpoint is used to fetch users belonging to a user group.

Remove users from a user group

This endpoint is used to remove users from an existing user group.

Search client note

This endpoint is used to retrieve client notes under a specific client.

Search clients

This endpoint is used to search for the clients.

Search permission sets

This endpoint is used to retrieve the list of permission sets assigned to a tenant.

Search roles

This endpoint is used to retrieve roles under a partner or client.

Search user groups

This endpoint is used to retrieve the list of user groups available within a tenant.

Search users

This endpoint is used to fetch users within a tenant.

Update client notes

This endpoint is used to update the details in a client note.

Update clients

This endpoint is used to update a client.

Update credential set

This endpoint is used to update a credential set.

Update roles

This endpoint is used to update the details of a role.

Update user

This endpoint is used to update the details of a user.

Update user group

This endpoint is used to update a user group’s properties.