public interface

MAMEnrollmentManager

com.microsoft.intune.mam.policy.MAMEnrollmentManager

Class Overview

Interface for exposing the MAMService's enrollment functionality.

Summary

Nested Classes
enum MAMEnrollmentManager.Result Result codes returned directly and through notifications. 
Public Methods
abstract MAMEnrollmentManager.Result getRegisteredAccountStatus(String upn)
Returns the status of the given account if it is registered for MAM.
abstract MAMEnrollmentManager.Result getRegisteredAccountStatus(String upn, String aadId)
Returns the status of the given account if it is registered for MAM.
abstract void registerADALConnectionDetails(String identity, ADALConnectionDetails adalDetails)
Register ADAL connection details for the given UPN.
abstract void registerAccountForMAM(String upn, String aadId, String tenantId, String authority)
Register the given account for MAM management.
abstract void registerAccountForMAM(String upn, String aadId, String tenantId)
Register the given account for MAM management.
abstract void registerAuthenticationCallback(MAMServiceAuthenticationCallback callback)
This is the mechanism whereby the application provides its MAMServiceAuthenticationCallback instance to the SDK.
abstract void unregisterAccountForMAM(String upn, String aadId)
Remove the registration for the given account.
abstract void unregisterAccountForMAM(String upn)
Remove the registration for the given account.
abstract void updateToken(String upn, String aadId, String resourceId, String token)
If the application chooses not to return a token when the AuthenticationCallback method is called (for example, because it is an inconvenient time to show an auth UI), it can provide the token later using this method.

Public Methods

public abstract MAMEnrollmentManager.Result getRegisteredAccountStatus (String upn)

Returns the status of the given account if it is registered for MAM.

Parameters
upn the UPN of the account.
Returns
  • status of the account if it is registered, null otherwise.

public abstract MAMEnrollmentManager.Result getRegisteredAccountStatus (String upn, String aadId)

Returns the status of the given account if it is registered for MAM.

Parameters
upn the UPN of the account.
aadId the AAD Id (OID) of the account.
Returns
  • status of the account if it is registered, null otherwise.

public abstract void registerADALConnectionDetails (String identity, ADALConnectionDetails adalDetails)

Register ADAL connection details for the given UPN. These details will be used for enforcing auth-required policy.

Parameters
identity UPN the connection details apply to
adalDetails ADAL connection information to register

public abstract void registerAccountForMAM (String upn, String aadId, String tenantId, String authority)

Register the given account for MAM management. Enrollment will be attempted for this identity, and if it fails the it will be periodically retried until the account is unregistered. Status of the account will be provided to the app via notifications. This method is idempotent. The app may provide the user's authority to enable enrollment against sovereign cloud environments.

Parameters
upn the UPN of the account.
aadId the AAD Id (OID) of the account. Can be found after successful ADAL authentication from AuthenticationResult.getUserInfo().getUserId()
tenantId the tenant id of the account. Can be null if the tenant id is not known but that is not recommended since the tenant id is used for telemetry events to correlate users with tenants. Can be found after successful ADAL authentication from AuthenticationResult.getTenantId()
authority the authority used to acquire tokens for the account.

public abstract void registerAccountForMAM (String upn, String aadId, String tenantId)

Register the given account for MAM management. Enrollment will be attempted for this identity, and if it fails the it will be periodically retried until the account is unregistered. Status of the account will be provided to the app via notifications. This method is idempotent.

Parameters
upn the UPN of the account.
aadId the AAD Id (OID) of the account. Can be found after successful ADAL authentication from AuthenticationResult.getUserInfo().getUserId()
tenantId the tenant id of the account. Can be null if the tenant id is not known but that is not recommended since the tenant id is used for telemetry events to correlate users with tenants. Can be found after successful ADAL authentication from AuthenticationResult.getTenantId()

public abstract void registerAuthenticationCallback (MAMServiceAuthenticationCallback callback)

This is the mechanism whereby the application provides its MAMServiceAuthenticationCallback instance to the SDK. This should be called as soon as possible during app execution, (e.g. in override to MAMApplication.onMAMCreate) in case any registered accounts require enrollment retries, and to support token requests for policy checkins.

Parameters
callback a callback instance that implements either MAMServiceAuthenticationCallback or MAMServiceAuthenticationCallbackExtended.

public abstract void unregisterAccountForMAM (String upn, String aadId)

Remove the registration for the given account. If the account is MAM enrolled, it will be unenrolled, and if it is also managed the app will be wiped. Periodic enrollment retries for non-enrolled accounts will stop. Status of the account and unenrollment request will be provided to the app via notifications. This method is idempotent.

Parameters
upn the UPN of the account.
aadId the AAD Id (OID) of the account.

public abstract void unregisterAccountForMAM (String upn)

Remove the registration for the given account. If the account is MAM enrolled, it will be unenrolled, and if it is also managed the app will be wiped. Periodic enrollment retries for non-enrolled accounts will stop. Status of the account and unenrollment request will be provided to the app via notifications. This method is idempotent.

Parameters
upn the UPN of the account.

public abstract void updateToken (String upn, String aadId, String resourceId, String token)

If the application chooses not to return a token when the AuthenticationCallback method is called (for example, because it is an inconvenient time to show an auth UI), it can provide the token later using this method.

Parameters
upn the UPN of the account requested in the callback.
aadId the AAD Id (OID) of the account requested in the callback.
resourceId the resourceId of the resource requested in the callback.
token the token being provided.