Accounts type

Summary of key details for the configuration type

About the accounts.yaml file

You can specify account details within fields in a configuration panel in the App Connect Dashboard, or you can specify them as key/value pairs in a file named accounts.yaml, which you can import into the configuration panel.

If you want to specify account details within an accounts.yaml file for import, you can create this file as follows:

1. In a text editor, specify account details for one or more applications that local connectors can run operations on. For details of the supported local connectors, see Exporting an API flow to a BAR file.
   
   The following guidelines apply:

   • The first line of the file must start with the text accounts: followed by account details for each unique application (or connector) and account combination that is used in the flow.
   • An entry for an application (or connector) starts with its predefined name, followed by an authorization type, account name, credentials, and an endpoint.
     • The application (or connector) name is always mandatory.
     • An authorization type (identified by an authType parameter) is needed to define the mechanism that is used for user authorization. If only one authorization type is applicable, the authType value can be omitted because the default is automatically used. If more than one authorization type is applicable, specify the authType value in upper snake case format (UPPER_SNAKE_CASE) instead of camel case format (camelCase). Camel case formats of authType values in older accounts.yaml files are automatically converted to upper snake case as part of account creation.
       • See the following table for examples

         Upper snake case format examples of the authType value	Older camel case formats of the authType value
         BASIC	basic
         BASIC_OAUTH	basicOauth
         BASIC_API_KEY	basicApiKey
         BASIC_IAM	basicIam
         BASIC_NTLMv1	basicNtlMv1
         BASIC_PLAINTEXT	basicPlaintext
         BASIC_SAML	basicSaml
         BASIC_SSL	basicSsl
         BASIC_SASL_PLAINTEXT	basicSaslPlaintext
         BASIC_SASL_SSL	basicSaslSsl
         OAUTH2_PASSWORD	oauth2Password
         OAUTH2_CREDENTIALS	oauth2Credentials
         OAUTH1_WEB	oauth1web
         OAUTH2_WEB	oauth2web
         NO_AUTH	noAuth

     • The account name (identified by a name parameter) is always mandatory, and it must be identical to the account name that is used in the flow that was exported from the authoring environment.
     • The need for credentials or an endpoint depends on the connector. Where needed, account parameters for credentials or an endpoint are specified as key and value pairs, with predefined key names; for example:
       username: janedoe
endpointUrl: 'https://mydomain.atlassian.net'
     • A value must be specified for each key and value pair that is identified as Required.
     • The key-and-value entry for an optional parameter can be omitted unless you specifically want to set a value.

     The following example shows the format to use when parameters need to be specified for an authorization type, credentials, and an endpoint.

       connectorName:
         - authType: authValue
           name: accountName
           credentials:
             parameterName1: value1
             parameterName2: value2
             ...
             parameterNameN: valueN
           endpoint:
             parameterURLName: 'URLvalue'

     The following example shows the format to use when parameters need to be specified for credentials, but not for an endpoint, and only one authorization type is supported (and therefore omitted).

       connectorName:
         - name: accountName
           credentials:
             parameterName1: value1
             parameterName2: value2
             ...
             parameterNameN: valueN
           endpoint: {}

     The following example shows the format to use when no parameters need to be specified for credentials or an endpoint, and only one authorization type is supported (and therefore omitted).

       connectorName:
         - name: accountName
           credentials: {}
           endpoint: {}

   • The file must contain valid YAML. Tab characters are not permitted, and must be replaced with spaces if used. You might find it helpful to use a YAML validation tool to check the content.

   The following example shows a file that defines account details that the HTTP and Salesforce local connectors can use to establish a connection and interact with an HTTP endpoint and a Salesforce instance. The HTTP endpoint requires no authentication, so only an account name needs to be specified.

   accounts:
     http:
       - name: Account 1
         credentials: {}
         endpoint: {}
     salesforce:
       - name: Account 1
         credentials:
           username: janedoe@abc.com
           password: myPasswordMyToken
           clientIdentity: XXXXXX
           clientSecret: 1234567890
         endpoint:
           loginUrl: 'https://eu11.salesforce.com'

   
   The attached sample-accounts.yaml_.zip file contains a YAML file with sample account details for each application (or connector). You can copy the contents of the YAML file into your text file and then edit it to define the connections that you require.

   Additional references:

   • For help with completing the account details for each application, see the Defining account details section.
   • To review the schema that the accounts.yaml file needs to adhere to, see the attached schema.yml_.zip file, which is in YAML format.
2. Save the completed file as accounts.yaml and then close it.

For examples of how to use this configuration type, see Tutorials and examples.

Creating a configuration for the Accounts type by using the configuration panel

You can create an Accounts-type configuration while creating an integration server or integration runtime, or independently, as follows:

1. Open the Configuration page by clicking the Configuration icon in the navigation pane, or go to the Configuration view of an integration server or integration runtime that you are creating. Then, click Create configuration. For more information, see Managing configuration objects from the Configuration page.
2. From the Create configuration panel, ensure that Accounts is selected from the Type list.
3. In the Name field, specify a name for this configuration.
4. In the Description field, specify text that might help you identify the integration server or integration runtime for which accounts are configured, or the application names or target instances that the accounts relate to.
   
5. In the Accounts section, add account details for one or more local connectors either by completing the Account details fields, or by importing an accounts.yaml file:
   • To use the Account details fields, complete the following steps:
     1. From the Application list, select an application and then specify a name for the account, connection credentials, and an endpoint (if required). For information about completing these fields for each application, see the Defining account details links at the bottom of this topic.
        
     2. If this is the only account that you want to create for this configuration, click Create. Otherwise, click Add account to add a second account. A new Account details group box is added at the bottom of the fields you just completed.
        
     3. For each additional account that you want to add, selection the application, complete the fields and click Add account.
        Tip: You can view the YAML format for the accounts that you added by clicking the Code button. For security reasons, account details will be available only in REDACTED format after you create the configuration. In case you need to update these details later (for example, due to a password change), copy and save the YAML code to an accounts.yaml file, as a backup. If required, you can then overwrite the outdated account details by updating the accounts.yaml file before importing it to replace the existing configuration.

        
   • Import a valid accounts.yaml file from your file system:
     1. To add the file as an Accounts-type configuration, click the Import accounts file icon.
        
     2. Click within the boxed area to select the file from a file browser, or drag-and-drop the file. (Note that you can return to the Form view by clicking View file contents.)
        
     3. After you add the file, you are immediately taken to the Form view and the values in the YAML file are shown in the Account details fields.

        If you click the Import accounts file icon again, you can see the name of your imported file.

        
6. After you've added all the accounts that you need, click Create. The configuration is added to the configurations table and can be selected for use with an integration server or integration runtime.

Updating account details for a configuration or deleting a configuration

If you need to update the account details that are defined in a configuration, or delete a configuration that's no longer required, see Managing configuration objects from the Configuration page.

Defining account details

Use the following links to learn more about the account details that a local connector requires to connect to each application: