Context manager

The Context Manager simplifies the usage of complex SDK functions by reducing the number of parameters required when setting the operation context, authentication tokens, and other session data.

info

All the values that are provided to the context manager are automatically stored in secure storage.

Set API environment

Changes the environment the SDK operates against. It can be changed at any time, although it is recommended to set it up through the SdkConfig builder instead.

Kotlin

sdk.contextManager().setApiEnvironment(ApiEnvironment.PROD)

Java

sdk.contextManager().setApiEnvironment(ApiEnvironment.PROD);

Swift

sdk.contextManager().setApiEnvironment(apiEnvironment: ApiEnvironment.prod)

JavaScript

sdk.contextManager().setApiEnvironment("PROD");

C#

// Not implemented yet

Python

// Not implemented yet

Get API environment

Returns the environment the SDK is currently operating against. Defaults to PROD when it has never been set.

Kotlin

// Returns an ApiEnvironment
val apiEnvironment = sdk.contextManager().getApiEnvironment()

Java

// Returns an ApiEnvironment
var apiEnvironment = sdk.contextManager().getApiEnvironment();

Swift

// Returns an ApiEnvironment
let apiEnvironment = sdk.contextManager().getApiEnvironment()

JavaScript

// Returns a string
const apiEnvironment = sdk.contextManager().getApiEnvironment();

C#

// Returns an ApiEnvironment
var apiEnvironment = sdk.GetContextManager().GetApiEnvironment();

Python

# Returns a str
apiEnvironment = sdk.contextManager.get_api_environment()

Set cloud auth token

If the SDK was initialized without an authentication token, you can provide or update the token using this function, also it is set automatically by login, register, refresh-token and the automatic refresh. Passing null removes the stored token.

Kotlin

sdk.contextManager().setCloudAuthToken("AUTH_TOKEN")

Java

sdk.contextManager().setCloudAuthToken("AUTH_TOKEN");

Swift

sdk.contextManager().setCloudAuthToken(token: "AUTH_TOKEN")

JavaScript

sdk.contextManager().setCloudAuthToken("AUTH_TOKEN");

C#

sdk.GetContextManager().SetCloudAuthToken("AUTH_TOKEN");

Python

sdk.contextManager.set_cloud_auth_token("AUTH_TOKEN")

Get cloud auth token

Kotlin

val token = sdk.contextManager().getCloudAuthToken()

Java

var token = sdk.contextManager().getCloudAuthToken();

Swift

let token = sdk.contextManager().getCloudAuthToken()

JavaScript

const token = sdk.contextManager().getCloudAuthToken();

C#

var token = sdk.GetContextManager().GetCloudAuthToken();

Python

token = sdk.contextManager.get_cloud_auth_token()

Is cloud auth token invalid or expired

Checks whether the cloud auth token from the context can still be used:

• A token that is missing, invalid or expires within the next 24 hours is first refreshed with the stored refresh token. This is a network request, performed regardless of checkServerInvalidation.
• It returns true only when the token could not be refreshed and is missing, invalid or past its expiration. A token that could not be refreshed but has not expired yet is still valid, since the backend accepts it until then.
• When checkServerInvalidation is true, a token that passes the checks above is also verified with the backend (an additional network request). When false, the token might be accepted even if it has been invalidated on the server.

Kotlin

// Returns a Boolean
val result = sdk.contextManager().isCloudAuthTokenInvalidOrExpired(true)

Java

// Returns a CompletableFuture<Boolean>
var result = sdk.contextManager().isCloudAuthTokenInvalidOrExpiredAsync(true);

Swift

// Returns a Bool asynchronously
let result = await sdk.contextManager().isCloudAuthTokenInvalidOrExpired(checkServerInvalidation: true)

JavaScript

// Returns a Promise<boolean>
const result = await sdk.contextManager().isCloudAuthTokenInvalidOrExpired(true);

C#

// Returns a Task<bool>
var result = await sdk.GetContextManager().IsCloudAuthTokenInvalidOrExpired(checkServerInvalidation: true);

Python

# Returns a Future[SimpleNamespace]
result = await sdk.contextManager.is_cloud_auth_token_invalid_or_expired(True)

Set cloud refresh token

It is set automatically by login, register, and refresh-tokens. Passing null removes the stored token.

info

While a refresh token is stored, the SDK refreshes the cloud auth token automatically: before a request, when the auth token is missing, invalid or expires within the next 24 hours, and once more after an unauthorized response. A refresh token rejected by the backend is removed from the context.

