Interface MAMEnrollmentManager
-
- All Implemented Interfaces:
public interface MAMEnrollmentManagerInterface for exposing the MAMService's enrollment functionality.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public enumMAMEnrollmentManager.ResultResult codes returned directly and through notifications.
-
Method Summary
Modifier and Type Method Description abstract voidregisterADALConnectionDetails(String identity, ADALConnectionDetails adalDetails)Register ADAL connection details for the given UPN. abstract voidregisterAuthenticationCallback(@NonNull() MAMServiceAuthenticationCallback callback)This is the mechanism whereby the application provides its MAMServiceAuthenticationCallback instance to the SDK. abstract voidupdateToken(@NonNull() String upn, @NonNull() String aadId, @NonNull() String resourceId, @NonNull() 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. abstract voidregisterAccountForMAM(@NonNull() String upn, @NonNull() String aadId, @Nullable() String tenantId)Register the given account for MAM management. abstract voidregisterAccountForMAM(@NonNull() String upn, @NonNull() String aadId, @Nullable() String tenantId, @NonNull() String authority)Register the given account for MAM management. abstract voidunregisterAccountForMAM(@NonNull() String upn)Remove the registration for the given account. abstract voidunregisterAccountForMAM(@NonNull() String upn, @NonNull() String aadId)Remove the registration for the given account. abstract MAMEnrollmentManager.ResultgetRegisteredAccountStatus(@NonNull() String upn)Returns the status of the given account if it is registered for MAM. abstract MAMEnrollmentManager.ResultgetRegisteredAccountStatus(@NonNull() String upn, @NonNull() String aadId)Returns the status of the given account if it is registered for MAM. -
-
Method Detail
-
registerADALConnectionDetails
@Deprecated() 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 toadalDetails- ADAL connection information to register
-
registerAuthenticationCallback
abstract void registerAuthenticationCallback(@NonNull() 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.
-
updateToken
abstract void updateToken(@NonNull() String upn, @NonNull() String aadId, @NonNull() String resourceId, @NonNull() 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.
-
registerAccountForMAM
abstract void registerAccountForMAM(@NonNull() String upn, @NonNull() String aadId, @Nullable() 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.tenantId- the tenant id of the account.
-
registerAccountForMAM
abstract void registerAccountForMAM(@NonNull() String upn, @NonNull() String aadId, @Nullable() String tenantId, @NonNull() 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.tenantId- the tenant id of the account.authority- the authority used to acquire tokens for the account.
-
unregisterAccountForMAM
@Deprecated() abstract void unregisterAccountForMAM(@NonNull() 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.
-
unregisterAccountForMAM
abstract void unregisterAccountForMAM(@NonNull() String upn, @NonNull() 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.
-
getRegisteredAccountStatus
@Deprecated()@Nullable() abstract MAMEnrollmentManager.Result getRegisteredAccountStatus(@NonNull() 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.
-
getRegisteredAccountStatus
@Nullable() abstract MAMEnrollmentManager.Result getRegisteredAccountStatus(@NonNull() String upn, @NonNull() 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.
-
-
-
-