Share a Session with a Group
This command sets the access permission (either WATCH, EDIT, RECORD, OWN, or custom permission ID) of the specified session with the specified group.
Important
Groups are only available on HMP if your system is connected to an LDAP or Active Directory server. See Managing User Provisioning/SSO in the HMP Administrator's Guide.
Authorizations: All
Request
shareSessionWithGroup groupname permissionId sessionId |
Parameters
Name | Description |
---|---|
groupname | The unique name specified for the HMP group. groupname is case-insensitive. |
permissionId | The access permission to assign to this group:
|
sessionId | The ID of a HMP session. |
Result
Success
OK |
Error
Error | Description |
---|---|
ERROR|010003|Expected 3 parameter(s). | Calling shareSessionWithGroup requires 3 parameters. |
ERROR|010001|'Y' is not a UUID | The sessionId provided must be a UUID. |
ERROR|010001|Permission must be one of: | The 'permission' passed in was not one of the expected values. |
ERROR|070009|Error searching for a group | An internal error occurred while searching for group 'groupname '. |
ERROR|040005|Group not found | The group with UUID 'groupName ' was not found. |
ERROR|060002|Group has no roles assigned | Returned when a group has no roles. |
ERROR|040006|Session not found | The session with UUID 'sessionId ' was not found. |
ERROR|030003|Cannot share | User is not allowed to share to this permission ID. Ex.: User has the WATCH permission, but is trying to share to the OWN level. |
Example
This example uses a default HMP access permission.
shareSessionWithGroup Viewers RECORD 71edd346-2cf0-4c62-b3d3-9d457b287394 OK |
This example uses a custom access permission.
shareSessionWithGroup Admins 12b0cc54-9018-42c2-9dfb-3f7707a09829 OK |