Kotlin

sdk.contextManager().setCloudRefreshToken("REFRESH_TOKEN")

Java

sdk.contextManager().setCloudRefreshToken("REFRESH_TOKEN");

Swift

sdk.contextManager().setCloudRefreshToken(token: "REFRESH_TOKEN")

JavaScript

sdk.contextManager().setCloudRefreshToken("REFRESH_TOKEN");

C#

sdk.GetContextManager().SetCloudRefreshToken("REFRESH_TOKEN");

Python

sdk.contextManager.set_cloud_refresh_token("REFRESH_TOKEN")

Get cloud refresh token

Kotlin

val token = sdk.contextManager().getCloudRefreshToken()

Java

var token = sdk.contextManager().getCloudRefreshToken();

Swift

let token = sdk.contextManager().getCloudRefreshToken()

JavaScript

const token = sdk.contextManager().getCloudRefreshToken();

C#

var token = sdk.GetContextManager().GetCloudRefreshToken();

Python

token = sdk.contextManager.get_cloud_refresh_token()

Set fusion host

Sets the host of the on-premise Fusion server used by the fusion resource. It can be changed at any time, although it is recommended to set it up through the SdkConfig builder instead.

Kotlin

sdk.contextManager().setFusionHost(URI("http://localhost:27700"))

Java

sdk.contextManager().setFusionHost(URI.create("http://localhost:27700"));

Swift

sdk.contextManager().setFusionHost(host: NSURLComponents(string: "http://localhost:27700")!)

JavaScript

sdk.contextManager().setFusionHost("http://localhost:27700");

C#

sdk.GetContextManager().SetFusionHost("http://localhost:27700");

Python

sdk.contextManager.set_fusion_host("http://localhost:27700")

Get fusion host

Returns the currently configured Fusion host. Defaults to http://localhost:27700 when it has never been set.

Kotlin

// Returns a URI
val fusionHost = sdk.contextManager().getFusionHost()

Java

// Returns a URI
var fusionHost = sdk.contextManager().getFusionHost();

Swift

// Returns an NSURLComponents
let fusionHost = sdk.contextManager().getFusionHost()

JavaScript

// Returns a string
const fusionHost = sdk.contextManager().getFusionHost();

C#

// Returns a string
var fusionHost = sdk.GetContextManager().GetFusionHost();

Python

# Returns a str
fusionHost = sdk.contextManager.get_fusion_host()

Set fusion auth token

It is set automatically by fusion login.

Kotlin

sdk.contextManager().setFusionAuthToken("FUSION_AUTH_TOKEN")

Java

sdk.contextManager().setFusionAuthToken("FUSION_AUTH_TOKEN");

Swift

sdk.contextManager().setFusionAuthToken(token: "FUSION_AUTH_TOKEN")

JavaScript

sdk.contextManager().setFusionAuthToken("FUSION_AUTH_TOKEN");

C#

sdk.GetContextManager().SetFusionAuthToken("FUSION_AUTH_TOKEN");

Python

sdk.contextManager.set_fusion_auth_token("FUSION_AUTH_TOKEN")

Get fusion auth token

Kotlin

val token = sdk.contextManager().getFusionAuthToken()

Java

var token = sdk.contextManager().getFusionAuthToken();

Swift

let token = sdk.contextManager().getFusionAuthToken()

JavaScript

const token = sdk.contextManager().getFusionAuthToken();

C#

var token = sdk.GetContextManager().GetFusionAuthToken();

Python

token = sdk.contextManager.get_fusion_auth_token()

Set user ID

Sets the user identifier used by the secure lock operations. It is usually set for you by set operation context, register ephemeral key and verify ephemeral key.

Kotlin

sdk.contextManager().setUserId(USER_ID)

Java

sdk.contextManager().setUserId(USER_ID);

Swift

sdk.contextManager().setUserId(userId: USER_ID)

JavaScript

sdk.contextManager().setUserId("USER_ID");

C#

sdk.GetContextManager().SetUserId(USER_ID);

Python

sdk.contextManager.set_user_id("USER_ID")

Get user ID

Kotlin

// Returns a UUID
val userId = sdk.contextManager().getUserId()

Java

// Returns a UUID
var userId = sdk.contextManager().getUserId();

Swift

// Returns an NSUUID
let userId = sdk.contextManager().getUserId()

