To create users, refer to Local User Management, SAML User Management, or LDAP User Management. However, delete occurs under Authorizable Users although you can also delete local users from Local User Management. It is important to note that only when the user type is database will the local_user_id be returned.

NOTE: Manager authorization to these resources depends on the configuration option selected in the UI.

Authorizable Users

Get All Authorizable Users

To create users, refer to Local User Management, SAML User Management, or LDAP User Management. However, delete occurs under Authorizable Users although you can also delete local users from Local User Management. It is important to note that only when the user type is database will the local_user_id be returned.

GET/api/v1/data/users
Authorization: Basic
Response Format: JSON

Response



Get Specific Authorizable User

GET/api/v1/data/users/:id
Authorization: Basic
Response Format: JSON

Response



Delete Authorizable User

NOTE: This will delete any type of user (local, LDAP, and SAML).

DELETE/api/v1/data/users/:id
Authorization: Basic
Response Format: JSON

Local Users

Get All Local Users

NOTE: 'user_id' refers to the authorizable user ID

GET/api/v1/data/local_users
Authorization: Basic
Response Format: JSON

Response



Get Specific Local User

GET/api/v1/data/local_users/:id
Authorization: Basic
Response Format: JSON

Response



Create Local User

POST/api/v1/data/local_users
Authorization: Basic
Response Format: JSON
Request Parameter: JSON

Request Parameters

  • username (required)
  • password
  • email (required)
  • first_name
  • last_name
  • send_welcome_email* (default: false)

*send_welcome_email with password triggers 'Login information' email with 'Login' link while it alone triggers 'Login information' email with 'Change password' link

Response



Update Local User

PUT/api/v1/data/local_users/:id
Authorization: Basic
Response Format: JSON
Request Parameter: JSON

Request Parameters

  • username
  • password
  • email
  • first_name
  • last_name

Response



Delete Local User

DELETE/api/v1/data/local_users/:id
Authorization: Basic
Response Format: JSON

LDAP/SAML Users

Add LDAP User

POST/api/v1/data/ldap_users
Authorization: Basic
Response Format: JSON
Request Parameter: JSON

Request Parameters

  • user (required)

Response



Import SAML User

POST/api/v1/data/saml_users/import
Authorization: Basic
Response Format: JSON
Request Parameter: JSON

Request Parameters

  • id (required)
  • name_id (required)
  • email
  • given_name
  • surname

Response



User's Share Permissions Management

Get All Share Permissions for Specific User

GET/api/v1/data/users/:user_id/share_permissions
Authorization: Basic
Response Format: JSON

Response



Get User's Specific Share Permission

GET/api/v1/data/users/:user_id/share_permissions/:share_id
Authorization: Basic
Response Format: JSON

Response

 	
Video player

Video

×