credential

Represents all possible credential types that can be used for authentication.

Examples

union Credential = 
  | UserPasswordOnlyCredentials
  | TokenCredentials
  | UserPasswordCredentials
  | UrlOnlyCredentials
  | TokenAndUserCredentials
  | JiraServiceAccountCredentials
  | JiraServiceAccountOAuth2Credentials
  | ClientIdSecretKeyCredentials
  | AWSAssumeRoleCredentials
  | AWSAssumeRoleCredentialsOnprem
  | UserPasswordAndTenantCredentials
  | TokenAndProjectIdCredentials
  | TenantClientsubscriptionIdSecretCredentials
  | TenantIdClientIdClientSecretCredentials
  | GitHubAppCredentials
  | BitbucketAppCredentials
  | APISecretAndAccessKeyCredentials
  | OrganizationIdAndApiKeyCredentials
  | ClientIdSecretApiUrlCredentials
  | OrganizationIdAndClientIdSecretApiUrlCredentials
  | TokenOnlyCredentials
  | AWSEKSCredentials
  | ClientIdClientSecretCredentials
  | ClientIdClientSecretNoHostCredentials
  | AzureCloudCredentials
  | AppIdAndTokenCredentials
  | WebhookCredentials
  | AksCredentials
  | GKECredentials
  | ServicePrincipalCredentials
  | IdentityProvider
  | BrokerCredentials
  | K8sInspectorCredentials
  | RuntimeSensor
  | BotIdentityProvider
  | AzureOpenAIApiCredentials
  | GcpWorkloadIdentityFederationCredentials

Types

Type	Description
UserPasswordOnlyCredentials	Credentials using username and password only
TokenCredentials	Credentials using a token for authentication
UserPasswordCredentials	Credentials using username and password with additional fields
UrlOnlyCredentials	Credentials using only a URL
TokenAndUserCredentials	Credentials using token and username
JiraServiceAccountCredentials	Credentials for Jira service account authentication
JiraServiceAccountOAuth2Credentials	Credentials for Jira service account authentication via OAuth 2.0 client_credentials
ClientIdSecretKeyCredentials	Credentials using client ID and secret key
AWSAssumeRoleCredentials	Credentials for AWS role assumption
AWSAssumeRoleCredentialsOnprem	Credentials for AWS role assumption in on-premises environments
UserPasswordAndTenantCredentials	Credentials using username, password and tenant information
TokenAndProjectIdCredentials	Credentials using token and project ID
TenantClientsubscriptionIdSecretCredentials	Credentials using tenant, client, subscription ID and secret
TenantIdClientIdClientSecretCredentials	Credentials using tenant ID, client ID and client secret
GitHubAppCredentials	Credentials for GitHub App authentication
BitbucketAppCredentials
APISecretAndAccessKeyCredentials	Credentials using API secret and access key
OrganizationIdAndApiKeyCredentials	Credentials using organization ID and API key
ClientIdSecretApiUrlCredentials	Credentials using client ID, secret, and API URL
OrganizationIdAndClientIdSecretApiUrlCredentials	Credentials using Organization ID, client ID, client Secret, and API URL
TokenOnlyCredentials	Credentials using only a token
AWSEKSCredentials	Credentials for AWS EKS authentication
ClientIdClientSecretCredentials	Credentials using client ID and client secret
ClientIdClientSecretNoHostCredentials	Credentials using client ID and client secret without host URL
AzureCloudCredentials	Credentials for Azure Cloud authentication
AppIdAndTokenCredentials	Credentials using application ID and token
WebhookCredentials	Credentials using webhook URL
AksCredentials	Credentials for Azure Kubernetes Service authentication
GKECredentials	Credentials for Google Kubernetes Engine authentication
ServicePrincipalCredentials	Credentials for service principal authentication
IdentityProvider	Credentials for identity provider authentication
BrokerCredentials	Credentials for broker authentication
K8sInspectorCredentials	Credentials for Kubernetes inspector
RuntimeSensor	Credentials for Runtime Sensor
BotIdentityProvider	Credentials for bot identity provider authentication
AzureOpenAIApiCredentials	Credentials for Azure OpenAI API (token, endpoint, deployment name)
GcpWorkloadIdentityFederationCredentials	Keyless GCP Workload Identity Federation credentials (token is a non-secret ox_oidc_wif envelope)

References

Fields with this object:

• {} Connector.credentials