invitations

Redeem Invitation

Accept an invitation as the authenticated caller (IBS-2467).

AuthorizedDescopeUserDep rather than a tenant-scoped dependency: an invitee authenticates before they belong to anything, so requiring a tenant claim here would make the endpoint unreachable for exactly the case it exists to serve.

Refusals carry a machine-readable code (see RedeemFailureCode) so the UI can name both addresses on a mismatch instead of a bare 403.

post/invitations/{code}/redeem

Request

  • Base URL: https://api.incredibuild.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.incredibuild.com/invitations/{code}/redeem
  • Auth: HTTP bearer

Path parameters

codestring required

Response

Successful Response

tenant_idstring uuid required
tenant_namestring required
descope_tenant_idstring required
role'admin' | 'viewer' required
newly_attachedboolean required
is_first_tenantboolean required
invited_by_namestring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.