Get Share Permissions for a Session

The share resource is used to manage access permissions for the session.

Authorizations: Sessions - VIEW

Requests

CODE

GET /apis/sessions/:sessionId/shares

Response

Success

CODE

{
"data": [{
    "id": "bbc1cbf3-fbee-48dd-8639-920487b6186f",
    "shareType": "USER",
    "permission": "OWN",
    "name": "creator",
    "email": null
  },
  {
    "id": "a78758cc-48da-47ad-bc6e-6c8564badb7e",
    "shareType": "USER",
    "permission": "WATCH",
    "name": "viewer",
    "email": null
  }],
  "paging": {
    "results": 2,
    "pageSize": 15
  }
}

Parameters

Property	JSON Type	Property Type	Description
id	UUID	Immutable	Group ID or user ID. Identifies the share entity.
shareType	String	Required Immutable	Accepted values: GROUP: the share grants access to the members of a group. USER: the share grants access to a specific user.
permission	String	Required	Permission level granted to the group or user. Accepted values: WATCH, EDIT, OWN, or <uuid> of admin-defined access permission.
name	String	Optional	Group name or user name.

Note

Either id or name must be present. If both are provided, id is used. See User Resources and Group Resources.

Error

Code	Payload	Description
`404`	`{"code":"040012", "name":"NoResults",` `"message":"No results", "httpStatusCode":404}`	The specified session has not been shared with any user or group.