Skip to main content Link Menu Expand (external link) Document Search Copy Copied
Auth0 CLI

auth0 orgs invitations create

Create a new invitation to an organization with required and optional parameters.

To create interactively, use auth0 orgs invs create with no flags and answer the prompts.

To create non-interactively, supply the organization id and the other parameters through flags.

Usage 

auth0 orgs invitations create [flags]

Examples 

  auth0 orgs invs create
  auth0 orgs invs create --org-id <org-id>
  auth0 orgs invs create --org-id <org-id> --inviter-name "Inviter Name" --invitee-email "invitee@example.com"
  auth0 orgs invs create --org-id <org-id> --invitee-email "invitee@example.com" --client-id "client_id"
  auth0 orgs invs create --org-id <org-id> -n "Inviter Name" -e "invitee@example.com" --client-id "client_id" --connection-id "connection_id" -t 86400
  auth0 orgs invs create --org-id <org-id> --json --send-email=false --inviter-name "Inviter Name"

Flags 

  -a, --app-metadata string    Data related to the user that affects the application's core functionality, formatted as JSON
      --client-id string       Auth0 client ID. Used to resolve the application's login initiation endpoint.
      --connection-id string   The id of the connection to force invitee to authenticate with.
  -e, --invitee-email string   Email address of the person being invited.
  -n, --inviter-name string    Name of the person sending the invitation.
      --json                   Output in json format.
      --json-compact           Output in compact json format.
      --org-id string          ID of the organization.
  -r, --roles strings          Roles IDs to associate with the user.
  -s, --send-email             Whether to send the invitation email to the invitee. (default true)
  -t, --ttl-sec int            Number of seconds for which the invitation is valid before expiration.
  -u, --user-metadata string   Data related to the user that does not affect the application's core functionality, formatted as JSON

Inherited Flags 

      --debug           Enable debug mode.
      --no-color        Disable colors.
      --no-input        Disable interactivity.
      --tenant string   Specific tenant to use.