Members
- 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
Members of the organization, their roles and access. A member's role is owner, admin or member; their authentication role, viewer or editor, lets them see or change the organization's SSO settings.
Call GET /me first to check a key works: it answers the user the key acts as, the organization it belongs to, the role it acts with and the scopes it carries, with any valid key, whatever its scopes.
Only owners and admins may call the other endpoints, with a key carrying users:read or users:write. A key can make a member an admin or a member, never an owner. Deactivating a member removes them from the organization, revokes their API keys and deletes their invites; reactivating them brings them back, but not their keys.
Get current user
GET https://api.rollstack.com/public/v1/me
The user and API key making the request: the user's id, name and email, the organization the key belongs to with the role the key acts with, and the key's id and scopes. Call it to check that a key works.
Works with any valid API key.
Operation ID: getMe.
Response 200
Success
application/json
id(number, required): Unique identifier for the user the API key belongs to: the sameidthatlistMembersreturns for them.email(string, required): The email address of the user the API key belongs to.name(string, required): The name of the user the API key belongs to, as shown in Rollstack.organization(object, required): The organization the API key belongs to. A key works only in the organization it was created in.id(string, required): Unique identifier for the organization: the sameidthatgetOrganizationreturns.name(string, required): The organization's name, as shown in Rollstack.role(string, required): The role the API key acts with in the organization, which limits what it can do on top of its scopes. As anowneroradmin, the key can call the endpoints limited to owners and admins, but only as anownercan it turn the organization's features on or off or change who can access its Authentication settings. As amember, it can do neither. It is the user's current role, but never higher than the one they had when the key was created or its scopes were last edited, so promoting the user doesn't raise it. One ofowner,admin,member.
apiKey(object, required): The API key that made the request.id(string, required): Unique identifier for the API key that made the request. It identifies the key without revealing its secret.scopes(array of string, required): The scopes the API key carries, which decide the endpoints it can call: each endpoint states the scope it needs, and the Scopes section of the introduction lists what each one allows. While the key acts as amember, it losesusers:read,users:writeandorganization:write, the scopes only owners and admins may grant, even if it was created with them.
List members
GET https://api.rollstack.com/public/v1/members
The members of the organization, with their role, authentication role, insights access and whether they are active. Optionally only those with a status, active or deactivated, or with an email.
Requires the users:read scope. Only owners and admins of the organization may call it.
Operation ID: listMembers. Only owners and admins can call it.
Query parameters
status(string): Only returnactivemembers, or onlydeactivatedones. If omitted, returns both. One ofactive,deactivated.email(string): Only return the member with exactly this email address, ignoring case. Returns an empty list if no member has it, or if they don't matchstatus. Example:jane@acme.com.
Response 200
Success
application/json: array of object
id(number, required): Unique identifier for the member. Pass it asuserIdtoupdateMember,deactivateMemberorreactivateMember.email(string, required): The email address of the member's Rollstack account.name(string, required): The member's name, as shown in Rollstack.role(string, required): The member's role in the organization.ownercan do everything, including turning the organization's features on or off, choosing who can access its Authentication settings and, in the app, making other members owners.adminmanages the organization's settings, members and invites, but can't turn features such as Insights or email analytics on or off, or change, deactivate or reactivate owners.memberuses Rollstack without managing the organization. One ofowner,admin,member.authenticationRole(string or null, required): The member's access to the organization's Authentication settings, where Single Sign-On (SSO) and SCIM provisioning are set up:viewercan see them,editorcan also change them, andnullgives no access. Owners always have full access, whatever this value. One ofviewer,editor.insightsEnabled(boolean, required): Whether the member can use Insights while the organization restricts them to the members it picks (restrictInsightUsersinupdateOrganization). It has no effect while Insights are open to every member or turned off.status(string, required): Whether the member has access to the organization.activemembers do.deactivatedmembers were removed from it, which revoked their API keys;reactivateMemberrestores their access, but not their keys. One ofactive,deactivated.deactivatedAt(string (date-time) or null, required): When the member was deactivated.nullwhile they're active.deactivationReason(string or null, required): Why the member was deactivated: the reason an admin gave, orsso_deprovisionedwhen SSO removed them.nullwhile they're active, or when no reason was given. One ofleft_company,no_longer_needs_access,not_using_enough,too_expensive,switching_tool,duplicate_account,sso_deprovisioned,other.deactivationReasonDetails(string or null, required): What the admin wrote whendeactivationReasonisother.nullotherwise.
Update member
PATCH https://api.rollstack.com/public/v1/members/{userId}
Changes a member's role, authentication role or insights access. Send only the fields to change, at least one. The role can be admin or member: a key never makes anyone an owner.
Requires the users:write scope. Only owners and admins of the organization may call it.
Operation ID: updateMember. Only owners and admins can call it.
Path parameters
userId(integer, required): The member to act on, by theidfromlistMembers. An id that is not a member of the organization returnsuser-not-in-organization.
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
role(string): The member's new role:adminto let them manage the organization's settings, members and invites, ormemberto take that away. A key can't make anyone an owner, admins can't change an owner's role, and you can't change your own. One ofadmin,member.authenticationRole(string or null): The member's access to the organization's Authentication settings, where Single Sign-On (SSO) and SCIM provisioning are set up:viewercan see them,editorcan also change them, andnullgives no access. Owners always have full access, whatever this value. Only owners can change it, not admins. One ofviewer,editor.insightsEnabled(boolean): Whether the member can use Insights while the organization restricts them to the members it picks (restrictInsightUsersinupdateOrganization). It has no effect while Insights are open to every member or turned off.
Response 200
Success
application/json
id(number, required): Unique identifier for the member. Pass it asuserIdtoupdateMember,deactivateMemberorreactivateMember.email(string, required): The email address of the member's Rollstack account.name(string, required): The member's name, as shown in Rollstack.role(string, required): The member's role in the organization.ownercan do everything, including turning the organization's features on or off, choosing who can access its Authentication settings and, in the app, making other members owners.adminmanages the organization's settings, members and invites, but can't turn features such as Insights or email analytics on or off, or change, deactivate or reactivate owners.memberuses Rollstack without managing the organization. One ofowner,admin,member.authenticationRole(string or null, required): The member's access to the organization's Authentication settings, where Single Sign-On (SSO) and SCIM provisioning are set up:viewercan see them,editorcan also change them, andnullgives no access. Owners always have full access, whatever this value. One ofviewer,editor.insightsEnabled(boolean, required): Whether the member can use Insights while the organization restricts them to the members it picks (restrictInsightUsersinupdateOrganization). It has no effect while Insights are open to every member or turned off.status(string, required): Whether the member has access to the organization.activemembers do.deactivatedmembers were removed from it, which revoked their API keys;reactivateMemberrestores their access, but not their keys. One ofactive,deactivated.deactivatedAt(string (date-time) or null, required): When the member was deactivated.nullwhile they're active.deactivationReason(string or null, required): Why the member was deactivated: the reason an admin gave, orsso_deprovisionedwhen SSO removed them.nullwhile they're active, or when no reason was given. One ofleft_company,no_longer_needs_access,not_using_enough,too_expensive,switching_tool,duplicate_account,sso_deprovisioned,other.deactivationReasonDetails(string or null, required): What the admin wrote whendeactivationReasonisother.nullotherwise.
Deactivate member
POST https://api.rollstack.com/public/v1/members/{userId}/deactivate
Deactivates a member, revokes their API keys and deletes their invites. Send the reason when you know it, so admins see why in the members list.
Requires the users:write scope. Only owners and admins of the organization may call it.
Operation ID: deactivateMember. Only owners and admins can call it.
Path parameters
userId(integer, required): The member to act on, by theidfromlistMembers. An id that is not a member of the organization returnsuser-not-in-organization.
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
application/json
reason(string, required): Why the member is deactivated.otherneedsreasonDetails. One ofleft_company,no_longer_needs_access,not_using_enough,too_expensive,switching_tool,duplicate_account,other.reasonDetails(string): Why the member is deactivated, in your words. Required and kept only whenreasonisother.
Response 204
Success, no content
Reactivate member
POST https://api.rollstack.com/public/v1/members/{userId}/reactivate
Reactivates a deactivated member. Their revoked API keys stay revoked.
Requires the users:write scope. Only owners and admins of the organization may call it.
Operation ID: reactivateMember. Only owners and admins can call it.
Path parameters
userId(integer, required): The member to act on, by theidfromlistMembers. An id that is not a member of the organization returnsuser-not-in-organization.
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