JavaScript

// Returns a string
const userId = sdk.contextManager().getUserId();

C#

// Returns a Guid
var userId = sdk.GetContextManager().GetUserId();

Python

# Returns a str
userId = sdk.contextManager.get_user_id()

Set user email

Sets the email address associated with the context. It is set automatically by login and registration.

Kotlin

sdk.contextManager().setUserEmail("EMAIL")

Java

sdk.contextManager().setUserEmail("EMAIL");

Swift

sdk.contextManager().setUserEmail(email: "EMAIL")

JavaScript

sdk.contextManager().setUserEmail("EMAIL");

C#

sdk.GetContextManager().SetUserEmail("EMAIL");

Python

sdk.contextManager.set_user_email("EMAIL")

Get user email

Kotlin

val email = sdk.contextManager().getUserEmail()

Java

var email = sdk.contextManager().getUserEmail();

Swift

let email = sdk.contextManager().getUserEmail()

JavaScript

const email = sdk.contextManager().getUserEmail();

C#

var email = sdk.GetContextManager().GetUserEmail();

Python

email = sdk.contextManager.get_user_email()

Set certificate chain

Sets the certificate chain used to sign the secure lock operations. It is usually set for you by set operation context, register ephemeral key and verify ephemeral key.

info

Only the first certificate of the chain is inspected by is certificate chain invalid or expired.

Kotlin

sdk.contextManager().setCertificateChain(USER_CERTIFICATE_CHAIN_LIST)

Java

sdk.contextManager().setCertificateChain(USER_CERTIFICATE_CHAIN_LIST);

Swift

sdk.contextManager().setCertificateChain(certificateChain: USER_CERTIFICATE_CHAIN_LIST)

JavaScript

sdk.contextManager().setCertificateChain(USER_CERTIFICATE_CHAIN_LIST);

C#

// Not implemented yet

Python

// Not implemented yet

Get certificate chain

Returns the stored certificate chain, or null when none has been set.

Kotlin

// Returns a List<X509Certificate>
val certificateChain = sdk.contextManager().getCertificateChain()

Java

// Returns a List<X509Certificate>
var certificateChain = sdk.contextManager().getCertificateChain();

Swift

// Returns a [String]
let certificateChain = sdk.contextManager().getCertificateChain()

JavaScript

// Returns a string[]
const certificateChain = sdk.contextManager().getCertificateChain();

C#

// Not implemented yet

Python

// Not implemented yet

Is certificate chain invalid or expired

Checks if the current certificate chain from the context is invalid or expired (we consider it expired if it will expire within the next 7 days).

Kotlin

val result = sdk.contextManager().isCertificateChainInvalidOrExpired()

Java

var result = sdk.contextManager().isCertificateChainInvalidOrExpired();

Swift

let result = sdk.contextManager().isCertificateChainInvalidOrExpired()

JavaScript

const result = sdk.contextManager().isCertificateChainInvalidOrExpired();

C#

var result = sdk.GetContextManager().IsCertificateChainInvalidOrExpired();

Python

result = sdk.contextManager.is_certificate_chain_invalid_or_expired()

Set key pair

Sets the key pair used to sign the secure lock operations. It is usually set for you by set operation context, register ephemeral key and verify ephemeral key.

info

Setting a new key pair does not mark it as verified. Use set key pair verified, or register it through register ephemeral key plus and verify ephemeral key.

Kotlin

sdk.contextManager().setKeyPair(KEY_PAIR)

Java

sdk.contextManager().setKeyPair(KEY_PAIR);

Swift

sdk.contextManager().setKeyPair(
  publicKey: PUBLIC_KEY, 
  privateKey: PRIVATE_KEY
)

JavaScript

sdk.contextManager().setKeyPair(PUBLIC_KEY, PRIVATE_KEY);

C#

// Not implemented yet

Python

// Not implemented yet

Get key pair

Returns the stored key pair, or null when either the public or the private key is missing.

Kotlin

// Returns a KeyPair
val keyPair = sdk.contextManager().getKeyPair()

Java

// Returns a KeyPair
var keyPair = sdk.contextManager().getKeyPair();

Swift

// Returns a Crypto.KeyPair
let keyPair = sdk.contextManager().getKeyPair()

JavaScript

// Returns a Crypto.KeyPair
const keyPair = sdk.contextManager().getKeyPair();

C#

// Not implemented yet

Python

// Not implemented yet

