Create an Account

Create an Account

To register an account, do this:

  1. Select Account Registry in the "Teamworkx Connector" section in the app configuration.
    The "Accounts" dialog is displayed.

  2. Select Create Account to create a new account.
    The "Accounts" dialog is displayed.

  3. Enter the following information:

    1. Account ID: This will be generated automatically

    2. Jira User: Select the user that executes the sync jobs.

    3. Description: (optional) Some description of your choice to identify the account.

    4. Status: Set the account active or inactive. (Only active accounts can use the Teamworkx Connector API.)

    5. Host: Protocol and client host name. (i.e. https://your-company.com)

    6. Port: (optional) Port the client is listening to. Leave it empty if the client listens to port 80 (for http) or port 443 (for https)

    7. Path: (optional) Steady base path of the REST API of the client. For Jira this is /rest/cwx-sol-rest/latest/sol/.

    8. Username: Fill in username for using Basic Authentication. Leave empty for either not using any Authentication at all or configure Token Bearer Authentication (see Password field below).

       

    9. Password/Token: Fill in either the password when using Basic Authentication or a Token to be used in Token Bearer Authentication. Leave empty when not using any Authentication at all.

    10. Gateway URL: (optional) Gateway URL (If a gateway is provided the parameters host, port and path will be ignored.)

    11. Header Parameters: Add header parameters in key:value pairs (i.e. cwx-sol-account:<client account ID>). Fill in any header parameters, one per line. For example you could include a "Authorization: Bearer [...]" and/or a "cwx-sol-account: [...]" to communicate with another (or own) Jira + Teamworkx Connector.

       

    12. Test Path: (optional) A path to test the connection to the client host (GET only). In case of a Jira to Jira connection use "/test/account" or "/aob/object/list/linktypes" here.

  4. Click Save.