Share via

OnBehalfOfCredentialCertificateOptions interface

  • Reference
Package:
@azure/identity

Defines the parameters to authenticate the OnBehalfOfCredential with a certificate.

Properties

certificatePath

The path to a PEM-encoded public/private key certificate on the filesystem.
clientId

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

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
tenantId

The Microsoft Entra tenant (directory) ID.
userAssertionToken

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

Property Details

certificatePath

The path to a PEM-encoded public/private key certificate on the filesystem.

certificatePath: string

Property Value

string

clientId

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

clientId: string

Property Value

string

sendCertificateChain

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

sendCertificateChain?: boolean

Property Value

boolean

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