<commit_before>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:

``{{{cli_command}}} invite-user <emailAddress>``

The full syntax (excepting :doc:`top level arguments<topLevel>`) is:

``{{{cli_command}}} ... invite-user -h --non-admin --no-svc --verify <emailAddress>``

More information about each argument can be found under :ref:`arguments <inviteUserArguments>`.

Expected Response
+++++++++++++++++

Successful calls will result in the following response:

.. code-block:: none

   Inviting <emailAddress> to <orgId>...``
   Success! Send them:
   
   dwc accept-invitation '<invitationCode>'

where <invitationCode> is an identifier generated by the {{{cli_product}}} 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 {{{company}}} (possibly under a different organization). In this case, the user should contact {{{company}}} at {{{support_address}}}.

..    
   JMK: Are we adding expiration dates? it was mentioned as a TODO previously

.. _inviteUserArguments:

Arguments
+++++++++

The following arguments are supported for the invite-user command:

* -h
* --non-admin
* --no-svc
* --verify
* <emailAddress>

-h
&&

-h is described under :ref:`general command arguments <generalH>`.

.. _inviteUserNonAdmin:

--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.

.. _inviteUserNoService:

--no-svc
&&&&&&&&

Optional. Indicates that the invited user should not be able to create 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 services within the organization.

.. 
   JMK what can they do? currently users cannot see services they did not create 
   let alone get tokens for them, although I think they should be able to see and get 
   tokens for all services within their organization.

--verify
&&&&&&&&

--verify is described under :ref:`general command arguments <generalVerify>`.

.. _inviteUserEmail:

<emailAddress>
&&&&&&&&&&&&&&

Required. Indicates an email address for the invited user.
<commit_msg>Fix Issue #2, description of --no-svc option<commit_after>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:

``{{{cli_command}}} invite-user <emailAddress>``

The full syntax (excepting :doc:`top level arguments<topLevel>`) is:

``{{{cli_command}}} ... invite-user -h --non-admin --no-svc --verify <emailAddress>``

More information about each argument can be found under :ref:`arguments <inviteUserArguments>`.

Expected Response
+++++++++++++++++

Successful calls will result in the following response:

.. code-block:: none

   Inviting <emailAddress> to <orgId>...``
   Success! Send them:
   
   dwc accept-invitation '<invitationCode>'

where <invitationCode> is an identifier generated by the {{{cli_product}}} 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 {{{company}}} (possibly under a different organization). In this case, the user should contact {{{company}}} at {{{support_address}}}.

..    
   JMK: Are we adding expiration dates? it was mentioned as a TODO previously

.. _inviteUserArguments:

Arguments
+++++++++

The following arguments are supported for the invite-user command:

* -h
* --non-admin
* --no-svc
* --verify
* <emailAddress>

-h
&&

-h is described under :ref:`general command arguments <generalH>`.

.. _inviteUserNonAdmin:

--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.

.. _inviteUserNoService:

--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.

.. 
   JMK what can they do? currently users cannot see services they did not create 
   let alone get tokens for them, although I think they should be able to see and get 
   tokens for all services within their organization.

--verify
&&&&&&&&

--verify is described under :ref:`general command arguments <generalVerify>`.

.. _inviteUserEmail:

<emailAddress>
&&&&&&&&&&&&&&

Required. Indicates an email address for the invited user.

{'fraction_non_alphanumeric': 0.13135748261983168, 'fraction_numerical': 0.00018294914013904133, 'mean_word_length': 4.302618816682832, 'pattern_counts': {'":': 0, '<': 27, '<?xml version=': 0, '>': 27, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2607156', 'n_tokens_mistral': 1482, 'n_tokens_neox': 1445, 'n_words': 670}