browser_create_identity
Create a browser identity for a website the person must sign in to (or sign up on) themselves, and get back a link to give them. Opening the link shows a live browser on the site; when they have signed in they press 'I'm logged in, save session' and the identity becomes active, after which browser.open / browser.attach_identity work with it. Use browser.handoff instead for an identity that already exists and is active. For a plain username + password sign-in form WITHOUT captcha or 2FA, pass username, password and confirm_sign_in_stored=true and the platform signs in itself (admin or owner only): the answer is status 'active' on success, or the reason plus the human link when the site wanted more (a captcha, a code). When the site refuses the username or password, an identity created by this call is deleted again (status 'deleted'); one that already existed is left as it was. The password is kept encrypted in the workspace's secret store and used to sign in again when the session expires.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | The first page the person lands on, e.g. a signup page. Must be on the same domain as origin. Omit to start on the origin. | |
| name | Yes | Name for the identity, unique in the workspace (e.g. 'stripe_main'). A pending identity of the same name is resumed. | |
| origin | Yes | The site the identity is for, an https address (e.g. https://dashboard.example.com). | |
| password | No | The site's own password for username. Stored encrypted, never returned or logged. | |
| username | No | The site's own login (email or username). With password, the platform signs the identity in itself instead of waiting for a person. Admin or owner only. | |
| in_workspace | No | Run this one call in this workspace id instead of the session's. Nothing is stored; other sessions are not affected. | |
| confirm_sign_in_stored | No | Required true with username and password: the an admin or the owner of the workspace confirms that the platform stores this sign-in encrypted, types it into the site's login form in its own browser and keeps the session (the disclosure a person accepts in the sign-in window). Journalled. OMIT when not signing in. |