Customer organizations
A Customer Organization is a B2B tenant inside a customer's app.
A Customer Organization is a B2B tenant inside a customer's app. It is never a Sylphx org and never a Resource name segment of anything but its own memberships.
Service Sylphx Auth · Resource type auth.sylphx.com/CustomerOrganization · Name pattern orgs/{org}/projects/{project}/envs/{env}/customer_organizations/{customer_organization} · Shape record
Fields
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/customer_organizations/{customer_organization}. |
uid | string | cor_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
slug | string | Unique within the environment. |
verified_domains | string[] | Verified email domains; end users with a matching verified email may join. Output only. |
public_metadata | struct | App data. |
member_count | int32 | Live memberships. Output only. |
max_members | int32 | Optional seat cap, including pending unexpired invitations. Unset is unlimited. |
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 customer organization. |
GET | list | Lists customer organizations. |
POST | create | Creates a customer organization. |
PATCH | update | Updates a customer organization. |
DELETE | delete | Deletes a customer organization. |
get
Gets a customer organization.
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/customer_organizations/customer-organization · scope auth:read · effect read · Request, response and examples
list
Lists customer organizations.
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/customer_organizations · scope auth:read · effect read · paginated · Request, response and examples
create
Creates a customer organization.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/customer_organizations · scope auth:write · effect write · Request, response and examples
update
Updates a customer organization.
PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/customer_organizations/customer-organization · scope auth:write · effect write · Request, response and examples
delete
Deletes a customer organization.
DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/customer_organizations/customer-organization · scope auth:write · effect destructive · Request, response and examples