Interface RemoteGitAuthArgs

Authentication options for the repository that can be specified for a private Git repo. There are three different authentication paths:

  • Personal accesstoken
  • SSH private key (and its optional password)
  • Basic auth username and password

Only one authentication path is valid.

interface RemoteGitAuthArgs {
    password?: string;
    personalAccessToken?: string;
    sshPrivateKey?: string;
    sshPrivateKeyPath?: string;
    username?: string;
}

Properties

password? personalAccessToken? sshPrivateKey? sshPrivateKeyPath? username?

Properties

Optional password

password?: string

The password that pairs with a username or as part of an SSH Private Key.

Optional personalAccessToken

personalAccessToken?: string

PersonalAccessToken is a Git personal access token in replacement of your password.

Optional sshPrivateKey

sshPrivateKey?: string

The (contents) private key for access to the git repo.

Optional sshPrivateKeyPath

sshPrivateKeyPath?: string

The absolute path to a private key for access to the git repo.

Optional username

username?: string

Username is the username to use when authenticating to a git repository

Settings

Member Visibility

Theme

On This Page

passwordpersonalAccessTokensshPrivateKeysshPrivateKeyPathusername

Generated using TypeDoc