Manage the membership of group
POST/accessControlGroups/{accessControlGroupId}/membership
Base URL: https://api.tinkermode.com
Manage the relationship between the group and the principal.
The interface is non-RESTful. The request body must contain an action in the payload.
The caller must have update permissions on both the target access control group and the target principal.
Authentication
Send an Authorization header of the form ModeCloud <AUTH_CODE>.
Must contain a user, service account, or project API key with "Admin" privileges. A service account token cannot manage the membership of a service account principal.
Path parameters
| Name | Type | Required | Constraints | Description |
|---|---|---|---|---|
accessControlGroupId | integer | Yes | The unique ID for a specified access control group. |
Request body
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
action | string | Yes | add action adds the principal to the group.
remove action removes the principal from the group.
| |
principalId | string | Yes | The ID of the principal (a user ID or a service account ID). | |
principalType | string | Yes | The type of principal, either user or serviceAccount. |
Responses
200 Successfully updated the membership.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
action | string | No | ||
principalId | integer | No | ||
principalType | string | No |
401 Authorization is required to access this resource.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
403 Request failed because of invalid data or denied permission.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
429 Request failed because of rate limit.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
500 An unexpected error has occurred.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
503 The service is temporarily unavailable.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |