AccountState

Experimental

The one account payload shape: the account/read result and the account/changed params. Closed vocabulary; label is a display string that never carries key material and is omitted, never null, when absent.

Fields and variants

• credentialRequired — Experimental
• label — Experimental
• state — Experimental

Source

schema/msp/experimental/msp.schema.json#/types/AccountState

{
  "description": "The one account payload shape: the `account/read` result and the\n`account/changed` params. Closed vocabulary; `label` is a display string that never carries key material and is omitted, never `null`, when absent.",
  "properties": {
    "credentialRequired": {
      "description": "`false` exactly when the effective provider endpoint needs no caller\ncredential, so those clients\nnever nag the user to sign in.",
      "type": "boolean"
    },
    "label": {
      "description": "Optional display label for the credential in effect (for example the\naccount identity for `accountLogin`); never key material.",
      "type": "string"
    },
    "state": {
      "$ref": "#/$defs/AccountStateKind",
      "description": "Which credential lane is in effect."
    }
  },
  "required": [
    "credentialRequired",
    "state"
  ],
  "type": "object",
  "x-msp-descriptor": "account/read",
  "x-msp-stability": "experimental"
}