invite-user¶
The invite-user command generates a command that another user may use to join your organization. That member can in turn invite additional people into the organization as needed.
Syntax¶
The basic syntax of the invite-user command is:
dwc invite-user <emailAddress>
The full syntax (excepting top level arguments) is:
dwc ... invite-user -h --non-admin --no-svc --verify <emailAddress>
More information about each argument can be found under arguments.
Expected Response¶
Successful calls will result in the following response:
Inviting <emailAddress> to <orgId>...``
Success! Send them:
dwc accept-invitation '<invitationCode>'
where <invitationCode> is an identifier generated by the Datawire Connect Cloud Tools CLI to verify that the user has the right to join the organization.
Common Error States¶
The most common error encountered with this call is that the user being invited is already registered with Datawire (possibly under a different organization). In this case, the user should contact Datawire at support.io.
Arguments¶
The following arguments are supported for the invite-user command:
- -h
- –non-admin
- –no-svc
- –verify
- <emailAddress>
-h¶
-h is described under general command arguments.
–non-admin¶
This option is internal and should not be used. In the future, it may be used to create users without administrative privileges, but at this time all users of an organization are expected to be admins.
–no-svc¶
Optional. Indicates that the invited user should not be able to create or use services within the organization.
Equivalent Options¶
The following arguments are equivalent to –no-svc:
- –no-reqsvc
- –no-request-services
Constraints and Usage Notes¶
If this option is specified, the user cannot create or use services within the organization.
–verify¶
–verify is described under general command arguments.
<emailAddress>¶
Required. Indicates an email address for the invited user.
Equivalent Options¶
This argument does not have a corresponding flag. It is determined by position within the command.
Constraints and Usage Notes¶
The email address must be the last argument supplied with the command.
Any valid email address may be used. The string must have the format a@b.c or it will be rejected.
Each email address may only be used once in the system. A user may not have multiple accounts or belong to multiple organizations.
At the current time Datawire does not send emails to the specified address. The output of this command should be sent to the new user so they can run the command and add themselves to your organization.