Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Memberships
A Membership places an end user in a customer organization with app-defined roles.
A Membership places an end user in a customer organization with app-defined roles. Roles are app data, not Access policy. Changes append to history with a current head per (user, organization); Delete closes the membership.
Service Sylphx Auth · Resource type auth.sylphx.com/Membership · Name pattern orgs/{org}/projects/{project}/envs/{env}/customer_organizations/{customer_organization}/memberships/{membership} · Shape record
#Fields
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/customer_organizations/{customer_organization}/memberships/{membership}. |
uid | string | mbr_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
end_user | string | The member. Required. |
roles | string[] | App-defined roles, for example admin. |
#Methods
Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.
| Method | Call | What it does |
|---|---|---|
GET | get | Gets a membership. |
GET | list | Lists memberships. |
POST | create | Creates a membership. |
PATCH | update | Updates a membership. |
DELETE | delete | Deletes a membership. |
#get
Gets a membership.
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/customer_organizations/customer-organization/memberships/membership · scope auth:read · effect read · Request, response and examples
#list
Lists memberships.
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/customer_organizations/customer-organization/memberships · scope auth:read · effect read · paginated · Request, response and examples
#create
Creates a membership.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/customer_organizations/customer-organization/memberships · scope auth:write · effect write · Request, response and examples
#update
Updates a membership.
PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/customer_organizations/customer-organization/memberships/membership · scope auth:write · effect write · Request, response and examples
#delete
Deletes a membership.
DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/customer_organizations/customer-organization/memberships/membership · scope auth:write · effect destructive · Request, response and examples