Access APIs

Access APIs for managing users, roles, tenants and other related system security operations

API Methods

★ Includes Example(s)
Can be used by Enterprise Admin accounts
Can be used by Enterprise or Domain Admin accounts
Can be used by all user accounts

addAnalystProfile

Add an Analyst User Profile

2023.10

addDomainSettings

Add new AD LDAP server

2023.10

addProProfile

Add a Professional User Profile

2023.10

addScientistProfile

Add a Scientist User Profile

2023.10

addUserToRole

Add a user to a Role

2023.10

addUsersToRole

Add Users to a Role

2023.10

addViewerProfile

Add a Viewer User Profile

2023.10

changeRoleAdGroups

Modify Active Directory Groups in a Role

2023.10

changeUserLicense

Change a User’s License Type

2023.10

createRole

Create a Security Role

2023.10

createRoles

Create Security Roles

2023.10

createTenant

Create a Tenant

2023.10

createTenants

Create Multiple Tenants

2023.10

createUserAd

Create a new user (ACTIVE DIRECTORY)

2023.10

createUserDb

Create a new user (DATABASE)

2023.10

createUserOpenId

Create a new user (OpenID)

2023.10

createUserSaml

Create a new user (SAML)

2023.10

createUsersAd

Create multiple users (ACTIVE DIRECTORY)

2023.10

createUsersDb

Create multiple users (Internal / Database)

2023.10

createUsersOpenId

Create multiple users (OpenID)

2023.10

createUsersSaml

Create multiple users (SAML)

2023.10

deleteProfile

Removes a user profile from the system

2023.10

deleteRole

Delete a Role

2023.10

deleteTenants

Delete Tenants

2023.10

deleteUser

Delete a User

2023.10

findRoles

Find Security Roles

2023.10

getAllProfiles

Get a list of al user pro profiles in the System

2023.10

getAllRoles

Get All Roles

2023.10

getAllTenants

Get all Tenants

2023.10

getDefaultTenant

Get the default tenant ID

2023.10

getGroupsByRole

Get Active Directory Groups for a Role

2023.10

getLicenseCount

Get Tenant License Count

2023.10

getLicenseExpirationDate

Get License Expiration Date

2023.10

getLicenseValidationStatus

Get License Status

2023.10

getMe

Gets details for the current user.

2023.10

getProfileForUser

Returns the profile assigned to the specified user

2023.10

getProfilesByTenant

List user profiles for a tenant

2023.10

getProfilesByUserType

Get a list of all user profiles in the System of given ClientLicenseType

2023.10

getPublicRoles

Get All Public Roles

2023.10

getPublicRolesByTenant

Get All Public Roles for a Tenant

2023.10

getRoleById

Get a Security Role by ID

2023.10

getRolesByUser

Get all Roles for a User

2023.10

getRolesbyProfile

Returns a list of roles assigned to the specified user profile

2023.10

getTenantByName

Get Tenant by Name

2023.10

getTenantProfilesByUserType

Gets a listing all profiles in the system of given ClientLicenseType and tenantID

2023.10

getTenantUnusedLicenseCount

Get Available License Count for a Tenant

2023.10

getTenantUsersByUserType

Get a Tenant's Users with specific license type

2023.10

getUser

Get a User via ID

2023.10

getUserByOpenIdPrincipalName

Get a User by UPN (OpenID)

2023.10

getUserBySamlPrincipalName

Get a User by UPN (SAML)

2023.10

getUserLastLogin

Get User Last Login Timestamp

2023.10

getUserStatusById

Get User's System Status by User ID

2023.10

getUserStatusByName

Get User's System Status by Name

2023.10

getUsersByCurrentTenant

Get the Current Tenant's Users

2023.10

getUsersByName

Get a User by UserName

2023.10

getUsersByRole

Get all Users in a Role

2023.10

getUsersByTenant

Get a Tenant's Users

2023.10

searchAdGroups

Search AD Groups

2023.10

searchAdGroupsForUser

Search User’s AD Groups

2023.10

searchAdUsers

Search for Active Directory users

2023.10

searchAdUsersForGroups

Search Active Directory Group Members

2023.10

setUserAdministrationLevel

Set User's Administration Level

2023.10

toggleUserStatus

Change User's Status

2023.10

updateDomainAdminPermissions

Update Domain Admin Permissions

2023.10

updateRoleProfiles

Update Role Profiles

2023.10

updateTenant

Update a Tenant

2023.10

updateTenantSeats

Updates a tenant seats

2023.10

updateUserAd

Update user settings (ACTIVE DIRECTORY)

2023.10

updateUserDb

Update user settings (Internal / DATABASE)

2023.10

updateUserOpenId

Update user settings (OpenID)

2023.10

updateUserRoles

Update a User’s Roles

2023.10

updateUserSaml

Update user settings (SAML)

2023.10

updateUsersAd

Update user settings (ACTIVE DIRECTORY)

2023.10

updateUsersDb

Update user settings (Internal / DATABASE)

2023.10

updateUsersOpenId

Update settings for multiple users (OpenID)

2023.10

updateUsersPhones

Update phones of users

2023.10

updateUsersSaml

Update settings for multiple users (SAML)

2023.10