Skip to content
Console
Menu

Getting Started

Authentication

KV Store

Organizations

What Customer Organizations, Memberships and Invitations are, and their calls.

Organizations gives your app's customers teams. A Customer Organization is a tenant inside your app; a Membership places one of your end users in it with roles your app defines; an Invitation asks an email address to join, and accepting it creates the membership.

#Where it is served

Organizations is served by Sylphx Auth on the one API. Every call is under https://api.sylphx.com/v1/orgs/{org}/projects/{project}/envs/{env}/ and takes a Sylphx key with the scope its method names in the API reference (keys and scopes).

#The resources

CollectionWhat it is
customer organizationsA Customer Organization is a B2B tenant inside a customer's app.
membershipsA Membership places an end user in a customer organization with app-defined roles.
organization rolesAn Organization Role is an app-defined role of the environment's customer organizations: a key that memberships and invitations name, a display name (meta.display_name), and the app's own permission strings.
invitationsAn Invitation asks one email address to join a customer organization with roles.
email domainsAn Email Domain is an email domain a customer organization claims.

Each link opens the collection's methods, with the path, scope, request, response and examples of every call.