LogoLogo
  • Platform Overview
  • 🗺️Guides
    • Getting Started
    • Users
      • Integrate the User SDK
      • Registration
      • Authentication
      • SDK Releases
      • API Reference
    • Entitlements
      • Administrative API
        • Integrating the Administrative API
        • Entitlement Definitions
        • Managing Entitlements Sets
        • Managing Entitlements Sequences
        • Managing User Entitlements
        • API Schema
      • End-user API
        • Integrate the Entitlements SDK
        • Redeeming Entitlements
        • Retrieving Entitlements
        • SDK Releases
        • API Reference
    • Sudos
      • Integrate the Sudo Profiles SDK
      • Sudo Entitlements
      • Manage Sudos
      • SDK Releases
      • API Reference
    • Telephony
      • Integrate the Telephony SDK
      • Manage Phone Numbers
      • Text Messaging
      • Voice Calling
      • Telephony Simulator
      • SDK Releases
      • API Reference
    • Email
      • Integrate the Email SDK
      • Email Entitlements
      • Manage Email Addresses
      • Sending & Receiving Email
      • Manage Email Folders
      • Draft Email Messages
      • Manage Email Address Blocklists
      • Email Address Public Information
      • Pagination
      • Caching
      • Configuration Data
      • Email Notifications
      • SDK Releases
      • API Reference
    • Decentralized Identity
      • Edge Agent
        • Relay SDK
          • Integrate the Relay SDK
          • Relay Entitlements
          • Manage Relay Postboxes
          • Manage Relay Messages
          • Receiving Messages
          • SDK Releases
        • Edge Agent SDK
          • Integrate the Edge Agent SDK
          • Agent Management
          • Manage Wallets
          • Establishing Connections
          • Manage Connections
          • Messaging
          • Manage DIDs
          • Accepting New Credentials
          • Manage Credentials
          • Present Credentials for Verification
          • Utilize Alternative Cryptography Providers
          • SDK Releases
          • Standards and Protocols
      • Cloud Agent
        • Cloud Agent Admin API
          • Integrate the Cloud Agent Admin API
          • Aries Interop Profile (AIP)
            • Connection Exchanges
            • Credential Exchanges
            • Proof Exchanges
          • Connections
          • Basic Messages
          • Credentials
            • Anoncreds Credentials
              • Schemas
              • Credential Definitions
            • W3C Credentials
          • Audit Logs
          • API Schema
          • Error Codes
          • Standards and Protocols
    • Virtual Cards
      • Integrate the Virtual Cards SDK
      • Virtual Cards Entitlements
      • Virtual Cards Transaction Velocity Constraints
      • Key Management
      • Manage Funding Sources
      • Manage Virtual Cards
      • Manage Transactions
      • Configuration Data
      • Pagination
      • Caching
      • SDK Releases
      • API Reference
    • Virtual Cards Simulator
      • Integrate the Virtual Cards Simulator SDK
      • Simulate Authorizations
      • Simulate Debits
      • Simulate Refunds
      • Simulate Reversals
      • Merchants and Currencies
      • SDK Releases
      • API Reference
    • Virtual Private Network
      • Integrate the VPN SDK
      • VPN Entitlements
      • Manage Servers
      • Manage Connection
      • Observe VPN Related Events
      • SDK Releases
      • API Reference
      • Frequently Asked Questions
    • Secure ID Verification
      • Integrate the Secure ID Verification SDK
      • List Supported Countries
      • Verify an Identity
      • Check Secure ID Verification Status
      • Use the Secure ID Verification Simulator
      • SDK Releases
      • API Reference
    • Password Manager
      • Integrate the Password Manager SDK
      • Accessing the Password Manager
      • Managing Password Vaults
      • Managing Password Vault Items
      • Vault Import and Export
      • Password Utilities
      • Password Manager Entitlements
      • Password Vault Security
      • SDK Releases
      • API Reference
    • Ad/Tracker Blocker
      • Integrate the Ad/Tracker Blocker SDK
      • Manage Rulesets
      • Blocking Ads and Trackers
      • Manage Exceptions
      • SDK Releases
      • API Reference
    • Site Reputation
      • Integrate the Site Reputation SDK
      • Use the Site Reputation SDK
      • SDK Releases
      • API Reference
  • 💡Concepts
    • Sudo Digital Identities
  • 🧱Development
    • Versioning
  • 🏢Administration
    • Admin Console Roles
  • ❓Get Help
    • Request a Demo
    • Report an Issue
