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 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. When checkServerInvalidation is set to true, it also checks if the auth token has been invalidated on the backend. This requires a network request. When checkServerInvalidation is false, this server check is skipped, meaning the auth token might be accepted even if it has been invalidated.

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)

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()

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()

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()

Set cloud auth token

If the SDK was initialized without an authentication token, you can provide or update the token using this function.

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 if the current cloud auth token from the context is invalid, expired (we consider it expired if it will expire within the next 24 hours) or invalidated. When checkServerInvalidation is set to true, it also checks if the auth token has been invalidated on the backend. This requires a network request. When checkServerInvalidation is false, this server check is skipped, meaning the auth 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

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 auth token

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()

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()