To create groups, refer to Local Group Management, SAML Group Management, or LDAP Group Management. However, delete still occurs under Authorizable Groups although local groups can still be deleted in Local Group Management. (Grab this from Get All Authorizable Groups)

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

Authorizable Groups

Get All Authorizable Groups

To create groups, refer to Local Group Management, SAML Group Management, or LDAP Group Management. However, delete still occurs under Authorizable Groups although local groups can still be deleted in Local Group Management.

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

Response



Get Specific Authorizable Group

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

Response



Delete Authorizable Group

NOTE: This will delete any type of group (local, LDAP, or SAML).

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

Local Groups

Get All Local Groups

NOTE: 'group_id' refers to authorizable group ID.

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

Response



Get Specific Local Group

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

Response



Create Local Group

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

  • name (required)

Response





Update Local Group

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

Request Parameters

  • name

Response



Delete Local Group

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

Local Group User Management - Local Users

Get Local Users in a Local Group

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

Response



Get Specific Local User in a Local Group

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

Response



Update Local User in a Local Group

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

Request Parameters

  • '' (empty string)

Response



Delete Local User in a Local Group

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

Local Group User Management - LDAP/SAML Users

Get LDAP/SAML Users in a Local Group

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

Response



Get a Specific LDAP/SAML User in a Local Group

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

Response




Update LDAP/SAML User in a Local Group

PUT/api/v1/data/groups/:group_id/users/:id
Authorization: Basic
Response Format: JSON
Request Parameter: JSON

Request Parameters

  • '' (empty string)

Response



Delete LDAP/SAML User in a Local Group

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

LDAP/SAML Group

Add LDAP Group

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

Request Parameters

  • group (required)

Response



Import SAML Group

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

Request Parameters

  • name (required)

Response



Group's Share Permissions Management

Get All Share Permissions for Specific Group

GET/api/v1/data/groups/:group_id/share_permissions
Authorization: Basic
Response Format: JSON

Response



Get Group's Specific Share Permission

GET/api/v1/data/groups/:group_id/share_permissions/:share_id
Authorization: Basic
Response Format: JSON

Response




 	
Video player

Video

×