Configuración de cuentas

Utilice la configuración de Accounts para proporcionar detalles de cuenta y credenciales que una integración desplegada utiliza para conectarse a aplicaciones o API.

Resumen de los principales datos

Nombre o tipo de archivo: Archivo accounts.yaml
¿El archivo contiene secretos?: Sí
Ubicación de los datos importados o extraídos: No aplicable
Número máximo de configuraciones de archivo de cámara acorazada permitidas por tiempo de ejecución de integración: Una

El archivo accounts.yaml

La configuración de Cuentas requiere un archivo accounts.yaml , que contiene detalles de conexión y credenciales para todas las aplicaciones de su flujo. Sólo puede especificar una configuración de Cuentas por tiempo de ejecución de integración, pero puede añadir detalles para varias aplicaciones en una configuración de Cuentas.

Para saber cómo obtener los datos de conexión de las aplicaciones, consulte las guías prácticas.

Puede crear una configuración Accounts al crear un tiempo de ejecución de integración, o puede crearla en la pestaña Configuraciones de la página Gestionar El icono que representa la página Gestionar . Para obtener más información, consulte Proporcionar credenciales y secretos en las configuraciones.

Para proporcionar las credenciales de la cuenta, puede utilizar las vistas Formulario o Código del panel de configuración Crear para introducir los valores necesarios para una aplicación. Para añadir credenciales para varias aplicaciones, haga clic en Añadir cuenta en la vista Formulario.

Los detalles de la cuenta para la aplicación BambooHR se muestran en la vista Formulario del panel de configuración Crear. El enlace Añadir cuenta permite añadir credenciales para una aplicación adicional.

Consejo: Puede ver el formato YAML de las cuentas que ha añadido haciendo clic en Código. Por razones de seguridad, los detalles de la cuenta sólo están disponibles en formato REDACTED después de crear la configuración. Si necesita actualizar estos datos más adelante (por ejemplo, debido a un cambio de contraseña), copie y guarde el código YAML en un archivo accounts.yaml como copia de seguridad. Si es necesario, puede sobrescribir los datos de cuenta obsoletos actualizando el archivo accounts.yaml antes de importarlo para sustituir la configuración existente.

Vista en código de los detalles de la cuenta

Alternativamente, puede proporcionar credenciales importando un archivo accounts.yaml que contenga detalles para una o más aplicaciones.

Cuando cree un archivo accounts.yaml en un editor de texto, utilice las siguientes directrices para especificar los detalles de la cuenta para una o más aplicaciones a las que se conectan sus integraciones.

El archivo debe llamarse accounts.yaml.
La primera línea del archivo debe comenzar con el texto accounts: seguido de los detalles de la cuenta para cada combinación única de aplicación (o conector) y cuenta que se utilice en el flujo.

Una entrada para una aplicación (o conector) comienza con su nombre predefinido, seguido de un tipo de autorización, nombre de cuenta, credenciales y un punto final.

El nombre de la aplicación (o conector) es siempre obligatorio.

Se necesita un tipo de autorización (identificado por un parámetro authType ) para definir el mecanismo que se utiliza para la autorización del usuario. Si sólo se aplica un tipo de autorización, el valor authType puede omitirse porque se utiliza automáticamente el valor predeterminado. Si se aplica más de un tipo de autorización, especifique el authType valor en formato de serpiente mayúscula (UPPER_SNAKE_CASE ) en lugar del formato camel case (camelCase ). Formatos de CamelCase de authType valores en mayores accounts.yaml Los archivos se convierten automáticamente a mayúsculas como parte de la creación de la cuenta. Consulte los ejemplos de la tabla siguiente.

Ejemplos de formato Mayúsculas serpiente para el valor authType	Formatos de caja de camello más antiguos para 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`

El nombre de la cuenta (identificado por un parámetro name ) es siempre obligatorio. El nombre debe ser idéntico al nombre de la cuenta que se utiliza en el flujo exportado.
La necesidad de credenciales o de un punto final depende del conector. En caso necesario, los parámetros de cuenta para las credenciales o un punto final se especifican como pares de clave y valor, con nombres de clave predefinidos. Por ejemplo:
```
username: janedoe
endpointUrl: 'https://mydomain.atlassian.net'
```
Proporcione un valor para cada par de clave y valor que se identifique como Obligatorio.
Puede omitir la entrada de clave y valor para un parámetro opcional si no necesita establecer un valor.

El siguiente ejemplo muestra el formato que se debe utilizar cuando es necesario especificar parámetros para un tipo de autorización, credenciales y un punto final.

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

El siguiente ejemplo muestra el formato que se debe utilizar cuando es necesario especificar parámetros para credenciales, pero no para un endpoint. Sólo se admite un tipo de autorización, por lo que se omite.

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

El siguiente ejemplo muestra el formato a utilizar cuando no es necesario especificar parámetros para las credenciales o un endpoint. Sólo se admite un tipo de autorización, por lo que se omite.

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

El archivo debe tener contenido YAML válido. Los caracteres de tabulación no son compatibles y deben sustituirse por espacios. Puede que le resulte útil utilizar una herramienta de validación de YAML para comprobar el contenido.