Organisations
Give a member or a group a role on a board
Adds a member of the organisation, or one of its provisioned groups, with view, edit or manage, or changes the role they have.
PUT
/orgs/{org}/boards/{board}/grantsTL;DR
| Question | Answer |
|---|---|
| What does it do? | Give a member or a group a role on a board. |
| What does it take? | A JSON body of type SetBoardGrantBody. |
| What does it return? | Status 200 with a body of type BoardAccess. |
| What can go wrong? | 400 the body is not valid; 401 not signed in; 403 boards are not turned on for this organisation (boards.not_enabled), the caller may look but not change it (boards.forbidden), or the request came from an origin that may not make changes; 404 no such organisation, board or tab, or the board is not open to the caller: the cases look alike; 429 too many requests; 503 organisations or boards are not set up on this server. Every failure uses the one error envelope. |
What it does
Adds a member of the organisation, or one of its provisioned groups, with view, edit or manage, or changes the role they have. A person outside the organisation is invited to it first. Audited as orgs.board.share.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation's id or its slug. |
board | string | yes | The board's id: 22 letters and digits. |
Request body
The body has the type SetBoardGrantBody.
| Field | Type | Required | Description |
|---|---|---|---|
kind | "user" | "group" | yes | |
id | string | yes | at least 1 character; at most 64 characters. |
role | "view" | "edit" | "manage" | yes | view: look; edit: change the tabs; manage: also change who may open the board. |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | Who may open the board. | BoardAccess |
| 400 | The body is not valid. | ErrorResponse |
| 401 | Not signed in. | ErrorResponse |
| 403 | Boards are not turned on for this organisation (boards.not_enabled), the caller may look but not change it (boards.forbidden), or the request came from an origin that may not make changes. | ErrorResponse |
| 404 | No such organisation, board or tab, or the board is not open to the caller: the cases look alike. | ErrorResponse |
| 429 | Too many requests. | ErrorResponse |
| 503 | Organisations or boards are not set up on this server. | ErrorResponse |
Response body
A 200 answer has the type BoardAccess.
| Field | Type | Required | Description |
|---|---|---|---|
access | "org" | "restricted" | yes | |
orgRole | "view" | "edit" | yes | |
grants | BoardGrant[] | yes | |
grants[].kind | "user" | "group" | yes | |
grants[].id | string | yes | |
grants[].name | string | yes | A member's email address, or a group's name. |
grants[].role | "view" | "edit" | "manage" | yes | view: look; edit: change the tabs; manage: also change who may open the board. |
joinLinks | BoardJoinLink[] | yes | |
joinLinks[].id | string | yes | |
joinLinks[].role | "view" | "edit" | yes | |
joinLinks[].createdAt | integer | yes | |
joinLinks[].expiresAt | integer | yes | |
canManage | boolean | yes | |
guestLink | boolean | yes | True when anyone signed in with the link may watch the board, as the board chose. |
guests | "ok" | "off" | "confidential" | yes | Whether guests may open the board now: ok, or off when the owner does not allow guests on boards, or confidential for a Confidential board. Only ok lets a guest in. |
See also
| Doc | Why |
|---|---|
| API reference | Every endpoint, and the error envelope |
| Schemas | Every request and response type |
| Tool reference | The operations as callable tools |