Dela via

OnBehalfOfCredential class

  • Referens
Paket:
@azure/identity

Aktiverar autentisering till Microsoft Entra-ID med hjälp av På uppdrag av flödet.

Konstruktorer

OnBehalfOfCredential(OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Skapar en instans av OnBehalfOfCredential- med den information som behövs för att autentisera mot Microsoft Entra-ID med en klient getAssertion och en användarkontroll.

Exempel med KeyClient från @azure/keyvault-keys:

const tokenCredential = new OnBehalfOfCredential({
  tenantId,
  clientId,
  getAssertion: () => { return Promise.resolve("my-jwt")},
  userAssertionToken: "access-token"
});
const client = new KeyClient("vault-url", tokenCredential);

await client.getKey("key-name");
OnBehalfOfCredential(OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Skapar en instans av OnBehalfOfCredential- med den information som behövs för att autentisera mot Microsoft Entra-ID med sökvägen till ett PEM-certifikat och en användarkontroll.

Exempel med KeyClient från @azure/keyvault-keys:

const tokenCredential = new OnBehalfOfCredential({
  tenantId,
  clientId,
  certificatePath: "/path/to/certificate.pem",
  userAssertionToken: "access-token"
});
const client = new KeyClient("vault-url", tokenCredential);

await client.getKey("key-name");
OnBehalfOfCredential(OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Skapar en instans av OnBehalfOfCredential- med den information som behövs för att autentisera mot Microsoft Entra-ID med en klienthemlighet och en användarkontroll.

Exempel med KeyClient från @azure/keyvault-keys:

const tokenCredential = new OnBehalfOfCredential({
  tenantId,
  clientId,
  clientSecret,
  userAssertionToken: "access-token"
});
const client = new KeyClient("vault-url", tokenCredential);

await client.getKey("key-name");

Metoder

getToken(string | string[], GetTokenOptions)

Autentiserar med Microsoft Entra-ID och returnerar en åtkomsttoken om det lyckas. Om autentiseringen misslyckas utlöses en CredentialUnavailableError med information om felet.

Konstruktorinformation

OnBehalfOfCredential(OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Skapar en instans av OnBehalfOfCredential- med den information som behövs för att autentisera mot Microsoft Entra-ID med en klient getAssertion och en användarkontroll.

Exempel med KeyClient från @azure/keyvault-keys:

const tokenCredential = new OnBehalfOfCredential({
  tenantId,
  clientId,
  getAssertion: () => { return Promise.resolve("my-jwt")},
  userAssertionToken: "access-token"
});
const client = new KeyClient("vault-url", tokenCredential);

await client.getKey("key-name");

new OnBehalfOfCredential(options: OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Parametrar

options

OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions

Valfria parametrar, vanligtvis vanliga för autentiseringsuppgifter.

OnBehalfOfCredential(OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Skapar en instans av OnBehalfOfCredential- med den information som behövs för att autentisera mot Microsoft Entra-ID med sökvägen till ett PEM-certifikat och en användarkontroll.

Exempel med KeyClient från @azure/keyvault-keys:

const tokenCredential = new OnBehalfOfCredential({
  tenantId,
  clientId,
  certificatePath: "/path/to/certificate.pem",
  userAssertionToken: "access-token"
});
const client = new KeyClient("vault-url", tokenCredential);

await client.getKey("key-name");

new OnBehalfOfCredential(options: OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Parametrar

options

OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions

Valfria parametrar, vanligtvis vanliga för autentiseringsuppgifter.

OnBehalfOfCredential(OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Skapar en instans av OnBehalfOfCredential- med den information som behövs för att autentisera mot Microsoft Entra-ID med en klienthemlighet och en användarkontroll.

Exempel med KeyClient från @azure/keyvault-keys:

const tokenCredential = new OnBehalfOfCredential({
  tenantId,
  clientId,
  clientSecret,
  userAssertionToken: "access-token"
});
const client = new KeyClient("vault-url", tokenCredential);

await client.getKey("key-name");

new OnBehalfOfCredential(options: OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Parametrar

options

OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions

Valfria parametrar, vanligtvis vanliga för autentiseringsuppgifter.

Metodinformation

getToken(string | string[], GetTokenOptions)

Autentiserar med Microsoft Entra-ID och returnerar en åtkomsttoken om det lyckas. Om autentiseringen misslyckas utlöses en CredentialUnavailableError med information om felet.

function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>

Parametrar

scopes

string | string[]

Listan över omfång som token ska ha åtkomst till.

options
GetTokenOptions

De alternativ som används för att konfigurera de underliggande nätverksbegäranden.

Returer

Promise<AccessToken>