bird organization invitations create

Usage

代码示例

bird organization invitations create [flags]

Description

Create an org invitation

Invite an address to the organization with an org role, workspace roles, or both. At least one of the two must be supplied.

Build the request from flags, a JSON OrganizationInvitationCreate body via --body-file ("-" reads stdin), or both — a flag overrides the matching body field. Run --example to print a ready-to-edit body, or --dry-run to print the resolved request without sending it.

Examples

代码示例

# print the body shape (no credentials needed)
bird organization invitations create --example

# the body it prints:

代码示例

{
  "email": "bob@acme.com",
  "org_role": "billing_admin",
  "workspace_roles": [
    {
      "role": "admin",
      "workspace_id": "ws_01krdgeqcxet5s7t44vh8rt9mg"
    }
  ]
}

Options

Request

Name	Description
--body-file	Read the JSON request body from this file; "-" reads stdin
--example	Print a complete example request body, then exit
--dry-run	Print the resolved request without sending it, then exit
--idempotency-key	Deduplication key; a retry with the same key won't act twice

Options

Name	Description
--email	Email address to invite. Normalized to lowercase.
--org-role	Org-level role to assign on acceptance. Omit to invite with workspace roles only; at least one of org_role or workspace_roles must be provided. Possible values: billing_admin, owner.
--response-schema	Print the fields this command returns, then exit

Name	Description
bird organization invitations get	Get an org invitation
bird organization invitations list	List org invitations
bird organization invitations revoke	Revoke an org invitation