Identity and Access Management — API Reference

Manage identities of your Users, set password policies, and configure other access controls

75 endpoints across 6 tags.

Settings

• GET /business-profile-service/business-profiles — Get Universal list of workspaces
• GET /business-profile-service/organizations/business-profiles — Get Universal list of business profiles for organization user
• GET /business-profile-service/organizations/business-profiles/with-identifiers — Get Universal list of business profiles with identifiers for organization user
• GET /sauth/settings/ban — Get ban settings
• POST /sauth/settings/ban — Update ban settings
• GET /sauth/settings/templates — Get email template settings
• POST /sauth/settings/templates — Update email template settings
• GET /sauth/settings/device-control — Get device authorization settings
• POST /sauth/settings/device-control — Update device authorization settings
• GET /sauth/settings/general — Get general settings
• POST /sauth/settings/general — Update general settings
• GET /sauth/settings/oauth — Get OAuth settings
• POST /sauth/settings/oauth — Update OAuth settings
• GET /sauth/settings/synerise-auth — getSyneriseAuthConfig
• POST /sauth/settings/synerise-auth — updateSyneriseAuthSettings
• GET /sauth/settings/oauth/facebook — getFacebookOauthSettings
• POST /sauth/settings/oauth/facebook — updateFacebookOauthSettings
• GET /sauth/settings/oauth/google — getGoogleOauthSettings
• POST /sauth/settings/oauth/google — updateGoogleOauthSettings
• GET /sauth/settings/oauth/apple — Get Sign in with Apple settings
• POST /sauth/settings/oauth/apple — Update Sign in with Apple settings
• POST /uauth/business-profile/mark-favorite — Add or remove business profile to favorites

Access control

• POST /uauth/business-profile/mfa/requirements — Enable MFA requirement for workspace
• DELETE /uauth/business-profile/mfa/requirements — Disable MFA requirement for workspace
• GET /uauth/users/my-account/strongest-password-settings — Get own strongest password policy
• GET /uauth/settings/user-bp-ip-policy — Get IP allowlist policy
• POST /uauth/settings/user-bp-ip-policy — Update IP allowlist policy
• GET /uauth/strongest-password-settings-by-email/{email} — Get strongest password policy of a User
• POST /uauth/users/mfa/initialization — Initiate multi-factor authentication for user
• POST /uauth/users/mfa/confirmation — Confirm multi-factor authentication for user
• DELETE /uauth/users/mfa — Remove multi-factor authentication for user
• GET /uauth/settings/password-policy — Get user password policy
• POST /uauth/settings/password-policy — Update user password policy

User management

• GET /uauth/user/register/invitation/{invitationToken} — Find user by invitation token
• POST /uauth/users/invitations/invite — Invite user
• POST /uauth/users/invitations/invite-bulk — Invite many users
• DELETE /uauth/users/invitations/{invitationIds} — Delete invitations
• POST /uauth/users/invitations/{invitationId} — Update invitation
• GET /uauth/users/listing — List users
• GET /uauth/v2/users/listing — getUsersV2Listing
• GET /uauth/users/listing/autocomplete — Autocomplete user search result
• DELETE /uauth/users/profile-association/{ids} — Remove users from workspace
• GET /uauth/users/{userId} — Get user data
• POST /uauth/users/{userId} — Update user data
• POST /uauth/users/activate — Activate users
• POST /uauth/users/deactivate — De-activate users
• PUT /uauth/users/{userId}/access-time — Change access expiration time
• POST /uauth/users/{userId}/password-reset — Reset another user's password
• PUT /uauth/users/{userId}/mfa-reset — Reset another user's multi-factor authentication
• DELETE /uauth/users/{ids} — Delete user account

Access groups

• GET /uauth/permissions/group/role/{roleId} — List grouped permissions
• GET /uauth/roles/listing — Get role groups
• POST /uauth/roles/role-group — Create role group
• POST /uauth/roles/role-group/{groupId} — Update role group
• DELETE /uauth/roles/role-group/{groupId} — Delete role group
• POST /uauth/roles/role — Create role
• GET /uauth/roles/{roleId} — Get role
• POST /uauth/roles/role/{roleId} — Update role
• DELETE /uauth/roles/role/{roleId} — Delete role
• GET /uauth/roles/{roleId}/pii — getRolePii
• POST /uauth/roles/{roleId}/pii — updateRolePii
• GET /uauth/users/available-roles — Get available roles

User account management

• POST /uauth/change-password — Change user password
• POST /uauth/password-reset/request — Request user password reset
• POST /uauth/password-reset/confirmation — Confirm user password reset
• GET /uauth/user/confirmation/{confirmationToken} — Confirm user registration
• POST /uauth/user/register — Register user
• POST /uauth/user/register/resend-confirmation — Re-send user confirmation token
• GET /uauth/users/my-account — Get user's own data
• POST /uauth/users/my-account — Update user's own data
• DELETE /uauth/users/my-account — Delete user's own account

Directory

• GET /uauth/managed-domains — List managed domains
• DELETE /uauth/managed-domains — Delete managed domain
• GET /uauth/managed-domains/initialize-code — Initialize managed domain
• POST /uauth/managed-domains/verification — Verify managed domain

Back to all API categories