members
Open an operation to see its authentication, its parameters and the fields of its request and response.
3 operations
GET/v1/members
Members of the organization (a reviewer: the colleagues of their workspaces).
/v1/membersAuthentication: Dashboard session
Response 200
| Name | Type | Description |
|---|---|---|
itemsrequired | array of object | |
items[].idrequired | string | |
items[].org_idrequired | string | |
items[].emailrequired | string (email) | |
items[].namerequired | string | |
items[].rolerequired | enum | Values owner | admin | reviewer | client_viewer |
items[].workspace_idsrequired | array of string | |
items[].email_verified_atrequired | string (date-time) | |
items[].github_loginrequired | string | |
items[].localerequired | enum | Values en | it |
items[].last_login_atrequired | string (date-time) | |
items[].disabled_atrequired | string (date-time) | |
items[].created_atrequired | string (date-time) | |
items[].updated_atrequired | string (date-time) |
PATCH/v1/members/{id}
Changes the role or the workspaces of a member (owner, admin).
/v1/members/{id}Authentication: Dashboard session
Parameters
| Name | Type | Description |
|---|---|---|
idpathrequired | string |
Request body
| Name | Type | Description |
|---|---|---|
role | enum | Values owner | admin | reviewer | client_viewer |
workspace_ids | array of string |
Response 200
| Name | Type | Description |
|---|---|---|
idrequired | string | |
org_idrequired | string | |
emailrequired | string (email) | |
namerequired | string | |
rolerequired | enum | Values owner | admin | reviewer | client_viewer |
workspace_idsrequired | array of string | |
email_verified_atrequired | string (date-time) | |
github_loginrequired | string | |
localerequired | enum | Values en | it |
last_login_atrequired | string (date-time) | |
disabled_atrequired | string (date-time) | |
created_atrequired | string (date-time) | |
updated_atrequired | string (date-time) |
DELETE/v1/members/{id}
Removes a member (owner, admin); the last owner cannot be removed.
/v1/members/{id}Authentication: Dashboard session
Parameters
| Name | Type | Description |
|---|---|---|
idpathrequired | string |
Response 200
| Name | Type | Description |
|---|---|---|
okrequired | true |