Reference

Invitations

An Invitation asks one email address to join a customer organization with roles.

Checked 2026-09-28

An Invitation asks one email address to join a customer organization with roles. It is single-use and expires; accepting needs an end user whose verified email is the invited address, and creates the membership.

Service Sylphx Auth · Resource type auth.sylphx.com/Invitation · Name pattern orgs/{org}/projects/{project}/envs/{env}/customer_organizations/{customer_organization}/invitations/{invitation} · Shape record

#Fields

Field	Type	What it is
name	string	orgs/{org}/projects/{project}/envs/{env}/customer_organizations/{customer_organization}/invitations/{invitation}.
uid	string	inv_<cell><ulid>; never reused. Output only.
meta	ResourceMeta	Resource metadata.
email	string	The invited address. Required.
roles	string[]	Roles the membership gets; empty means the environment's default roles.
state	InvitationState	The lifecycle state. Output only. One of pending, accepted, revoked, expired.
expire_time	timestamp	When it expires. Output only.
accept_time	timestamp	When it was accepted. Output only.
end_user	string	The end user who accepted it. Output only.
membership	string	The membership accepting it created. Output only.
ttl	duration	How long it stays open; default 7 days, at most 30.

#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 an invitation.
GET	list	Lists invitations.
POST	create	Creates an invitation.
POST	revoke	Revokes a pending invitation.
POST	accept	Accepts a pending invitation for an end user whose verified email is the invited address, and creates the membership.

#get

Gets an invitation.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/customer_organizations/customer-organization/invitations/invitation · scope auth:read · effect read · Request, response and examples

#list

Lists invitations.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/customer_organizations/customer-organization/invitations · scope auth:read · effect read · paginated · Request, response and examples

#create

Creates an invitation.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/customer_organizations/customer-organization/invitations · scope auth:write · effect write · Request, response and examples

#revoke

Revokes a pending invitation.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/customer_organizations/customer-organization/invitations/invitation:revoke · scope auth:write · effect destructive · Request, response and examples

#accept

Accepts a pending invitation for an end user whose verified email is the invited address, and creates the membership.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/customer_organizations/customer-organization/invitations/invitation:accept · scope auth:write · effect write · Request, response and examples