Interface AuthCredential

An authentication credential, in one of several shapes selected by authType.

To turn one of these into the credential a request actually carries, use the exchange() method of a BaseCredentialExchanger.

Example

// API Key Auth
const authCredential: AuthCredential = {
  authType: AuthCredentialTypes.API_KEY,
  apiKey: "your_api_key",
};

Example

// HTTP Auth
const authCredential: AuthCredential = {
  authType: AuthCredentialTypes.HTTP,
  http: {
    scheme: "basic",
    credentials: {
      username: "user",
      password: "password",
    },
  }
}

Example

// OAuth2 Bearer Token in HTTP Header
const authCredential: AuthCredential = {
  authType: AuthCredentialTypes.HTTP,
  http: {
    scheme: "bearer",
    credentials: {
      token: "your_access_token",
    },
  }
}

Example

// OAuth2 Auth with Authorization Code Flow
const authCredential: AuthCredential = {
  authType: AuthCredentialTypes.OAUTH2,
  oauth2: {
    clientId: "your_client_id",
    clientSecret: "your_client_secret",
  }
}

Example

// Open ID Connect Auth
const authCredential: AuthCredential = {
  authType: AuthCredentialTypes.OPEN_ID_CONNECT,
  oauth2: {
    clientId: "1234",
    clientSecret: "secret",
    redirectUri: "https://example.com",
  }
}

Example

// Auth with resource reference
const authCredential: AuthCredential = {
  authType: AuthCredentialTypes.API_KEY,
  resourceRef: "projects/1234/locations/us-central1/resources/resource1"
}

interface AuthCredential {
    apiKey?: string;
    authType: AuthCredentialTypes;
    http?: HttpAuth;
    oauth2?: OAuth2Auth;
    resourceRef?: string;
    serviceAccount?: ServiceAccount;
}

Properties

`Optional`apiKey

apiKey?: string

`Optional`resourceRef

resourceRef?: string

Resource reference for the credential. This will be supported in the future.

`Optional`serviceAccount

serviceAccount?: ServiceAccount

Interface AuthCredential

Example

Example

Example

Example

Example

Example

Properties

OptionalapiKey

authType

Optionalhttp

Optionaloauth2

OptionalresourceRef

OptionalserviceAccount

`Optional`apiKey

`Optional`http

`Optional`oauth2

`Optional`resourceRef

`Optional`serviceAccount