Databricks SDK for JavaScript
    Preparing search index...

    Interface UpdateCredentialsRequest

    interface UpdateCredentialsRequest {
        gitEmail?: string;
        gitProvider?: string;
        gitUsername?: string;
        id?: bigint;
        isDefaultForProvider?: boolean;
        name?: string;
        personalAccessToken?: string;
        principalId?: bigint;
    }
    Index

    Properties

    gitEmail? gitProvider? gitUsername? id? isDefaultForProvider? name? personalAccessToken? principalId?

    Properties

    gitEmail?: string

    The authenticating email associated with your Git provider user account. Used for authentication with the remote repository and also sets the author & committer identity for commits. Required for most Git providers except AWS CodeCommit. Learn more at https://docs.databricks.com/aws/en/repos/get-access-tokens-from-git-provider

    gitProvider?: string

    Git provider. This field is case-insensitive. The available Git providers are gitHub, bitbucketCloud, gitLab, azureDevOpsServices (Azure DevOps Services, including Microsoft Entra ID authentication), gitHubEnterprise, bitbucketServer (Bitbucket Data Center), gitLabEnterpriseEdition (GitLab Self-Managed), and awsCodeCommit (deprecated by AWS, not accepting new customers).

    gitUsername?: string

    The username provided with your Git provider account and associated with the credential. For most Git providers it is only used to set the Git committer & author names for commits, however it may be required for authentication depending on your Git provider / token requirements. Required for AWS CodeCommit.

    id?: bigint

    The ID for the corresponding credential to access.

    isDefaultForProvider?: boolean

    if the credential is the default for the given provider

    name?: string

    the name of the git credential, used for identification and ease of lookup

    personalAccessToken?: string

    The personal access token used to authenticate to the corresponding Git provider. For certain providers, support may exist for other types of scoped access tokens. Learn more.

    principalId?: bigint

    The ID of the service principal whose credentials will be modified. Only service principal managers can perform this action.

    Settings

    Member Visibility

    On This Page

    Properties