OnBehalfOfCredentialBuilder Clase

Paquete:

com.azure.identity

Artefacto Maven:

com.azure:azure-identity:1.10.4

• java.lang.Object
• • com.azure.identity.CredentialBuilderBase<T>
  • • com.azure.identity.AadCredentialBuilderBase<T>
    • • com.azure.identity.OnBehalfOfCredentialBuilder

public class OnBehalfOfCredentialBuilder
extends AadCredentialBuilderBase<OnBehalfOfCredentialBuilder>

Generador de credenciales de Fluent para crear instancias de .OnBehalfOfCredential

En nombre de la autenticación en Azure, es una manera de que un usuario o una aplicación se autentiquen en un servicio o recurso mediante credenciales de otro proveedor de identidades. Este tipo de autenticación se usa normalmente cuando un usuario o aplicación quiere acceder a un recurso en Azure, pero sus credenciales se administran mediante un proveedor de identidades diferente, como un Active Directory local o un proveedor de identidades de terceros. Para usar la autenticación "En nombre de" en Azure, el usuario primero debe autenticarse en el proveedor de identidades mediante sus credenciales. A continuación, el proveedor de identidades emite un token de seguridad que contiene información sobre el usuario y sus permisos. A continuación, este token de seguridad se pasa a Azure, que lo usa para autenticar al usuario o la aplicación y concederles acceso al recurso solicitado. OnBehalfOfCredential adquiere un token con un secreto o certificado de cliente y una aserción de usuario para una aplicación de AAD en nombre de una entidad de seguridad de usuario.

En el ejemplo de código siguiente se muestra la creación de un OnBehalfOfCredentialobjeto , utilizando para OnBehalfOfCredentialBuilder configurarlo. Los tenantIdparámetros , clientId y clientSecret son necesarios para crear OnBehalfOfCredential. OpcionalmenteuserAssertion, se puede especificar en .OnBehalfOfCredentialBuilder Una vez creada esta credencial, se puede pasar al generador de muchos de los generadores de cliente de Azure SDK para Java como parámetro "credential".

TokenCredential onBehalfOfCredential = new OnBehalfOfCredentialBuilder()
     .clientId("<app-client-ID>")
     .clientSecret("<app-Client-Secret>")
     .tenantId("<app-tenant-ID>")
     .userAssertion("<user-assertion>")
     .build();

Resumen del constructor

Constructor	Description
OnBehalfOfCredentialBuilder()

Resumen del método

Modificador y tipo	Método y descripción
OnBehalfOfCredential	build() Crea un nuevo OnBehalfOfCredential con las configuraciones actuales.
OnBehalfOfCredentialBuilder	clientCertificatePassword(String clientCertificatePassword) Establece la contraseña del certificado de cliente para autenticarse en AAD.
OnBehalfOfCredentialBuilder	clientSecret(String clientSecret) Establece el secreto de cliente para la autenticación.
OnBehalfOfCredentialBuilder	pemCertificate(String pemCertificatePath) Establece la ruta de acceso del certificado PEM para autenticarse en AAD.
OnBehalfOfCredentialBuilder	pfxCertificate(String pfxCertificatePath) Establece la ruta de acceso y la contraseña del certificado PFX para autenticarse en AAD.
OnBehalfOfCredentialBuilder	sendCertificateChain(boolean sendCertificateChain) Especifica si la notificación x5c (clave pública del certificado) se debe enviar como parte de la solicitud de autenticación y habilitar la autenticación basada en el firmante o el emisor.
OnBehalfOfCredentialBuilder	tokenCachePersistenceOptions(TokenCachePersistenceOptions tokenCachePersistenceOptions) Configura las opciones de caché de tokens compartidos persistentes y habilita la caché de tokens persistente que está deshabilitada de forma predeterminada.
OnBehalfOfCredentialBuilder	userAssertion(String userAssertion) Configure el ámbito de aserción de usuario que se usará para la solicitud ennombrede la autenticación.

Métodos heredados de AadCredentialBuilderBase

additionallyAllowedTenants additionallyAllowedTenants authorityHost clientId disableInstanceDiscovery enableUnsafeSupportLogging executorService tenantId

Métodos heredados de CredentialBuilderBase

addPolicy clientOptions configuration enableAccountIdentifierLogging httpClient httpLogOptions httpPipeline maxRetry pipeline proxyOptions retryOptions retryPolicy retryTimeout

Métodos heredados de java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Detalles del constructor

OnBehalfOfCredentialBuilder

public OnBehalfOfCredentialBuilder()

Detalles del método

build

public OnBehalfOfCredential build()

Crea un nuevo OnBehalfOfCredential con las configuraciones actuales.

Returns:

con OnBehalfOfCredential las configuraciones actuales.

clientCertificatePassword

public OnBehalfOfCredentialBuilder clientCertificatePassword(String clientCertificatePassword)

Establece la contraseña del certificado de cliente para autenticarse en AAD.

Parameters:

clientCertificatePassword - la contraseña que protege el certificado

Returns:

Instancia actualizada de este generador.

clientSecret

public OnBehalfOfCredentialBuilder clientSecret(String clientSecret)

Establece el secreto de cliente para la autenticación.

Parameters:

clientSecret - el valor secreto de la aplicación de AAD.

Returns:

Instancia actualizada de este generador.

pemCertificate

public OnBehalfOfCredentialBuilder pemCertificate(String pemCertificatePath)

Establece la ruta de acceso del certificado PEM para autenticarse en AAD.

Parameters:

pemCertificatePath - el archivo PEM que contiene el certificado

Returns:

Instancia actualizada de este generador.

pfxCertificate

public OnBehalfOfCredentialBuilder pfxCertificate(String pfxCertificatePath)

Establece la ruta de acceso y la contraseña del certificado PFX para autenticarse en AAD.

Parameters:

pfxCertificatePath - el archivo PFX protegido con contraseña que contiene el certificado

Returns:

Instancia actualizada de este generador.

sendCertificateChain

public OnBehalfOfCredentialBuilder sendCertificateChain(boolean sendCertificateChain)

Especifica si la notificación x5c (clave pública del certificado) se debe enviar como parte de la solicitud de autenticación y habilitar la autenticación basada en el firmante o el emisor. El valor predeterminado es false.

Parameters:

sendCertificateChain - marca que indica si la cadena de certificados se debe enviar como parte de la solicitud de autenticación.

Returns:

Instancia actualizada de este generador.

tokenCachePersistenceOptions

public OnBehalfOfCredentialBuilder tokenCachePersistenceOptions(TokenCachePersistenceOptions tokenCachePersistenceOptions)

Configura las opciones de caché de tokens compartidos persistentes y habilita la caché de tokens persistente que está deshabilitada de forma predeterminada. Si se configura, la credencial almacenará tokens en una memoria caché almacenada en la máquina, protegida para el usuario actual, que se puede compartir con otras credenciales y procesos.

Parameters:

tokenCachePersistenceOptions - las opciones de configuración de la caché de tokens

Returns:

Instancia actualizada de este generador con las opciones de caché de tokens configuradas.

userAssertion

public OnBehalfOfCredentialBuilder userAssertion(String userAssertion)

Configure el ámbito de aserción de usuario que se usará para la solicitud de autenticación OnBehalfOf.

Parameters:

userAssertion - el token de acceso de aserción de usuario que se usará para el flujo de autenticación en nombre de .

Returns:

Instancia actualizada de este generador con el ámbito de aserción de usuario configurado.