com.microsoft.aad.msal4j

Interface IManagedIdentityApplication

All Known Implementing Classes:

ManagedIdentityApplication

public interface IManagedIdentityApplication

Interface representing a managed identity application. Managed identity applications are used to acquire a token for managed identity assigned to an azure resource such as Azure function, app service, virtual machine, etc. to acquire a token without using credentials. For details see https://aka.ms/msal4jclientapplications

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_AUTHORITY

Method Summary

Modifier and Type	Method and Description
CompletableFuture<IAuthenticationResult>	acquireTokenForManagedIdentity(ManagedIdentityParameters parameters) Acquires tokens from the configured managed identity on an azure resource.
String	correlationId() Gets the correlation ID used for tracing requests through the authentication system.
IHttpClient	httpClient() Gets the HTTP client used by the application for all HTTP requests.
boolean	logPii() Gets whether personally identifiable information (PII) is included in log messages.
Proxy	proxy() Gets the proxy configuration used by the application for network communication.
SSLSocketFactory	sslSocketFactory() Gets the SSL socket factory used by the application for secure network communication.

Field Detail

DEFAULT_AUTHORITY

static final String DEFAULT_AUTHORITY

See Also:

Constant Field Values

Method Detail

acquireTokenForManagedIdentity

CompletableFuture<IAuthenticationResult> acquireTokenForManagedIdentity(ManagedIdentityParameters parameters)
                                                                 throws Exception

Acquires tokens from the configured managed identity on an azure resource.

Parameters:

parameters - instance of ManagedIdentityParameters

Returns:

CompletableFuture containing an IAuthenticationResult

Throws:

Exception

logPii

boolean logPii()

Gets whether personally identifiable information (PII) is included in log messages.

Returns:

A boolean value which determines whether PII (personally identifiable information) will be included in log messages. When true, PII will be logged; when false, PII will be masked or omitted from logs.

correlationId

String correlationId()

Gets the correlation ID used for tracing requests through the authentication system.

Returns:

Correlation ID which is used for diagnostics purposes and is attached to token service requests. The default value is a random UUID.

httpClient

IHttpClient httpClient()

Gets the HTTP client used by the application for all HTTP requests.

Returns:

Instance of IHttpClient used by the application for network communication with the Microsoft identity platform.

proxy

Proxy proxy()

Gets the proxy configuration used by the application for network communication.

Returns:

Proxy used by the application for all network communication. Returns null if no proxy is configured.

sslSocketFactory

SSLSocketFactory sslSocketFactory()

Gets the SSL socket factory used by the application for secure network communication.

Returns:

SSLSocketFactory used by the application for all secure network communication. Returns null if no custom SSL socket factory is configured.