Create a new account invitation.

Invite a user to the account with the ability to grant access to one or many zones.

SecuritybearerAuth
Request
path Parameters
accountId
required
string <uuid>

Account ID to list invitations for.

Request Body schema: application/json
email
required
string
account_rbac_role
required
string
Enum: "global-admin" "non-global-admin"
Array of objects
Array
zone_id
required
string <uuid>

The ID of the zone to grant access to.

rbac_role
required
string (zoneRbacRole)

RBAC role assigned to a zone for a user.

Enum: "zone-admin" "billing-admin" "read-only" "zone-operator" "patch-operator" "helpdesk-operator"
Responses
201

Successful Operation

400

Bad Request

401

Access token is missing or invalid

403

You do not have permission to perform this action.

404

Entity not found

409

Bad Request

429

Too many requests

post/accounts/{accountId}/invitations
Request samples
application/json
{
  • "email": "john.doe@example.com",
  • "account_rbac_role": "global-admin",
  • "zone_assignments": [
    • {
      • "zone_id": "3a55518d-2488-6f4e-55fb-a40fc120cd12",
      • "rbac_role": "zone-admin"
      },
    • {
      • "zone_id": "470b44ab-f667-b9bb-fcab-d8faf8696b24",
      • "rbac_role": "zone-admin"
      }
    ]
}
Response samples
application/json
[
  • {
    • "id": "a75c3a2f-9c02-0479-8472-a17a25228fc5",
    • "account_id": "c0faadbe-7246-24e6-5daa-9861d44b3660",
    • "account_rbac_role": "global-admin",
    • "inviter": {
      • "id": 97149829,
      • "uuid": "e15021df-8122-c87c-4180-79084cba5a62",
      • "email": "jane.doe@example.com",
      • "first_name": "Jane",
      • "last_name": "Doe",
      • "status": "active",
      • "account_rbac_role": "global-admin",
      • "is_verified": true,
      • "two_factor_authentication": "email",
      • "created_at": "2021-08-02T22:33:30.281Z"
      },
    • "email": "john.doe@example.com",
    • "zones": [
      • {
        • "id": "3a55518d-2488-6f4e-55fb-a40fc120cd12",
        • "rbac_role": "zone-admin"
        },
      • {
        • "id": "470b44ab-f667-b9bb-fcab-d8faf8696b24",
        • "rbac_role": "zone-admin"
        }
      ],
    • "created_at": "2021-03-04T23:57:24.953Z"
    }
]