Create an access control group
POST/accessControlGroups
Base URL: https://api.tinkermode.com
Create an access control group. If the request is made by a user, the user must have permission to create access control group.
Authentication
Send an Authorization header of the form ModeCloud <AUTH_CODE>.
Must contain a user, service account, or project API key with "Admin" privileges.
Request body
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
description | string | Yes | The description of the group. | |
name | string | Yes | The display name of the group. | |
projectId | string | Yes | The project that this access control group belongs to. |
Responses
201 Successfully created a new access control group.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
description | string | Yes | Description of group. | |
id | integer | Yes | read-only (server-generated) | Unique ID assigned at time of creation. |
name | string | Yes | Display name of group. | |
projectId | integer | Yes | read-only (server-generated) | Project that this access control group belongs to. |
Response example
{
"description": "A group to access all devices in the project",
"id": 1,
"name": "Customer Support",
"projectId": 10
}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. |