Powered by GitBook
On this page
  1. Guides
  2. Entitlements
  3. End-user API

Redeeming Entitlements

Entitlements API for redeeming user entitlements

PreviousIntegrate the Entitlements SDKNextRetrieving Entitlements

Last updated 28 days ago

A federated user must be registered with the Sudo Platform entitlements service before they can access other entitled services in their environment. This process is called redeeming entitlements.

Entitlement redemption must occur the first time a federated user signs in to the Sudo Platform. However, it is an idempotent operation and subsequent calls will have no effect.

The redemption operation uses information in the user's identity token and takes no parameters.

  do {
    let redeemed = try await entitlementsClient.redeemEntitlements()
    // Handle success
  } catch {
    // Handle error
  }
try {
  val entitlements = entitlementsClient.redeemEntitlements()
  // Handle redeemed entitlements
}
catch (e: SudoEntitlements.EntitlementsException) {
  // Handle error
}
try {
  const entitlements = await entitlementsClient.redeemEntitlements()
  // Handle redeemed entitlements
}
catch (err) {
  // Handle error
}

The redeemEntitlements method returns the user's entitlements. See the for details of the returned structure.

Errors

The redeemEntitlements API will throw errors in the the following circumstances:

Condition

Action

.notSignedIn

User was not signed in when redeemEntitlements was invoked.

Ensure user is signed in prior to invoking redeemEntitlements

.ambiguousEntitlements

User has been configured to match more than one entitlements set.

Ensure your identity provider has been set up to include claims that in the user's token that will map to exactly one entitlements set.

.invalidToken

The user's token does not contain a claim that can be mapped to an entitlements set, or has the user been pre-configured with initial entitlements.

Ensure your identity provider has been set up to include an expected claim when federating sign-on or pre-configure the user with entitlements.

.serviceError

A transient error occurred in the service while redeeming entitlements.

Retry the request. If the problem persists,

Errors in Kotlin are thrown as exceptions in the SudoEntitlementsClient.EntitlementsException class name space.

Condition

Action

NotSignedInException

User was not signed in when redeemEntitlements was invoked.

Ensure user is signed in prior to invoking redeemEntitlements

AmbiguousEmtitlementsException

User has been configured to match more than one entitlements set.

Ensure your identity provider has been set up to include claims that in the user's token that will map to exactly one entitlements set.

InvalidTokenException

The user's token does not contain a claim that can be mapped to an entitlements set, or has the user been pre-configured with initial entitlements.

Ensure your identity provider has been set up to include an expected claim when federating sign-on or pre-configure the user with entitlements.

UnknownException

A transient error occurred in the service while redeeming entitlements.

Retry the request. If the problem persists,

Condition

Action

NotSignedInError

User was not signed in when redeemEntitlements was invoked.

Ensure user is signed in prior to invoking redeemEntitlements

AmbiguousEntitlementsError

User has been configured to match more than one entitlements set.

Ensure your identity provider has been set up to include claims that in the user's token that will map to exactly one entitlements set.

InvalidTokenError

The user's token does not contain a claim that can be mapped to an entitlements set, or has the user been pre-configured with initial entitlements.

Ensure your identity provider has been set up to include an expected claim when federating sign-on or pre-configure the user with entitlements.

ServiceError

A transient error occurred in the service while redeeming entitlements.

Retry the request. If the problem persists,

🗺️
API Reference
ask us for help
ask us for help
ask us for help