Skip to main content

Create Share Permissions for a Session

Creates a share permission for a session (i.e., the specified user or group is given access to the session).

Authorizations: Sessions - ACCESS

Requests

POST /apis/sessions/:sessionId/shares
{
"shareType": "USER",
"permission": "WATCH",
"name": "InfoDev",
"email": null
}

Response

Success

{
"data": {
  "id": "bbc1cbf3-fbee-48dd-8639-920487b6186f",
  "shareType": "USER",
  "permission": "WATCH",
  "name": "creator",
  "email": null
}
}

Error

Code

Payload

 Description

400
{"code":"010001", "name":"InputValidation",
"message":<Error message>, "httpStatusCode":400}

Supplied data was insufficient or incorrect.

403
{"code":"030003", "name":"CannotShare",
"message":"Cannot share", "httpStatusCode":403}

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.

404
{"code":"040002", "name":"SessionNotFound",
"message":"Session not found",
"httpStatusCode":404}
Session with UUID sessionId not found.
404
{"code":"040004", "name":"UserNotFound",
"message":"User not found", "httpStatusCode":404}
The user with provided id or username was not found
404
{"code":"040005", "name":"GroupNotFound",
"message":"Group not found", "httpStatusCode":404}
The group with provided id or groupname was not found.
404
{"code":"040025", "name":"SharePermissionNotFound",
"message":"Share permission not found",
"httpStatusCode":404}
The specified access permission was not found.
409
{"code":"060001", "name":"UserHasNoRoles",
"message":"User has no roles assigned",
"httpStatusCode": 409}
Make sure a role is assigned to the user or to at least one of the user's groups.
409
{"code":"060002", "name":"GroupHasNoRoles",
"message":"Group has no roles assigned",
"httpStatusCode":409}
Make sure a role is assigned to the group.
500
{"code":"070008", "name":"FindUser",
"message":"Error searching for a user",
"httpStatusCode":500}
An internal error occurred while searching for user
500
{"code":"070009", "name":"FindGroup",
"message":"Error searching for a group",
"httpStatusCode":500}
An internal error occurred while searching for group.

 

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.