isInvitableUser

Verifies whether a user account is eligible to receive a UserInvitation (is an unmanaged account).

Synopsis

Eligibility is based on the following criteria:

• the email address is a consumer account and it’s the primary email address of the account, and
• the domain of the email address matches an existing verified Google Workspace or Cloud Identity domain If both conditions are met, the user is eligible. Implements the API documented at https://cloud.google.com/identity/docs/reference/rest/v1/customers.userinvitations/isInvitableUser

gsm userInvitations isInvitableUser [flags]

Options

  -h, --help          help for isInvitableUser
      --name string   UserInvitation name in the format customers/{customer}/userinvitations/{user_email_address}

Options inherited from parent commands

      --compressOutput         By default, GSM outputs "pretty" (indented) objects. By setting this flag, GSM's output will be compressed. This may or may not improve performance in scripts.
      --config string          config file (default is $HOME/.config/gsm/.gsm.yaml)
      --delay int              This delay (plus a random jitter between 0 and 50) will be applied after every command to avoid reaching quota and rate limits. Set to 0 to disable.
      --dwdSubject string      Specify a subject used for DWD impersonation (overrides value in config file)
      --log string             Set the path of the log file. Default is either ~/gsm.log or defined in your config file
      --maxElapsedTime int     This is the maximum total time that will be spent retrying a request in minutes. (default 15)
      --maxRetryInterval int   This is the maximum interval that will be used between retry attempts in seconds. (default 320)
      --redirectPort int       This is the TCP port on which GSM will create web server if you authenticate with a user account for the first time. This is necessary for the OAuth flow. See https://developers.google.com/identity/protocols/oauth2/native-app#redirect-uri_loopback (default 8081)
      --retryOn ints           Specify the HTTP error code(s) that GSM should retry on. Note that GSM will always retry on HTTP 403 errors that indicate a quota / rate limit error
      --streamOutput           Setting this flag will cause GSM to output slice values to stdout one by one, instead of one large object

SEE ALSO

• gsm userInvitations - Manage user invitations for unmanaged accounts (Part of Cloud Identity Beta API)
• gsm userInvitations isInvitableUser batch - Batch checks if users are invitable using a CSV file as input.