Synopsis
The groups API is used to get information about groups defined for HMP. Groups are only available if HMP is connected to a Directory Services server. The groups REST API is used to get a list of groups enabled for HMP access. This is the list of groups from the linked Directory Services server. Members of a group are considered to have access to HMP when there is a role associated with the group.
The groups REST API can be used to get the groupname or group id to share a video or session with. See (4.1) Create Share Permissions for a Session and (4.1) Create Video Share Permissions.
Note
The dn and groupname properties are READ-ONLY properties of the HMP groups resource. Data is never written back to the remote directory server.
Group Parameters
|
Property |
JSON Type |
Property Type |
Description |
|---|---|---|---|
|
|
String |
Immutable |
Identifies the resource, generated by HMP. |
|
|
String |
Immutable |
The group name. |