Accounts

The Account resource

API Resource for the account.

Key path

Description

type* (string)

Available values: accounts

id (string)

attributes.allowed-ips (array)

The list of allowed IP networks for IP fencing

attributes.comments (string)

attributes.created-at (string)

attributes.last-login-attempt-at (string)

attributes.login-attempts (integer)

attributes.name* (string)

The name of the account

attributes.quotas (object)

The list of account’s quotas

attributes.quotas.agents (integer)

The maximal number of agents

attributes.quotas.before-after-hooks-available (boolean)

Indicates if the before-after hooks are available for an account

attributes.quotas.cost-estimate-available (boolean)

Indicates if the cost estimation is available for an account

attributes.quotas.environments (integer)

The maximal number of environments

attributes.quotas.max-concurrent-runs (integer)

The maximal number of concurrent runs

attributes.quotas.policy-group-checks-available (boolean)

Indicates if the policy group checks are available for an account

attributes.quotas.policy-groups (integer)

The maximal number of policy groups

attributes.quotas.registry-modules (integer)

The maximal number of registry modules

attributes.quotas.registry-templates (integer)

The maximal number of registry templates

attributes.quotas.run-triggers (integer)

The maximal number of run triggers

attributes.quotas.service-accounts-available (boolean)

Indicates if the service accounts are available for an account

attributes.quotas.sso-available (boolean)

Indicates if the SSO is available for an account

attributes.quotas.users (integer)

The maximal number of users

attributes.quotas.vcs-providers (integer)

The maximal number of VCS providers

attributes.quotas.workspaces (integer)

The maximal number of workspaces

attributes.support-access-enabled (boolean)

If enabled, Scalr support stuff will be able to access the account for troubleshooting purposes.

relationships.billing-plan (object)

The billing plan of this account

relationships.billing-plan.data.type* (string)

Available values: billing-plans

relationships.billing-plan.data.id* (string)

relationships.identity-provider* (object)

The identity provider of this account

relationships.identity-provider.data.type* (string)

Available values: identity-providers

relationships.identity-provider.data.id* (string)

relationships.owner* (object)

The user that owns this account

relationships.owner.data.type* (string)

Available values: users

relationships.owner.data.id* (string)

links.self (string)

Get an Account

GET /api/iacp/v3/accounts/{account}

Show details of a specific account.

Parameters
  • account (string) – The ID of the account.

Query Parameters
  • include (array) – The comma-separated list of relationship paths. (Available values: billing-plan)

Example Request:

GET /api/iacp/v3/accounts/{account} HTTP/1.1
Host: my.scalr.io
Prefer: profile=preview
Status Codes
  • 200 OK – Success.

  • 404 Not Found – Account not found or user unauthorized to perform action.

  • 4XX – Client error.

  • 5XX – Server error.

Update Account

PATCH /api/iacp/v3/accounts/{account}
Parameters
  • account (string) – The ID of the account to update.

Request body:

Key path

Description

data.type* (string)

Available values: accounts

data.id (string)

data.attributes.allowed-ips (array)

The list of allowed IP networks for IP fencing

data.attributes.comments (string)

data.attributes.name* (string)

The name of the account

data.attributes.quotas (object)

The list of account’s quotas

data.attributes.quotas.agents (integer)

The maximal number of agents

data.attributes.quotas.before-after-hooks-available (boolean)

Indicates if the before-after hooks are available for an account

data.attributes.quotas.cost-estimate-available (boolean)

Indicates if the cost estimation is available for an account

data.attributes.quotas.environments (integer)

The maximal number of environments

data.attributes.quotas.max-concurrent-runs (integer)

The maximal number of concurrent runs

data.attributes.quotas.policy-group-checks-available (boolean)

Indicates if the policy group checks are available for an account

data.attributes.quotas.policy-groups (integer)

The maximal number of policy groups

data.attributes.quotas.registry-modules (integer)

The maximal number of registry modules

data.attributes.quotas.registry-templates (integer)

The maximal number of registry templates

data.attributes.quotas.run-triggers (integer)

The maximal number of run triggers

data.attributes.quotas.service-accounts-available (boolean)

Indicates if the service accounts are available for an account

data.attributes.quotas.sso-available (boolean)

Indicates if the SSO is available for an account

data.attributes.quotas.users (integer)

The maximal number of users

data.attributes.quotas.vcs-providers (integer)

The maximal number of VCS providers

data.attributes.quotas.workspaces (integer)

The maximal number of workspaces

data.attributes.support-access-enabled (boolean)

If enabled, Scalr support stuff will be able to access the account for troubleshooting purposes.

data.relationships.identity-provider* (object)

The identity provider of this account

data.relationships.identity-provider.data.type* (string)

Available values: identity-providers

data.relationships.identity-provider.data.id* (string)

data.relationships.owner* (object)

The user that owns this account

data.relationships.owner.data.type* (string)

Available values: users

data.relationships.owner.data.id* (string)

Example Request:

PATCH /api/iacp/v3/accounts/{account} HTTP/1.1
Host: my.scalr.io
Content-Type: application/vnd.api+json
Prefer: profile=preview

{
    "data": {
        "attributes": {
            "allowed-ips": [
                "string"
            ],
            "comments": "string",
            "name": "string",
            "quotas": {
                "agents": 1,
                "before-after-hooks-available": true,
                "cost-estimate-available": true,
                "environments": 1,
                "max-concurrent-runs": 1,
                "policy-group-checks-available": true,
                "policy-groups": 1,
                "registry-modules": 1,
                "registry-templates": 1,
                "run-triggers": 1,
                "service-accounts-available": true,
                "sso-available": true,
                "users": 1,
                "vcs-providers": 1,
                "workspaces": 1
            },
            "support-access-enabled": true
        },
        "id": "string",
        "relationships": {
            "identity-provider": {
                "data": {
                    "id": "string",
                    "type": "identity-providers"
                }
            },
            "owner": {
                "data": {
                    "id": "string",
                    "type": "users"
                }
            }
        },
        "type": "accounts"
    }
}
Status Codes
  • 200 OK – Successfully updated the account.

  • 404 Not Found – Account or relationship not found, or user unauthorized to perform action.

  • 422 Unprocessable Entity – Invalid arguments.

  • 4XX – Client error.

  • 5XX – Server error.