Account resource

Request a new refresh token

warning

This function is only available to users with Sentry Interactive issued auth tokens.

info

• When used successfully, the cloud auth token and cloud refresh token from the response are added to the context manager and automatically stored in secure storage.
• This function can be used with the refresh token value from the context. To use the value from the context, you should pass null as the function parameter.
• The SDK also refreshes the tokens automatically.

Kotlin

// Returns a TokenResponse
val response = sdk.account().refreshToken("REFRESH_TOKEN")

Java

// Returns a CompletableFuture<TokenResponse>
var response = sdk.account().refreshTokenAsync("REFRESH_TOKEN");

Swift

// Returns a TokenResponse asynchronously
let response = await sdk.account().refreshToken(refreshToken: "REFRESH_TOKEN")

JavaScript

// Returns a Promise<TokenResponse>
const response = await com.doordeck.multiplatform.sdk.api.account().refreshToken("REFRESH_TOKEN");

C#

// Returns a Task<TokenResponse>
var response = await sdk.GetAccount().RefreshToken("REFRESH_TOKEN");

Python

# Returns a Future[SimpleNamespace]
response = await sdk.account.refresh_token("REFRESH_TOKEN")

Logout

warning

When used, the context manager restarts, and the values from the secure storage are automatically deleted.

Kotlin

// Returns Unit
sdk.account().logout()

Java

// Returns a CompletableFuture<Void>
sdk.account().logoutAsync();

Swift

// Returns Void asynchronously
await sdk.account().logout()

JavaScript

// Returns a Promise<any>
await com.doordeck.multiplatform.sdk.api.account().logout();

C#

// Returns a Task<object>
await sdk.GetAccount().Logout();

Python

# Returns a Future[SimpleNamespace]
await sdk.account.logout()

Register ephemeral key

To register a new ephemeral key, you will need to generate a new key pair.

info

• When used successfully, both the supplied private and public keys are added to the context manager and automatically stored in secure storage, along with the user ID and user certificate chain from the response.
• If your context manager already has public and private keys, you can pass null for those parameters, and those values will be retrieved from the context manager instead.

Kotlin

// Returns a RegisterEphemeralKeyResponse
val response = sdk.account().registerEphemeralKey(KEY_PAIR)

Java

// Returns a CompletableFuture<RegisterEphemeralKeyResponse>
var response = sdk.account().registerEphemeralKeyAsync(KEY_PAIR);

Swift

// Returns a RegisterEphemeralKeyResponse asynchronously
let response = await sdk.account().registerEphemeralKey(
  publicKey: PUBLIC_KEY, 
  privateKey: PRIVATE_KEY
)

JavaScript

// Returns a Promise<RegisterEphemeralKeyResponse>
const response = await com.doordeck.multiplatform.sdk.api.account().registerEphemeralKey(
  PUBLIC_KEY, 
  PRIVATE_KEY
);

C#

// Returns a Task<RegisterEphemeralKeyResponse>
var response = await sdk.GetAccount().RegisterEphemeralKey(
  publicKey: PUBLIC_KEY, 
  privateKey: PRIVATE_KEY
);

Python

# Returns a Future[SimpleNamespace]
response = await sdk.account.register_ephemeral_key(
  "BASE64_PUBLIC_KEY", 
  "BASE64_PRIVATE_KEY"
)

Register ephemeral key with secondary authentication

To register a new ephemeral key with secondary authentication, you will need to generate a new key pair. After the registration, you will need to verify the ephemeral key registration.

info

If your context manager already has public key, you can pass null for that parameter, and the value will be retrieved from the context manager instead.

Kotlin

// Returns a RegisterEphemeralKeyWithSecondaryAuthenticationResponse
val response = sdk.account().registerEphemeralKeyWithSecondaryAuthentication(PUBLIC_KEY)

Java

// Returns a CompletableFuture<RegisterEphemeralKeyWithSecondaryAuthenticationResponse>
var response = sdk.account().registerEphemeralKeyWithSecondaryAuthenticationAsync(PUBLIC_KEY);

Swift

// Returns a RegisterEphemeralKeyWithSecondaryAuthenticationResponse asynchronously
let response = await sdk.account().registerEphemeralKeyWithSecondaryAuthentication(
  publicKey: PUBLIC_KEY, 
  method: nil
)

JavaScript

// Returns a Promise<RegisterEphemeralKeyWithSecondaryAuthenticationResponse>
const response = await com.doordeck.multiplatform.sdk.api.account().registerEphemeralKeyWithSecondaryAuthentication(PUBLIC_KEY);

C#

// Returns a Task<RegisterEphemeralKeyWithSecondaryAuthenticationResponse>
var response = await sdk.GetAccount().RegisterEphemeralKeyWithSecondaryAuthentication(PUBLIC_KEY);

Python

# Returns a Future[SimpleNamespace]
response = await sdk.account.register_ephemeral_key_with_secondary_authentication("BASE64_PUBLIC_KEY")

Verify ephemeral key registration

info

• When used successfully, both the supplied private and public keys are added to the context manager and automatically stored in secure storage, along with the user ID and user certificate chain from the response.
• If your context manager already has public and private keys, you can pass null for those parameters, and those values will be retrieved from the context manager instead.

Kotlin

