Organization Members
3 operations.
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/v1/organizations/{organizationIdOrSlug}/members | List members of the current organization |
| PATCH | /api/v1/organizations/{organizationIdOrSlug}/members/{userId} | Update a member's organization role |
| DELETE | /api/v1/organizations/{organizationIdOrSlug}/members/{userId} | Remove a member from the current organization |
List members of the current organization
GET/api/v1/organizations/{organizationIdOrSlug}/members
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| organizationIdOrSlug | string | required | Identifies the organization by its stable identifier or slug. Applies to List members of the current organization. |
query
| Name | Type | Required | Description |
|---|---|---|---|
| limit | integer | optional | Sets the maximum number of resources returned in this page. Applies to List members of the current organization. |
| cursor | string | optional | Opaque cursor returned by the previous page; omit it to read the first page. Applies to List members of the current organization. |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
Update a member's organization role
PATCH/api/v1/organizations/{organizationIdOrSlug}/members/{userId}
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| organizationIdOrSlug | string | required | Identifies the organization by its stable identifier or slug. Applies to Update a member's organization role. |
| userId | string | required | Identifies the user whose membership or grant is being addressed. Applies to Update a member's organization role. |
Request body
required — Request body for: Update a member's organization role.
application/json
| Name | Type | Required | Description |
|---|---|---|---|
| role | "owner" | "admin" | "member" | required |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
Remove a member from the current organization
DELETE/api/v1/organizations/{organizationIdOrSlug}/members/{userId}
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| organizationIdOrSlug | string | required | Identifies the organization by its stable identifier or slug. Applies to Remove a member from the current organization. |
| userId | string | required | Identifies the user whose membership or grant is being addressed. Applies to Remove a member from the current organization. |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|