ClientCertificateCredentialOptions

Optional parameters for the ClientCertificateCredential class.

Hierarchy

TokenCredentialOptions
CredentialPersistenceOptions
- ClientCertificateCredentialOptions

Index

Properties

Optional authorityHost

authorityHost: undefined | string

The authority host to use for authentication requests. Possible values are available through AzureAuthorityHosts. The default is "https://login.microsoftonline.com".

Optional loggingOptions

loggingOptions: LogPolicyOptions & { allowLoggingAccountIdentifiers?: undefined | false | true }

Allows logging account information once the authentication flow succeeds.

Optional sendCertificateChain

sendCertificateChain: undefined | false | true

Option to include x5c header for SubjectName and Issuer name authorization. Set this option to send base64 encoded public certificate in the client assertion header as an x5c claim

Optional tokenCachePersistenceOptions

tokenCachePersistenceOptions: TokenCachePersistenceOptions

Options to provide to the persistence layer (if one is available) when storing credentials.

You must first register a persistence provider plugin. See the @azure/identity-cache-persistence package on NPM.

Example:

import { cachePersistencePlugin } from "@azure/identity-cache-persistence";
import { useIdentityPlugin, DeviceCodeCredential } from "@azure/identity";

useIdentityPlugin(cachePersistencePlugin);

async function main() {
  const credential = new DeviceCodeCredential({
    tokenCachePersistenceOptions: {
      enabled: true
    }
  });
}

main().catch((error) => {
  console.error("An error occurred:", error);
  process.exit(1);
});