Role object
Example JSON representation
{
"builtinAutomation": [
"base"
],
"category": {
"id": 1
},
"deprecated": {
"deprecated": "2013-01-01T12:34:56.789Z",
"replacement": {
"id": 1
}
},
"description": "string",
"id": 1,
"name": "string",
"os": {
"id": "string"
},
"quickStart": true,
"quickStartGroup": "string",
"scope": "scalr",
"tags": [
"string"
],
"useScalrAgent": true
}
Properties
property | attributes | valid values | description | filter option |
---|---|---|---|---|
category RoleCategoryForeignKey object |
required filterable |
Pass the id of the object you are referencing in: ?category=... |
||
name string |
required filterable |
The name of the Role. |
?name=... | |
os OsForeignKey object |
required create-only filterable |
Pass the id of the object you are referencing in: ?os=... |
||
deprecated RoleDeprecatedOptions object |
read-only |
The deprecation options associated with this Role. |
||
id integer |
read-only filterable |
?id=... | ||
scope string |
read-only filterable |
"scalr" "account" "environment" "farm" "farmrole" "role" "server" |
?scope=... | |
builtinAutomation Array of string |
create-only filterable |
?builtinAutomation=... | ||
description string |
optional |
|||
quickStart boolean |
optional filterable |
Whether this Role is a QuickStart Role. |
?quickStart=... | |
quickStartGroup string |
optional filterable |
The name of the QuickStart Group. |
?quickStartGroup=... | |
tags Array of string |
optional |
The list of tags that should be applied to the Role. |
||
useScalrAgent boolean |
create-only filterable |
Whether this Role uses Scalarizr, the Scalr agent. |
?useScalrAgent=... |
Endpoints using this object
- Account / Roles: Delete
- Account / Roles: Get
- Account / Roles: Edit
- Account / Roles / Actions: Clone
- Account / Roles / Actions: Deprecate
- Account / Roles / Global Variables: List
- Account / Roles / Global Variables: Create
- Account / Roles / Global Variables: Delete
- Account / Roles / Global Variables: Get
- Account / Roles / Global Variables: Edit
- Account / Roles / Images: List
- Account / Roles / Images: Create
- Account / Roles / Images: Delete
- Account / Roles / Images: Get
- Account / Roles / Images / Actions: Replace
- Account / Roles / Orchestration Rules: List
- Account / Roles / Orchestration Rules: Create
- Account / Roles / Orchestration Rules: Delete
- Account / Roles / Orchestration Rules: Get
- Account / Roles / Orchestration Rules: Edit
- Global / Roles: List
- Global / Roles: Create
- Global / Roles: Delete
- Global / Roles: Get
- Global / Roles: Edit
- Global / Roles / Actions: Deprecate
- Global / Roles / Global Variables: List
- Global / Roles / Global Variables: Create
- Global / Roles / Global Variables: Delete
- Global / Roles / Global Variables: Get
- Global / Roles / Global Variables: Edit
- Global / Roles / Images: List
- Global / Roles / Images: Create
- Global / Roles / Images: Delete
- Global / Roles / Images: Get
- Global / Roles / Images / Actions: Replace
- Global / Roles / Orchestration Rules: List
- Global / Roles / Orchestration Rules: Create
- Global / Roles / Orchestration Rules: Delete
- Global / Roles / Orchestration Rules: Get
- Global / Roles / Orchestration Rules: Edit
- User / Roles: List
- User / Roles: Create
- User / Roles: Delete
- User / Roles: Get
- User / Roles: Edit
- User / Roles / Actions: Clone
- User / Roles / Actions: Deprecate
- User / Roles / Actions: Promote
- User / Roles / Global Variables: List
- User / Roles / Global Variables: Create
- User / Roles / Global Variables: Delete
- User / Roles / Global Variables: Get
- User / Roles / Global Variables: Edit
- User / Roles / Images: List
- User / Roles / Images: Create
- User / Roles / Images: Delete
- User / Roles / Images: Get
- User / Roles / Images / Actions: Replace
- User / Roles / Orchestration Rules: List
- User / Roles / Orchestration Rules: Create
- User / Roles / Orchestration Rules: Delete
- User / Roles / Orchestration Rules: Get
- User / Roles / Orchestration Rules: Edit