StreamBIM icon

StreamBIM

StreamBIM API: projects, IFC files, IFC search, converter jobs, sync, users, workflows, topics, checklists, attachments, documents

User → Invite User

AI-generated

Summary

Invite a user by email to a specific StreamBIM project, optionally restricting sign-in to certain SSO providers or submitting a custom JSON:API invitation payload.

Inputs

  • Project Name or ID — Select the project to which the user will be invited, either by choosing from a loaded list (via credential's region) or specifying an ID with an expression.
  • Email Address (required) — Provide the email address of the user to invite to the project.
  • SSO Providers — Optionally restrict the invitation to specific SSO providers (Azure AD, Google, Okta). Leaving empty allows any sign-in method.
  • Other SSO Providers — Comma-separated list of additional SSO provider identifiers to include beyond the preset options.
  • Advanced — Use Raw JSON Body — Toggle to ignore the standard form fields and send a fully custom JSON:API payload in the body of the invitation request.
  • JSON Body — Provide the complete JSON:API payload for the invitation request; used only when the Advanced toggle is enabled.

Output shape

a single JSON object containing the API's invitation response

Returns the raw response from the StreamBIM API POST /invites endpoint, reflecting the created invitation record or error details.

Links

Discussion