.. _create_users_module:


create_users -- Upload Mainframe users to Bridge for Git for traceability of changes from Endevor to Bridge for Git
===================================================================================================================

.. contents::
   :local:
   :depth: 1


Synopsis
--------

Upload Mainframe users to Bridge for Git for traceability of changes from Endevor to Bridge for Git.

Before you upload mainframe users, ensure that the application.yml parameter “commit\-author” is set to “ENDEVOR\_USER”.







Parameters
----------

  connection (type: str)
    Endevor connection name.



  mainframe_user (type: str)
    Mainframe user name.



  git_user (type: str)
    Git user name.



  user_email (type: str)
    User role.



  csv_file (type: path)
    CSV file with users to import.



  protocol (*required*, type: str)
    Endevor Bridge for Git SCM protocol.

    Default: https.


    Choices:
      * ``http`` 
      * ``https`` 

  host (*required*, type: str)
    Endevor Bridge for Git hostname.



  port (*required*, type: int)
    Endevor Bridge for Git port.



  user (*required*, type: str)
    Endevor Bridge for Git username (your git username).



  token (*required*, type: str)
    Git personal access token (Obtain the token from your Git Enterprise Server).



  reject_unauthorized (type: bool, default: ``True``)
    Reject self\-signed certificates. Use false to connect to EBG servers with self\-signed certificates.



  ebg_base_path (type: str)
    The Endevor Bridge for Git Rest API base path.



  password (type: str)
    Password to authenticate to service on the mainframe.



  cert_file (type: path)
    The file path to a certificate file to use for authentication.

    Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe

    Docs.



  cert_key_file (type: path)
    The file path to a certificate key file to use for authentication.



  cert_account (type: str)
    The account name for PKCS 12 certificate stored in credential manager.



  _proxy (type: bool)
    Use current proxy setup.

    Variables https\_proxy, https\_proxy, HTTP\_PROXY, HTTPS\_PROXY will be used as is.










Examples
--------

.. code-block:: yaml+jinja

    
    - name: Upload a single mainframe user specifying both the Git and Endevor username, email, and corresponding Endevor connection
      broadcom.endevor_bridge_for_git.create_users:
        connection: endevor-connection-name
        mainframe_user: ENVUSERNAME
        git_user: GITUSERNAME
        user_email: NAME@EMAIL.NET

    - name: Bulk upload new mainframe users by importing a csv format file
      broadcom.endevor_bridge_for_git.create_users:
        connection: endevor-connection-name
        csv_file: mf-users.csv




Return Values
-------------

data (type: list, *when returned data is a dictionary*)
  Data from the module execution (a data structure). The items of this dict are set as individual return values on the top level as well.


error (type: complex, *error*)
  More details about why the action has failed. If the failure is when calling an API service, the response contains the connection parameters.


  additional_details (type: str)
    Detailed message about the failure.


  msg (type: str)
    Short description of the result or failure.


  request (type: str, *API request failed*)
    HTTP method used to invoke API service request.


  resource (type: str, *API request failed*)
    URI of the resource of the API service request.



failed (type: bool, *always*)
  A boolean that indicates if the task was failed or not.


list (type: list, *when returned data is a list*)
  Data from the module execution (a list of data structures).


msg (type: str, *sometimes*)
  Short description of the result or failure.


rc (type: int, *always*)
  Exit code of the module, successful exit code is 0, failure is typically 1 or higher.


stderr (type: str, *error*)
  Details of the error.


stdout (type: str, *success*)
  Summary of the result.





Status
------




- This module is maintained by Broadcom.