EMOathTokenManager Protocol Reference
| Conforms to | EMTokenManager NSObject |
|---|---|
| Declared in | EMOathTokenManager.h |
– tokenWithName:error:
required method
Returns an existing token with the given name.
- (id<EMOathToken>)tokenWithName:(NSString *)name error:(NSError **)errorParameters
name |
The name of the token. |
|---|---|
error |
If an error occurs, upon return contains an NSError object that describes the problem. If you are not interested in possible errors, you may pass in |
Return Value
The token, nil if not found or if an error occurred.
Exceptions
EMActivationException |
when the activation code supplied on [EMCore configureWithActivationCode:configurations:] or [EMCore configureWithActivationCode:configurations:useDeviceSourceBinding] does not have the white box cryptography feature turned on. |
|---|
Declared In
EMOathTokenManager.h
– tokenWithName:fingerprintCustomData:error:
required method
Returns an existing token with the given name and fingerprint.
- (id<EMOathToken>)tokenWithName:(NSString *)name fingerprintCustomData:(NSData *)fingerprintCustomData error:(NSError **)errorParameters
name |
The name of the token. |
|---|---|
fingerprintCustomData |
The fingerprint custom data. |
error |
If an error occurs, upon return contains an NSError object that describes the problem. If you are not interested in possible errors, you may pass in |
Return Value
The token, nil if not found or if an error occurred.
Exceptions
EMActivationException |
when the activation code supplied on [EMCore configureWithActivationCode:configurations:] or [EMCore configureWithActivationCode:configurations:useDeviceSourceBinding] does not have the white box cryptography feature turned on. |
|---|
Declared In
EMOathTokenManager.h
– tokenWithUti:error:
required method
Returns an existing token with the given UTI (user token id).
- (id<EMOathToken>)tokenWithUti:(long)uti error:(NSError **)errorParameters
uti |
The UTI of the token. |
|---|---|
error |
If an error occurs, upon return contains an NSError object that describes the problem. If you are not interested in possible errors, you may pass in |
Return Value
The token, nil if not found or if an error occurred.
Availability
4.5
Exceptions
EMActivationException |
when the activation code supplied on [EMCore configureWithActivationCode:configurations:] or [EMCore configureWithActivationCode:configurations:useDeviceSourceBinding] does not have the white box cryptography feature turned on. |
|---|
Declared In
EMOathTokenManager.h
– tokenWithUti:fingerprintCustomData:error:
required method
Returns an existing token with the given UTI (user token id) and fingerprint.
- (id<EMOathToken>)tokenWithUti:(long)uti fingerprintCustomData:(NSData *)fingerprintCustomData error:(NSError **)errorParameters
uti |
The UTI of the token. |
|---|---|
fingerprintCustomData |
The fingerprint custom data. |
error |
If an error occurs, upon return contains an NSError object that describes the problem. If you are not interested in possible errors, you may pass in |
Return Value
The token, nil if not found or if an error occurred.
Availability
4.5
Exceptions
EMActivationException |
when the activation code supplied on [EMCore configureWithActivationCode:configurations:] or [EMCore configureWithActivationCode:configurations:useDeviceSourceBinding] does not have the white box cryptography feature turned on. |
|---|
Declared In
EMOathTokenManager.h
– createTokenWithName:provisioningConfiguration:completionHandler:
required method
Starts the creation of a new token with the specified token name and the provisioning configuration. Before creating the token, integrator has to make sure there is no existing token with the same token name.
- (void)createTokenWithName:(NSString *)name provisioningConfiguration:(EMProvisioningConfiguration *)configuration completionHandler:(void ( ^ ) ( id<EMOathToken> token , NSError *error ))completionHandlerParameters
name |
The token name. |
|---|---|
configuration |
The provisioning configuration. |
completionHandler |
mandatory block to be invoked when error occurs or when token creation is completed. |
Discussion
Warning: This API does not support Mobile Provisioning Protocol version 5.
Declared In
EMOathTokenManager.h
– createTokenWithName:provisioningConfiguration:deviceFingerprintTokenPolicy:completionHandler:
required method
Starts the creation of a new token with the specified token name, provisioning configuration, and device fingerprint policy. Before creating the token, integrator has to make sure there is no existing token with the same token name.
- (void)createTokenWithName:(NSString *)name provisioningConfiguration:(EMProvisioningConfiguration *)configuration deviceFingerprintTokenPolicy:(EMDeviceFingerprintTokenPolicy *)deviceFingerprintTokenPolicy completionHandler:(void ( ^ ) ( id<EMOathToken> token , NSError *error ))completionHandlerParameters
name |
The token name. |
|---|---|
configuration |
The provisioning configuration. |
deviceFingerprintTokenPolicy |
device fingerprint token policy |
completionHandler |
mandatory block to be invoked when error occurs or when token creation is completed. |
Discussion
Warning: This API does not support Mobile Provisioning Protocol version 5.
Declared In
EMOathTokenManager.h
– createTokenWithName:provisioningConfiguration:deviceFingerprintTokenPolicy:capability:completionHandler:
required method
Starts the creation of a new token with the specified token name, provisioning configuration, device fingerprint policy, and token capability. Before creating the token, integrator has to make sure there is no existing token with the same token name.
- (void)createTokenWithName:(NSString *)name provisioningConfiguration:(EMProvisioningConfiguration *)configuration deviceFingerprintTokenPolicy:(EMDeviceFingerprintTokenPolicy *)deviceFingerprintTokenPolicy capability:(EMTokenCapability)capability completionHandler:(void ( ^ ) ( id<EMOathToken> token , NSError *error ))completionHandlerParameters
name |
The token name. |
|---|---|
configuration |
The provisioning configuration. |
deviceFingerprintTokenPolicy |
device fingerprint token policy |
capability |
The token capability (OTP computation, dual seed…). See EMTokenCapability. |
completionHandler |
mandatory block to be invoked when error occurs or when token creation is completed. |
Discussion
Warning: This API does not support Mobile Provisioning Protocol version 5.
Declared In
EMOathTokenManager.h
– createTokenWithName:provisioningConfiguration:capability:completionHandler:
required method
Starts the creation of a new token with the specified token name, provisioning configuration and the token capability. Before creating the token, integrator has to make sure there is no existing token with the same token name.
- (void)createTokenWithName:(NSString *)name provisioningConfiguration:(EMProvisioningConfiguration *)configuration capability:(EMTokenCapability)capability completionHandler:(void ( ^ ) ( id<EMOathToken> token , NSError *error ))completionHandlerParameters
name |
The token name. |
|---|---|
configuration |
The provisioning configuration. |
capability |
The token capability (OTP computation, dual seed…). See EMTokenCapability. |
completionHandler |
mandatory block to be invoked when error occurs or when token creation is completed. |
Discussion
Warning: This API does not support Mobile Provisioning Protocol version 5.
Declared In
EMOathTokenManager.h
– createTokenWithName:provisioningConfiguration:deviceFingerprintTokenPolicy:extendedCompletionHandler:
required method
Starts the creation of a new token with the specified token name, provisioning configuration, and device fingerprint policy. Before creating the token, integrator has to make sure there is no existing token with the same token name. This API support Mobile Provisioning Protocol version 5 which will allows extensions to provide additional information set by the server, if any.
- (void)createTokenWithName:(NSString *)name provisioningConfiguration:(EMProvisioningConfiguration *)configuration deviceFingerprintTokenPolicy:(EMDeviceFingerprintTokenPolicy *)deviceFingerprintTokenPolicy extendedCompletionHandler:(void ( ^ ) ( id<EMOathToken> token , NSDictionary *extensions , NSError *error ))completionHandlerParameters
name |
The token name. |
|---|---|
configuration |
The provisioning configuration. |
deviceFingerprintTokenPolicy |
device fingerprint token policy |
completionHandler |
mandatory block to be invoked when error occurs or when token creation is completed. Specific for Mobile Provisioning Protocol version 5, this handler will contains extensions information for any string extension of “client.app.*” |
Availability
5.0
Exceptions
EMActivationException |
when the activation code supplied on [EMCore configureWithActivationCode:configurations:] or [EMCore configureWithActivationCode:configurations:useDeviceSourceBinding] does not have the white box cryptography feature turned on. |
|---|
Declared In
EMOathTokenManager.h
– createTokenWithName:provisioningConfiguration:deviceFingerprintTokenPolicy:capability:extendedCompletionHandler:
required method
Starts the creation of a new token with the specified token name, provisioning configuration, and device fingerprint policy. Before creating the token, integrator has to make sure there is no existing token with the same token name. This API support Mobile Provisioning Protocol version 5 which will allows extensions to provide additional information set by the server, if any.
- (void)createTokenWithName:(NSString *)name provisioningConfiguration:(EMProvisioningConfiguration *)configuration deviceFingerprintTokenPolicy:(EMDeviceFingerprintTokenPolicy *)deviceFingerprintTokenPolicy capability:(EMTokenCapability)capability extendedCompletionHandler:(void ( ^ ) ( id<EMOathToken> token , NSDictionary *extensions , NSError *error ))completionHandlerParameters
name |
The token name. |
|---|---|
configuration |
The provisioning configuration. |
deviceFingerprintTokenPolicy |
device fingerprint token policy |
capability |
The token capability (OTP computation, dual seed…). See EMTokenCapability. |
completionHandler |
mandatory block to be invoked when error occurs or when token creation is completed. Specific for Mobile Provisioning Protocol version 5, this handler will contains extensions information for any string extension of “client.app.*” |
Availability
5.0
Exceptions
EMActivationException |
when the activation code supplied on [EMCore configureWithActivationCode:configurations:] or [EMCore configureWithActivationCode:configurations:useDeviceSourceBinding] does not have the white box cryptography feature turned on. |
|---|
Declared In
EMOathTokenManager.h
– createLowPlatformCouplingToken:provisioningConfiguration:extendedCompletionHandler:
required method
To Creates a LowPlatformCoupling Token which is not affected by the changes in DeviceFingerprint.
- (void)createLowPlatformCouplingToken:(NSString *)name provisioningConfiguration:(EMProvisioningConfiguration *)configuration extendedCompletionHandler:(void ( ^ ) ( id<EMOathToken> token , NSDictionary *extensions , NSError *error ))completionHandlerParameters
name |
The token name. |
|---|---|
configuration |
The provisioning configuration. |
completionHandler |
mandatory block to be invoked when error occurs or when token creation is completed. Specific for Mobile Provisioning Protocol version 5, this handler will contains extensions information for any string extension of “client.app.*” |
Availability
5.2.0
Declared In
EMOathTokenManager.h
– tokenCapabilitiesWithName:error:
required method
Get capabilities of token with given name.
- (EMEnumSet *)tokenCapabilitiesWithName:(NSString *)name error:(NSError **)errorParameters
name |
The name of the token. Returns the capabilities of an existing token. |
|---|---|
error |
If an error occurs, upon return contains an NSError object that describes the problem. If you are not interested in possible errors, you may pass in |
Return Value
The collection of token capabilities. See EMTokenCapability
Availability
4.0
Exceptions
EMCredentialDoesNotExistException |
When the token does not exist |
|---|---|
NSInternalInconsistencyException |
When an unexpected error occurs while reading the token from the DB |
Declared In
EMOathTokenManager.h