POST
/
v1
/
public
/
accounts
/
{account_id}
/
auth
/
invitations
Create Account Invitation
curl --request POST \
  --url https://api.hybridbox.io/v1/public/accounts/{account_id}/auth/invitations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "assignments": [
    {
      "capability_key": "<string>",
      "group_id": "<string>",
      "resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "role_key": "<string>"
    }
  ],
  "email": "<string>",
  "locale": "<string>",
  "note": "<string>"
}
'
{
  "assignments": [
    {
      "assignment_kind": "<string>",
      "position": 123,
      "capability_key": "<string>",
      "grant_kind": "<string>",
      "group_id": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "resource_type": "<string>",
      "role_key": "<string>"
    }
  ],
  "email": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "permission_context": {
    "assigned_bundle_keys": [
      "<string>"
    ],
    "direct_capability_keys": [
      "<string>"
    ],
    "owner_assignments": [
      {
        "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ],
    "resolved_capability_keys": [
      "<string>"
    ],
    "status": "active",
    "subject_id": "",
    "subject_type": "unknown"
  },
  "status": "<string>",
  "accepted_at": "2023-11-07T05:31:56Z",
  "accepted_subject_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "note": "<string>"
}

Authorizations

​
Authorization
string
header
required

Public API bearer credential sent as Authorization: Bearer <token>. Use either an OAuth access token or a Hybridbox Service account token.

Path Parameters

​
account_id
string<uuid>
required

Body

application/json

Request schema for creating a new user invitation.

​
assignments
InvitationAssignmentRequest · object[]
required
Minimum array length: 1
​
email
string
required

Target email address

​
locale
string | null

Optional locale for transactional invitation email

​
note
string | null

Response

​
assignments
InvitationAssignmentResponse · object[]
required
​
email
string
required
​
id
string<uuid>
required
​
permission_context
PermissionInspectabilitySnapshot · object
required

Shared inspectability snapshot for user, group, and invitation management.

​
status
string
required
​
accepted_at
string<date-time> | null
​
accepted_subject_id
string | null
​
created_at
string<date-time> | null
​
expires_at
string<date-time> | null
​
note
string | null