OnBehalfOfCredentialAssertionOptions interface

Package:

@azure/identity

Defines the parameters to authenticate the OnBehalfOfCredential with an assertion.

Properties

clientId	The client (application) ID of an App Registration in the tenant.
getAssertion	A function that retrieves the client assertion for the credential to use
tenantId	The Microsoft Entra tenant (directory) ID.
userAssertionToken	The user assertion for the On-Behalf-Of flow.

Property Details

clientId

The client (application) ID of an App Registration in the tenant.

clientId: string

Property Value

string

getAssertion

A function that retrieves the client assertion for the credential to use

getAssertion: () => Promise<string>

Property Value

() => Promise<string>

tenantId

The Microsoft Entra tenant (directory) ID.

tenantId: string

Property Value

string

userAssertionToken

The user assertion for the On-Behalf-Of flow.

userAssertionToken: string

Property Value

string