blossom organization:invitation:create

cli reference 1 min read

Invite a member

Usage

blossom organization:invitation:create [--data DATA]

Flags

Flag	Description
`--data, -d`	YAML or JSON invitation data, a path to a data file, or an HTTP(S) URL

Examples:

blossom organization:invitation:init
blossom organization:invitation:create --data invitation.yml

Invites someone to join the current organization with Account access.

Use organization:invitation:init to create a starter invitation.yml file. Edit the file, then create the invitation with --data.

Organization admins have access to every Account in the organization, so admin invitations do not need Account access fields.

all-Account invitation.yml:

invitation:
  name: Kenny Lee
  email: kenny@example.com
  role: member
  account_access: all
  permission_set_id: permission_set-100

selected-Account invitation.yml:

invitation:
  name: Kenny Lee
  email: kenny@example.com
  role: member
  account_access: selected
  invitation_account_grants_attributes:
    - account_id: account-development
      account_role: admin
    - account_id: account-production
      account_role: member
      permission_set_id: read_only

permission_set_id accepts built-in Permission Set ids such as full_access and read_only, or a custom Permission Set id such as permission_set-100.