AccountRole object

Reference

AccountRole is used when a reference to an object of type Role is expected. Note that you can pass a complete Role object as well.

Example JSON representation

{
  "allowedEnvironments": [
    {
      "id": 1
    }
  ],
  "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",
  "restrictedAccess": true,
  "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
 ?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=...
allowedEnvironments
Array of EnvironmentForeignKey objects 		optional

List of allowed Environments accessible to this Role.
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=...
restrictedAccess
boolean 		optional
filterable

It restricts access to the Role except of allowed Environments.

 ?restrictedAccess=...
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