Skip to content

Latest commit

 

History

History
22 lines (20 loc) · 2.37 KB

SharePermission.md

File metadata and controls

22 lines (20 loc) · 2.37 KB

SharePermission

Properties

Name Type Description Notes
id Long The unique identifier of the share permission. [optional]
type TypeEnum The type of share permission: * `group` Shared with a group. If set in a request, then specify `sharePermission.group` as well. * `project` Shared with a project. If set in a request, then specify `sharePermission.project` as well. * `projectRole` Share with a project role in a project. This value is not returned in responses. It is used in requests, where it needs to be specify with `projectId` and `projectRoleId`. * `global` Shared globally. If set in a request, no other `sharePermission` properties need to be specified. * `loggedin` Shared with all logged-in users. Note: This value is set in a request by specifying `authenticated` as the `type`. * `project-unknown` Shared with a project that the user does not have access to. Cannot be set in a request.
project AllOfSharePermissionProject The project that the filter is shared with. This is similar to the project object returned by Get project but it contains a subset of the properties, which are: `self`, `id`, `key`, `assigneeType`, `name`, `roles`, `avatarUrls`, `projectType`, `simplified`. For a request, specify the `id` for the project. [optional]
role AllOfSharePermissionRole The project role that the filter is shared with. For a request, specify the `id` for the role. You must also specify the `project` object and `id` for the project that the role is in. [optional]
group AllOfSharePermissionGroup The group that the filter is shared with. For a request, specify the `name` property for the group. [optional]

Enum: TypeEnum

Name Value
GROUP "group"
PROJECT "project"
PROJECTROLE "projectRole"
GLOBAL "global"
LOGGEDIN "loggedin"
AUTHENTICATED "authenticated"
PROJECT_UNKNOWN "project-unknown"