Skip to content
Console
On this page

Invitations

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

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

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/customer_organizations/{customer_organization}/invitations/{invitation}.
uidstringinv_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
emailstringThe invited address. Required.
rolesstring[]Roles the membership gets; empty means the environment's default roles.
stateInvitationStateThe lifecycle state. Output only. One of pending, accepted, revoked, expired.
expire_timetimestampWhen it expires. Output only.
accept_timetimestampWhen it was accepted. Output only.
end_userstringThe end user who accepted it. Output only.
membershipstringThe membership accepting it created. Output only.
ttldurationHow long it stays open; default 7 days, at most 30.
metadatastructImmutable application context, a JSON object of at most 16 KiB when compactly UTF-8 encoded. Omitted metadata is returned as an empty object. This is application data, never a permission grant. The application must recheck authoritative organization and project membership before acting.

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.

MethodCallWhat it does
GETgetGets an invitation.
GETlistLists invitations.
POSTcreateCreates an invitation.
POSTrevokeRevokes a pending invitation.
POSTacceptAccepts 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