// Returns a RegisterEphemeralKeyResponse
val response = sdk.account().verifyEphemeralKeyRegistration(
  code = "CODE", 
  keyPair = KEY_PAIR
)

Java

// Returns a CompletableFuture<RegisterEphemeralKeyResponse>
var response = sdk.account().verifyEphemeralKeyRegistrationAsync("CODE", KEY_PAIR);

Swift

// Returns a RegisterEphemeralKeyResponse asynchronously
let response = await sdk.account().verifyEphemeralKeyRegistration(
  code: "CODE", 
  publicKey: PUBLIC_KEY, 
  privateKey: PRIVATE_KEY
)

JavaScript

// Returns a Promise<RegisterEphemeralKeyResponse>
const response = await com.doordeck.multiplatform.sdk.api.account().verifyEphemeralKeyRegistration(
  "CODE", 
  PUBLIC_KEY, 
  PRIVATE_KEY
);

C#

// Returns a Task<RegisterEphemeralKeyResponse>
var response = await sdk.GetAccount().VerifyEphemeralKeyRegistration(
  code: "CODE", 
  publicKey: PUBLIC_KEY, 
  privateKey: PRIVATE_KEY
 );

Python

# Returns a Future[SimpleNamespace]
response = await sdk.account.verify_ephemeral_key_registration(
  "CODE", 
  "BASE64_PUBLIC_KEY", 
  "BASE64_PRIVATE_KEY"
)

Re-verify email

warning

This function is only available to users with Sentry Interactive issued auth tokens.

Kotlin

// Returns Unit
sdk.account().reverifyEmail()

Java

// Returns a CompletableFuture<Void>
sdk.account().reverifyEmailAsync();

Swift

// Returns Void asynchronously
await sdk.account().reverifyEmail()

JavaScript

// Returns a Promise<any>
await com.doordeck.multiplatform.sdk.api.account().reverifyEmail();

C#

// Returns a Task<object>
await sdk.GetAccount().ReverifyEmail();

Python

# Returns a Future[SimpleNamespace]
await sdk.account.reverify_email()

Change password

warning

This function is only available to users with Sentry Interactive issued auth tokens.

Kotlin

// Returns Unit
sdk.account().changePassword(
  oldPassword = "OLD_PASSWORD", 
  newPassword = "NEW_PASSWORD"
)

Java

// Returns a CompletableFuture<Void>
sdk.account().changePasswordAsync("OLD_PASSWORD", "NEW_PASSWORD");

Swift

// Returns Void asynchronously
await sdk.account().changePassword(
  oldPassword: "OLD_PASSWORD", 
  newPassword: "NEW_PASSWORD"
)

JavaScript

// Returns a Promise<any>
await com.doordeck.multiplatform.sdk.api.account().changePassword(
  "OLD_PASSWORD", 
  "NEW_PASSWORD"
);

C#

// Returns Task<object>
await sdk.GetAccount().ChangePassword(
  oldPassword: "OLD_PASSWORD", 
  newPassword: "NEW_PASSWORD"
);

Python

# Returns a Future[SimpleNamespace]
await sdk.account.change_password(
  "OLD_PASSWORD", 
  "NEW_PASSWORD"
)

Get user details

Kotlin

// Returns a UserDetailsResponse
val response = sdk.account().getUserDetails()

Java

// Returns a CompletableFuture<UserDetailsResponse>
var response = sdk.account().getUserDetailsAsync();

Swift

// Returns a UserDetailsResponse asynchronously
let response = await sdk.account().getUserDetails()

JavaScript

// Returns a Promise<UserDetailsResponse>
const response = await com.doordeck.multiplatform.sdk.api.account().getUserDetails();

C#

// Returns a Task<UserDetailsResponse>
var response = await sdk.GetAccount().GetUserDetails();

Python

# Returns a Future[SimpleNamespace]
response = await sdk.account.get_user_details()

Update user details

Kotlin

// Returns Unit
sdk.account().updateUserDetails("DISPLAY_NAME")

Java

// Returns a CompletableFuture<Void>
sdk.account().updateUserDetailsAsync("DISPLAY_NAME");

Swift

// Returns Void asynchronously
await sdk.account().updateUserDetails(displayName: "DISPLAY_NAME")

JavaScript

// Returns a Promise<any>
await com.doordeck.multiplatform.sdk.api.account().updateUserDetails("DISPLAY_NAME");

C#

// Returns a Task<object>
await sdk.GetAccount().UpdateUserDetails("DISPLAY_NAME");

Python

# Returns a Future[SimpleNamespace]
await sdk.account.update_user_details("DISPLAY_NAME")

Delete account

danger

This operation is executed instantly and is irreversible.

info

When used successfully, the context manager restarts, and the values from the secure storage are automatically deleted. If the request fails, the context is kept.

Kotlin

// Returns Unit
sdk.account().deleteAccount()

Java

// Returns a CompletableFuture<Void>
sdk.account().deleteAccountAsync();

Swift

// Returns Void asynchronously
await sdk.account().deleteAccount()

JavaScript

// Returns a Promise<any>
await com.doordeck.multiplatform.sdk.api.account().deleteAccount();

C#

// Returns a Task<object>
await sdk.GetAccount().DeleteAccount();

Python

# Returns a Future[SimpleNamespace]
await sdk.account.delete_account()