Accounts_users

The User resource

Represents a Scalr IAM user.

Key path	Description
type* (string) Available values: users
id (string)
attributes.created-at (string)
attributes.email* (string)
attributes.full-name (string)
attributes.last-login-at (string)
attributes.status (string) Available values: Active, Inactive, Pending
attributes.username (string)
relationships.identity-providers.data* (array)
relationships.teams.data* (array)
links.self (string)

List Account to User relationships

GET /api/iacp/v3/account-users

This endpoint returns a list of AccountUser resources by a mandatory user or account filter.

To get the list of accounts the user has access to, the filter[user] has to be specified. To get the list of users that have access to an account the filter[account] has to be specified.

Query Parameters

• filter[account] (string) – The account filter.

• filter[user] (string) – The user filter.

• query (string) – Query string

• exclude_global_users (string) – Do not include account users from global-scope. This is for self-hosted only.

• sort (array) – The comma-separated list of attributes. (Available values: created-at, email, full-name, last-login-at, status)

• include (array) – The comma-separated list of relationship paths. (Available values: account, teams, user)

Example Request:

GET /api/iacp/v3/account-users HTTP/1.1
Host: my.scalr.io
Prefer: profile=preview

Status Codes

• 200 OK –

  Success.

  Example Respone:

  HTTP/1.1 200 OK
  Content-Type: application/vnd.api+json
  Preference-Applied: profile=preview
  
  {
    "data": [
      {
        "attributes": {
          "status": "Pending"
        },
        "id": "2442bdc2-8243-6968-82bf-a74878980074",
        "links": {},
        "relationships": {
          "account": {
            "data": {
              "id": "acc-tmhltms60l40m9o",
              "type": "accounts"
            }
          },
          "teams": {
            "data": [
              {
                "id": "team-tmhlublsnv43mt8",
                "type": "teams"
              }
            ]
          },
          "user": {
            "data": {
              "id": "user-suh84u6vuvidtbg",
              "type": "users"
            }
          }
        },
        "type": "account-users"
      },
      {
        "attributes": {
          "status": "Active"
        },
        "id": "23651ae8-00e6-6c2c-f215-c3c026c9c721",
        "links": {},
        "relationships": {
          "account": {
            "data": {
              "id": "acc-svrcncgh453bi8g",
              "type": "accounts"
            }
          },
          "teams": {
            "data": [
              {
                "id": "team-t67mjtnokncjpd8",
                "type": "teams"
              }
            ]
          },
          "user": {
            "data": {
              "id": "user-suh84u6vuvidtbg",
              "type": "users"
            }
          }
        },
        "type": "account-users"
      }
    ],
    "included": null,
    "links": {
      "first": "https://my.scalr.io/api/iacp/v3/account-users?filter%5Buser%5D=user-suh84u6vuvidtbg&page%5Bnumber%5D=1&page%5Bsize%5D=3",
      "last": "https://my.scalr.io/api/iacp/v3/account-users?filter%5Buser%5D=user-suh84u6vuvidtbg&page%5Bnumber%5D=1&page%5Bsize%5D=3",
      "next": null,
      "prev": null,
      "self": "https://my.scalr.io/api/iacp/v3/account-users?filter%5Buser%5D=user-suh84u6vuvidtbg&page%5Bnumber%5D=1&page%5Bsize%5D=3"
    },
    "meta": {
      "pagination": {
        "current-page": 1,
        "next-page": null,
        "prev-page": null,
        "total-count": 2,
        "total-pages": 1
      }
    }
  }
  

• 403 Forbidden – User unauthorized to perform this action.

• 4XX – Client error.

• 5XX – Server error.