Docs / The model / HoldIdentityInput

HoldIdentityInput.

A signed-in identity to hold for the tenant: the platform's own browser opens on the platform, the person signs in, and the session state is checkpointed once the probe reads signed in

Figure 1HoldIdentityInputspecified

HoldIdentityInput is a value at none scope. The drawing shows its fields and the objects that they point at.

kind: value
scope: none
key: none
store: none
family: harness

Fields#

field	type	required	note
`platform`	`text`	yes	the platform’s slug, a row of the platform domains
`label`	`text`	yes	the person’s name for this identity, unique within the tenant and platform
`wait_seconds`	`count`	no	how long the platform waits for the sign-in; the parameter row’s value when absent
`session`	`id`	no	an open browsing session with a live view in which the person signed in; the platform reads the session’s cookies as the session given, so nothing leaves any browser; the web version’s way that lasts
`cookies`	HeldCookie	no	the session’s cookies given as data, read from the person’s own browser by the platform’s own extension or pasted by the person, for the web version where no window of the platform can open beside the person; when given, no window opens, and the platform keeps the cookies of the platform’s domains and probes them

Routes that use it#

/v1/act/hold_identity takes it as input