Payload class

Consumer requests that the vault maintainer perform a login at the bound third-party site on the consumer's behalf, using the entry's secret material WITHOUT releasing it to the consumer. The maintainer returns a SessionBlob in a pluggable cipher envelope (see vault/_shared/0.1/sealed-envelope) containing the resulting cookies/headers the consumer can use to operate the session — but never the long-term credential.

Constructors

Payload({required String entryId, SiteTarget? target, ConsumerContext? consumerContext, StepUpProof? stepUpProof, String? nonce, int? ttlSecondsHint, Ext? ext})
const
Payload.fromJson(Map<String, dynamic> json)
Read this payload from a decoded JSON object.
factory

Properties

consumerContext → ConsumerContext?
Caller's situational context — fed to the maintainer's policy engine to decide proxy vs fill, require step-up, etc. Producers populate what they can observe; fields are advisory and the maintainer MUST cross-check anything security-relevant against its own state.
final
entryId → String
Vault entry id to log in with.
final
ext → Ext?
final
hashCode → int
The hash code for this object.
no setterinherited
nonce → String?
Optional caller-supplied nonce the maintainer SHOULD embed verbatim in the resulting session credential when one applies — typically the relying party's challenge for SIOPv2-shaped flows, where the SIOP id_token's nonce claim MUST match the RP's authorization-request nonce for the RP to verify the token. When omitted, the maintainer generates its own nonce; that path is appropriate for flows where the consumer doesn't need to bind the credential to an external challenge (e.g. push-mode logins that don't pre-fetch a challenge). Drivers that have no nonce concept (Password POST, OAuth refresh) ignore this field.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
stepUpProof → StepUpProof?
Optional — included on retry after a prior proxy-login attempt returned stepUpRequired.
final
target → Object?
Optional — when an entry has multiple targets, names which one the consumer is acting against. The maintainer matches this against the entry's targets\[\]; if not supplied, the maintainer chooses the most specific target compatible with the requesting consumer's form factor (e.g. an iOS Companion gets the iOS-app target if one exists; otherwise the web-origin target).
final
ttlSecondsHint → int?
Optional caller-preferred session TTL in seconds. The maintainer caps server-side per its policy; a higher hint MUST be silently truncated rather than rejected. Drivers that have a fixed-TTL bearer (e.g. SIOP id_tokens with their own exp) MUST NOT extend beyond the underlying credential's lifetime regardless of hint.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
Serialize to a JSON-encodable map, omitting absent members.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited