---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Memberships"
description: "The `memberships` collection of Sylphx Auth: A Membership places an end user in a customer organization with app-defined roles."
type: reference
product: organizations
summary: "A Membership places an end user in a customer organization with app-defined roles."
updated: 2026-09-28
order: 900
---

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`](/docs/api/memberships#get) | Gets a membership. |
| `GET` | [`list`](/docs/api/memberships#list) | Lists memberships. |
| `POST` | [`create`](/docs/api/memberships#create) | Creates a membership. |
| `PATCH` | [`update`](/docs/api/memberships#update) | Updates a membership. |
| `DELETE` | [`delete`](/docs/api/memberships#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](/docs/api/memberships/get)

## 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](/docs/api/memberships/list)

## 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](/docs/api/memberships/create)

## 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](/docs/api/memberships/update)

## 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](/docs/api/memberships/delete)
