Invites
- OpenAPI 3.1.0 document: https://api.rollstack.com/public/v1/openapi.json
- The whole reference in Markdown: https://docs.rollstack.com/llms-full.txt
- An index of the reference: https://docs.rollstack.com/llms.txt
Pending invites to join the organization, each with the role and authentication role the user joins with.
Only emails in the organization's allowed domains can be invited, so set its allowed domains first. Emails outside them, of existing members or already invited come back as rejected, with the reason, while the others are invited.
List invites
GET https://api.rollstack.com/public/v1/invites
The pending invites of the organization, with the role and authentication role each user joins with, and when they were invited.
Requires the users:read scope. Only owners and admins of the organization may call it.
Operation ID: listInvites. Only owners and admins can call it.
Response 200
Success
application/json: array of object
id(string, required): Unique identifier for the invite. Pass it asinviteIdtodeleteInviteto cancel the invite.email(string, required): The email address invited to join the organization.role(string, required): The role the person gets when they accept the invite.ownercan do everything in the organization,adminmanages its settings, members and invites, andmemberuses Rollstack without managing the organization. One ofowner,admin,member.authenticationRole(string or null, required): The access to the organization's Authentication settings (Single Sign-On and SCIM provisioning) the person gets when they accept the invite:viewercan see them,editorcan also change them, andnullgives none. One ofviewer,editor.createdAt(string (date-time), required): When the person was invited.
Create invites
POST https://api.rollstack.com/public/v1/invites
Invites up to 50 users as admins or members. Only emails in the organization's allowed domains are invited, and it fails with a 400 while the organization has none. Returns the invites it created and the emails it rejected, with the reason: outside the allowed domains, already a member or already invited.
Requires the users:write scope. Only owners and admins of the organization may call it.
Operation ID: createInvites. Only owners and admins can call it.
Headers
Idempotency-Key(string): A unique value, such as a UUID, that makes retrying this call safe. A retry with the same key within 24 hours answers the first call's result instead of running it again. Use a new key for each new call. From 1 to 255 printable ASCII characters.
Request body, required
application/json
emails(array of string (email), required): The email addresses to invite. Each one on the organization's domain allowlist (allowedDomains) that doesn't belong to a member and isn't already invited gets an invite and an invitation email; the others come back inrejected. From 1 to 50 addresses, each listed once, ignoring case.role(string, required): The role the invited people get when they join:adminlets them manage the organization's settings, members and invites, andmemberlets them use Rollstack without managing the organization. A key can't invite owners. One ofadmin,member.authenticationRole(string): Gives the invited people access to the organization's Authentication settings (Single Sign-On and SCIM provisioning) once they join:viewercan see them,editorcan also change them. If omitted, they join without access. Only owners can set it, not admins. One ofviewer,editor.
Response 201
Success
application/json
invited(array of object, required): The invites created, one for each email that passed the checks. Rollstack emails each person an invitation to join.id(string, required): Unique identifier for the invite. Pass it asinviteIdtodeleteInviteto cancel the invite.email(string, required): The email address invited to join the organization.role(string, required): The role the person gets when they accept the invite.ownercan do everything in the organization,adminmanages its settings, members and invites, andmemberuses Rollstack without managing the organization. One ofowner,admin,member.authenticationRole(string or null, required): The access to the organization's Authentication settings (Single Sign-On and SCIM provisioning) the person gets when they accept the invite:viewercan see them,editorcan also change them, andnullgives none. One ofviewer,editor.createdAt(string (date-time), required): When the person was invited.
rejected(array of object, required): The emails that were not invited, each with the reason. The other emails in the request were still invited.email(string, required): An email from your request that was not invited, in lowercase.reason(string, required): Why the email was not invited.domain_not_allowed: its domain isn't on the organization'sallowedDomains.already_member: it belongs to a member of the organization, active or deactivated; reactivate a deactivated one withreactivateMember.already_invited: it already has a pending invite, listed bylistInvites. One ofdomain_not_allowed,already_member,already_invited.
Delete invite
DELETE https://api.rollstack.com/public/v1/invites/{inviteId}
Deletes a pending invite.
Requires the users:write scope. Only owners and admins of the organization may call it.
Operation ID: deleteInvite. Only owners and admins can call it.
Path parameters
inviteId(string, required): The invite to delete, by theidfromlistInvitesorcreateInvites. An unknown invite, or one from another organization, returnsinvite-not-found.
Headers
Idempotency-Key(string): A unique value, such as a UUID, that makes retrying this call safe. A retry with the same key within 24 hours answers the first call's result instead of running it again. Use a new key for each new call. From 1 to 255 printable ASCII characters.
Response 204
Success, no content