Permissions data models
getPermissions — 200 response
Successful retrieval of list of permissions.
Represents a permission statement that defines resource access policy.
An array of objects with the following shape:
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
actions | array<string> | Yes | Allowed/denied actions | |
effect | string | Yes | one of: allow, deny | Access policy |
id | integer | Yes | read-only (server-generated) | Unique ID assigned at time of creation. |
principalId | integer | Yes | read-only (server-generated) | Principal ID such as a user ID or service account ID |
principalType | string | Yes | read-only (server-generated); one of: user, accessControlGroup, serviceAccount | Principal type |
projectId | integer | Yes | read-only (server-generated) | Project that this permission belongs to. |
resourceIdentifier | string | Yes | Resource ID (e.g., user ID, entity ID). * represents all for supported resource types; for entity, use root instead of *. | |
resourceScope | string | No | one of: self, selfWithDescendants | Resource scope. Only Entity supports resource scope. |
resourceType | string | Yes | read-only (server-generated); one of: all, accessControlGroup, user, home, entity, entityClass, device, alertRule, alertSchedule, projectLog, projectAlert, projectFile, dataFilter, assistant, projectBizstackApp | Resource type |
statementType | string | Yes | read-only (server-generated); one of: principalBased | Statement type |
subResources | array<object> | No | Array of sub-resource permissions |
getPermissions — 401 response
Authorization is required to access this resource.
| 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. |
getPermissions — 403 response
Request failed because of denied permission.
| 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. |
getPermissions — 429 response
Request failed because of rate limit.
| 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. |
getPermissions — 500 response
An unexpected error has occurred.
| 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. |
getPermissions — 503 response
The service is temporarily unavailable.
| 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. |
createPermission — request
Request body for Create a permission.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
actions | array<string> | Yes | Allowed/denied actions | |
effect | string | Yes | one of: allow, deny | Access policy |
id | integer | Yes | read-only (server-generated) | Unique ID assigned at time of creation. |
principalId | integer | Yes | read-only (server-generated) | Principal ID such as a user ID or service account ID |
principalType | string | Yes | read-only (server-generated); one of: user, accessControlGroup, serviceAccount | Principal type |
projectId | integer | Yes | read-only (server-generated) | Project that this permission belongs to. |
resourceIdentifier | string | Yes | Resource ID (e.g., user ID, entity ID). * represents all for supported resource types; for entity, use root instead of *. | |
resourceScope | string | No | one of: self, selfWithDescendants | Resource scope. Only Entity supports resource scope. |
resourceType | string | Yes | read-only (server-generated); one of: all, accessControlGroup, user, home, entity, entityClass, device, alertRule, alertSchedule, projectLog, projectAlert, projectFile, dataFilter, assistant, projectBizstackApp | Resource type |
statementType | string | Yes | read-only (server-generated); one of: principalBased | Statement type |
subResources | array<object> | No | Array of sub-resource permissions |
createPermission — 201 response
Successfully created a new permission.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
actions | array<string> | Yes | Allowed/denied actions | |
effect | string | Yes | one of: allow, deny | Access policy |
id | integer | Yes | read-only (server-generated) | Unique ID assigned at time of creation. |
principalId | integer | Yes | read-only (server-generated) | Principal ID such as a user ID or service account ID |
principalType | string | Yes | read-only (server-generated); one of: user, accessControlGroup, serviceAccount | Principal type |
projectId | integer | Yes | read-only (server-generated) | Project that this permission belongs to. |
resourceIdentifier | string | Yes | Resource ID (e.g., user ID, entity ID). * represents all for supported resource types; for entity, use root instead of *. | |
resourceScope | string | No | one of: self, selfWithDescendants | Resource scope. Only Entity supports resource scope. |
resourceType | string | Yes | read-only (server-generated); one of: all, accessControlGroup, user, home, entity, entityClass, device, alertRule, alertSchedule, projectLog, projectAlert, projectFile, dataFilter, assistant, projectBizstackApp | Resource type |
statementType | string | Yes | read-only (server-generated); one of: principalBased | Statement type |
subResources | array<object> | No | Array of sub-resource permissions |
createPermission — 401 response
Authorization is required to access this resource.
| 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. |
createPermission — 403 response
Request failed because of invalid data or denied permission.
| 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. |
createPermission — 429 response
Request failed because of rate limit.
| 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. |
createPermission — 500 response
An unexpected error has occurred.
| 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. |
createPermission — 503 response
The service is temporarily unavailable.
| 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. |
deletePermission — 401 response
Authorization is required to access this resource.
| 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. |
deletePermission — 403 response
Request failed because of invalid data or denied permission.
| 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. |
deletePermission — 404 response
The required permission does not exist or is not accessible.
| 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. |
deletePermission — 409 response
The permission cannot be deleted because it is being used by another part of the system.
| 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. |
deletePermission — 429 response
Request failed because of rate limit.
| 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. |
deletePermission — 500 response
An unexpected error has occurred.
| 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. |
deletePermission — 503 response
The service is temporarily unavailable.
| 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. |
getPermission — 200 response
Successfully retrieved permission with specified ID.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
actions | array<string> | Yes | Allowed/denied actions | |
effect | string | Yes | one of: allow, deny | Access policy |
id | integer | Yes | read-only (server-generated) | Unique ID assigned at time of creation. |
principalId | integer | Yes | read-only (server-generated) | Principal ID such as a user ID or service account ID |
principalType | string | Yes | read-only (server-generated); one of: user, accessControlGroup, serviceAccount | Principal type |
projectId | integer | Yes | read-only (server-generated) | Project that this permission belongs to. |
resourceIdentifier | string | Yes | Resource ID (e.g., user ID, entity ID). * represents all for supported resource types; for entity, use root instead of *. | |
resourceScope | string | No | one of: self, selfWithDescendants | Resource scope. Only Entity supports resource scope. |
resourceType | string | Yes | read-only (server-generated); one of: all, accessControlGroup, user, home, entity, entityClass, device, alertRule, alertSchedule, projectLog, projectAlert, projectFile, dataFilter, assistant, projectBizstackApp | Resource type |
statementType | string | Yes | read-only (server-generated); one of: principalBased | Statement type |
subResources | array<object> | No | Array of sub-resource permissions |
getPermission — 401 response
Authorization is required to access this resource.
| 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. |
getPermission — 403 response
Request failed because of denied permission.
| 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. |
getPermission — 404 response
The requested permission does not exist or is not accessible.
| 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. |
getPermission — 429 response
Request failed because of rate limit.
| 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. |
getPermission — 500 response
An unexpected error has occurred.
| 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. |
getPermission — 503 response
The service is temporarily unavailable.
| 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. |
updatePermission — request
Request body for Update a permission.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
actions | string | No | The new actions. | |
effect | string | No | The new policy. | |
resourceIdentifier | string | No | The new resource identifier. Changing this requires managePermissions on both the old and new target resource. | |
resourceScope | string | No | The new resource scope. Only applicable to Entity type resources. | |
subResources | string | No | The new sub-resource policies. |
updatePermission — 401 response
Authorization is required to access this resource.
| 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. |
updatePermission — 403 response
Request failed because of invalid data or denied permission.
| 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. |
updatePermission — 404 response
The requested permission does not exist or is not accessible.
| 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. |
updatePermission — 429 response
Request failed because of rate limit.
| 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. |
updatePermission — 500 response
An unexpected error has occurred.
| 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. |
updatePermission — 503 response
The service is temporarily unavailable.
| 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. |