Skip to main content

Credential

The credential widget acts as a wrapper to securely manage credentials. Any information marked as a credential is stored in the vault, and sensitive fields such as passwords and secrets can't be viewed after they're stored. Use the credential widget when you need to securely store and manage authentication data that requires vault-level encryption.

Credential widget screenshot

How it works​

The credential widget:

  • Acts as a wrapper for secure credential input
  • Stores all values encrypted in Atlan's vault
  • Prevents viewing of stored sensitive fields like passwords and secrets
  • Returns a unique GUID reference for the stored credential
  • Supports updates but not plaintext retrieval after storage

Props​

The credential widget requires minimal configuration. The primary property credentialType links the widget to a configuration file that defines what credential fields to display and how to validate them. The widget also supports label, id, required, placeholder, help, grid, and hidden. For more information, see Widget properties.

credentialTypeRequired

References a JSON configuration file in your configmap that defines credential structure and validation.

Type: string
Example:atlan-connectors-powerbi.json

How to use​

In the below example, atlan-connectors-powerbi refers to a configmap, atlan-connectors-powerbi.json, that defines the structure of the credential:

{
  "credential-guid": {
    "type": "string",
    "required": true,
    "ui": {
      "widget": "credential",
      "label": "",
      "credentialType": "atlan-connectors-powerbi",
      "placeholder": "Credential Guid",
      "hidden": false
    }
  }
}
  • Input - Use for non-sensitive text values that don't require encryption

See also​

  • Widget properties - provides detailed information about common properties shared across all widgets.

Need help​

If you face any issues or need help with credential widget configuration, contact Atlan support by submitting a support request.