FS

Invite an external member into the agent-fs shared org

Changed on

The API server performs the invite with its own bootstrap credentials (which are API-only and never served over HTTP), provisioning the shared org/drive first when needed. Intended for the cloud control plane's Connect-to-Drive flow. An email with an agent-fs account is added directly (status added). An email without one gets a pending invite (status pending) with an acceptUrl when agent-fs returns one; agent-fs sends no email, so the caller must hand the link to the invitee. No keys are returned; the invitee obtains their own key via agent-fs registration.

post/api/fs/members/invite

Request

  • Base URL
    http://localhost:3013
  • URL
    http://localhost:3013/api/fs/members/invite
  • Auth
    HTTP bearer

Request body

emailstring email required
role'viewer' | 'editor' | 'admin'

Response

Invite state ({ orgId, invited, status, acceptUrl? })

orgIdstring required
invitedboolean required

False only when the email already holds the requested role.

status'already_member' | 'added' | 'pending' required

already_member: no change. added: an existing agent-fs account joined the org. pending: the email has no account, so agent-fs created an invite the person must accept.

inviteIdstring

Pending invite id (status pending).

expiresAtstring

ISO time the accept link expires (status pending).

acceptUrlstring

Link the invitee opens to accept (status pending). agent-fs sends no email, so hand it to the person. Absent when agent-fs has no app URL configured.

Changes

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status