Contains information about the public-level, organization-level, and team-level access for the board. The access level that a user gets depends on the highest level of access that results from considering the public-level access, team-level access, organization-level access, and direct sharing.
For example, if you set sharingPolicy.access to private and sharingPolicy.teamAccess to view, users will have access to the board only if they are in the same team.
If you set sharingPolicy.access to view and sharingPolicy.teamAccess to private, users will have access to the board even if those users are not a part of the team.
If you set sharingPolicy.access to private and sharingPolicy.teamAccess to private, only the board owner has access to the board. If the board is shared with specific people, those people will also have access to the board.
| Property name | Property type | Description |
|---|---|---|
access | String | Indicates the public-level access to the board. Possible values: - private—the board is not available publicly. However, if sharingPolicy.access is set to private and sharingPolicy.teamAccess is set to view, comment, or edit, the board is available to the user if the user is a member of the team.- view—anyone with the board URL can view the board. No sign-in required. - comment—anyone with the board URL can add comments on the board. - edit—anyone with the board URL can edit the board. Default: private |
teamAccess | String | Indicates the team-level access to the board. Possible values: - private—the board is not available for the team. However, if sharingPolicy.teamAccess is set to private, but sharingPolicy.access is set to view or comment, the board is still available to the user as it is made available on public level.- view—any team member can find and view the board. - comment—any team member can find and comment on the board. - edit—any team member can find and edit the board.Default: private |
organizationAccess | String | Indicates the organization-level access to the board. Possible values: - private—the board is not available for the organization. However, if sharingPolicy.organizationAccess is set to private, but sharingPolicy.access is set to view or comment, the board is still available to the user as it is made available on public level.- view—any organization member can find and view the board. - comment—any organization member can find and comment on the board. - edit—any organization member can find and edit the board.Default: private |
inviteToAccountAndBoardLinkAccess | String | Indicates the user role when inviting a user via the invite to team and board link. For Enterprise users, the inviteToAccountAndBoardLinkAccess parameter is always set to no_access regardless of the value that you assign for this parameter.Possible values: viewer, commenter, editor, no_access Default: no_access |
"sharingPolicy": {
"access": "private",
"inviteToAccountAndBoardLinkAccess": "editor",
"organizationAccess": "private",
"teamAccess": "private"
}