API ReferenceManagementWallet Management
GET
/v1/mgmt/wallet/settings

Authorization

Descope Project ID and Management Key
AuthorizationBearer <token>

Project ID:Management Key as bearer token.

In: header

Get the project's wallet settings, using a valid management key.

curl -X GET "https://api.descope.com/v1/mgmt/wallet/settings"
{  "enabled": true,  "testMode": false,  "verifyEnabled": true,  "authEnabled": true,  "allowedClaims": null,  "defaultClaims": null,  "webOrigins": null,  "androidFingerprints": null,  "apple": {    "enabled": true,    "readerCredentials": [      {        "host": "string",        "certificateChain": "string",        "privateKey": "string"      }    ],    "teamId": "string",    "merchantId": "string",    "merchantKey": "string"  },  "google": {    "enabled": true,    "signingKey": "string",    "certificateChain": "string",    "rpMetadata": "string"  }}
/** * Wallet ID verification settings. Private keys read back as PLACEHOLDER_VALUE, which keeps the stored key when sent back. */export interface Response {/** * Turns wallet on for the project. Default false. */enabled?: boolean/** * Accepts test IDs, such as CMWallet and Apple's developer mock. Default false. */testMode?: boolean/** * Allows verifying an ID without linking it to a user. Default true. */verifyEnabled?: boolean/** * Allows linking an ID to a user and using it for MFA and step-up. Default false. */authEnabled?: boolean/** * Allowed {namespace, element} claims. Default: issuing_authority, age_over_NN, issuing_country, issuing_jurisdiction, issue_date, expiry_date. */allowedClaims?: {[k: string]: unknown}/** * Claims requested when the caller names none, as a list of {namespace, element, intentToRetain}. Default is issuing_authority. */defaultClaims?: {[k: string]: unknown}/** * Exact website origins allowed to call the wallet, such as https://id.example.com. Empty means the project's approved domains. */webOrigins?: {[k: string]: unknown}/** * SHA-256 signing certificate fingerprints of Android apps allowed to call the wallet. Default empty. */androidFingerprints?: {[k: string]: unknown}/** * Apple Wallet settings, for Safari and iOS apps. */apple?: WalletApple/** * Google Wallet settings, for Android. */google?: WalletGoogle}export interface WalletApple {/** * Offers Apple Wallet. Default false. */enabled?: boolean/** * Reader credentials for Safari, one per website host. *  * @maxItems 20 */readerCredentials?: []|[WalletReaderCredential]|[WalletReaderCredential, WalletReaderCredential]|[WalletReaderCredential, WalletReaderCredential, WalletReaderCredential]|[WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential]|[WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential]|[WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential]|[WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential]|[WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential]|[WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential]|[WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential]|[WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential]|[WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential]|[WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential]|[WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential]|[WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential]|[WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential]|[WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential]|[WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential]|[WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential]|[WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential, WalletReaderCredential]/** * Apple Developer team ID of the iOS apps. */teamId?: string/** * Merchant ID used by the iOS apps. */merchantId?: string/** * PEM private key of the merchant's Identity Access certificate. */merchantKey?: string}export interface WalletReaderCredential {/** * Website host the credential is for. */host: string/** * PEM certificate chain Apple issued for the host, leaf first. */certificateChain?: string/** * PEM private key of the leaf certificate. */privateKey?: string}export interface WalletGoogle {/** * Offers Google Wallet and other Android wallets. Default false. */enabled?: boolean/** * PEM request signing key. Required unless testMode is on. */signingKey?: string/** * PEM certificate chain Google issued for the signing key, leaf first. */certificateChain?: string/** * RP metadata exactly as Google issued it. */rpMetadata?: string}
Was this helpful?