memberships
Identity module · 5 operations
List membership rows
GET/memberships
A person in an organization as an internal member, with time-boxed validity. Returns a cursor page of membership rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.
Get a membership
GET/memberships/{id}
A person in an organization as an internal member, with time-boxed validity. Returns one membership with its `ETag`. A membership the caller may not see returns 404.
Leave the organization
POST/memberships/leave
Ends the caller's membership in the organization the credential is bound to, now, through `app.leave_organization`; access ends at once (Section 7.5 invariant 3). The sole Owner is refused with 422. Returns the ended membership. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.
End a membership
POST/memberships/{id}/end
Ends another member's membership now through `app.end_membership`. Requires `org.members.manage` at or above the member's band; the sole Owner is refused with 422. Returns the ended membership. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.
Offboard a member
POST/memberships/{id}/offboard
Ends access at once and opens the offboarding checklist. A sole Owner cannot remove or demote themselves. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.