Set key pair verified

Marks a public key as verified, meaning it has successfully completed two-factor verification. Pass null to clear the verification.

info

Is key pair verified compares the value stored here against the current public key, so setting a key pair that does not match clears the verified state in practice.

Kotlin

sdk.contextManager().setKeyPairVerified(PUBLIC_KEY)

Java

sdk.contextManager().setKeyPairVerified(PUBLIC_KEY);

Swift

sdk.contextManager().setKeyPairVerified(publicKey: PUBLIC_KEY)

JavaScript

sdk.contextManager().setKeyPairVerified(PUBLIC_KEY);

C#

// Not implemented yet

Python

// Not implemented yet

Is key pair verified

Checks if the current key pair from the context has been verified.

Kotlin

val result = sdk.contextManager().isKeyPairVerified()

Java

var result = sdk.contextManager().isKeyPairVerified();

Swift

let result = sdk.contextManager().isKeyPairVerified()

JavaScript

const result = sdk.contextManager().isKeyPairVerified();

C#

var result = sdk.GetContextManager().IsKeyPairVerified();

Python

result = sdk.contextManager.is_key_pair_verified()

Is key pair valid

Checks if the current key pair from the context is valid.

Kotlin

val result = sdk.contextManager().isKeyPairValid()

Java

var result = sdk.contextManager().isKeyPairValid();

Swift

let result = sdk.contextManager().isKeyPairValid()

JavaScript

const result = sdk.contextManager().isKeyPairValid();

C#

var result = sdk.GetContextManager().IsKeyPairValid();

Python

result = sdk.contextManager.is_key_pair_valid()

Set operation context

Kotlin

sdk.contextManager().setOperationContext(
  userId = USER_ID,
  certificateChain = USER_CERTIFICATE_CHAIN_LIST,
  keyPair = KEY_PAIR,
  isKeyPairVerified = IS_KEY_PAIR_VERIFIED
)

Java

sdk.contextManager().setOperationContext(USER_ID, USER_CERTIFICATE_CHAIN_LIST, KEY_PAIR, IS_KEY_PAIR_VERIFIED);

Swift

sdk.contextManager().setOperationContext(
  userId: USER_ID, 
  certificateChain: USER_CERTIFICATE_CHAIN_LIST, 
  publicKey: PUBLIC_KEY, 
  privateKey: PRIVATE_KEY,
  isKeyPairVerified: IS_KEY_PAIR_VERIFIED
)

JavaScript

sdk.contextManager().setOperationContext(
  "USER_ID", 
  USER_CERTIFICATE_CHAIN_LIST, 
  PUBLIC_KEY, 
  PRIVATE_KEY
);

C#

sdk.GetContextManager().SetOperationContext(
  userId: USER_ID, 
  certificateChain: USER_CERTIFICATE_CHAIN, 
  publicKey: PUBLIC_KEY, 
  privateKey: PRIVATE_KEY
);

Python

sdk.contextManager.set_operation_context(
  "USER_ID", 
  "USER_CERTIFICATE_CHAIN_AS_STRING", 
  "BASE64_PUBLIC_KEY", 
  "BASE64_PRIVATE_KEY"
)

Get Context State

Checks the state of the context by verifying that the auth token is valid, the key pair is valid and verified, and the certificate chain is valid. The first check to fail determines the returned state. checkServerInvalidation behaves as described in is cloud auth token invalid or expired.

Kotlin

// Returns a ContextState
val result = sdk.contextManager().getContextState(true)

Java

// Returns a CompletableFuture<ContextState>
var result = sdk.contextManager().getContextStateAsync(true);

Swift

// Returns a ContextState asynchronously
let result = await sdk.contextManager().getContextState(checkServerInvalidation: true)

JavaScript

// Returns a Promise<string>
const result = await sdk.contextManager().getContextState(true);

C#

// Returns a Task<ContextState>
var result = await sdk.GetContextManager().GetContextState(checkServerInvalidation: true);

Python

# Returns a Future[SimpleNamespace]
result = await sdk.contextManager.get_context_state(True)

Clear context

This function removes all stored context fields from the secure storage.

Kotlin

sdk.contextManager().clearContext()

Java

sdk.contextManager().clearContext();

Swift

sdk.contextManager().clearContext()

JavaScript

sdk.contextManager().clearContext();

C#

sdk.GetContextManager().ClearContext();

Python

sdk.contextManager.clear_context()