Organization

Manage your team members and their access to resources within your organization.

The Hyperstack organization feature is designed to efficiently manage your team members and their access to resources. When you sign up for a Hyperstack account, you automatically become the owner of an organization under your name, allowing you to invite members to join. You can manage resource access for team members using the user role system, which lets you grant specific permissions for each resource.

Additionally, please note that resource costs and billing are associated with the account of the organization. Therefore, resources created by all users within your organization will be billed to your organization's account.

User Account Types

When you create a new Hyperstack account, you automatically become the owner of your organization, granting you unrestricted permissions and the ability to invite new members. By default, new users you invite will be assigned a member account type without any resource action permissions. To learn how to grant permissions to organization members, see User Roles.

A Hyperstack account can belong to more than one organization, but an organization can only have a single owner at any time. To transfer or change ownership of an organization, please contact our technical support team at [email protected] for assistance.

User Roles

Hyperstack's Role-Based Access Control (RBAC) system enables you to create user roles that specify the level of access each member has. A user role consists of permissions and policies that have been added to it. Policies grant access to groups of permissions for common use cases, such as "AllPermissions," which provides full access to all resource actions within Hyperstack. Permissions grant access to individual resource actions, such as "virtual-machine-create," which allows a member to create a virtual machine.

Create a User Role

Here's how to create a custom user role and manage resource access effectively:

1. In Hyperstack, navigate to the My Organization tab near the bottom of the left sidebar.

2. In the top left of the organization window, click Create a new User Role.

3. Name the user role and select the policies and permissions corresponding to the resource actions you wish to grant the user.

   a. Policies: Grant access to groups of permissions for common use cases, such as "AllPermissions," which grants full access to all resource actions within Hyperstack.

   b. Permissions: Grant access to individual resource actions, such as "virtual-machine-create", which grants a member the permission to create a virtual machine.

4. After selecting the desired policies and permissions, click Create Role.

5. To view your new user role, navigate back to the My Organization page and click View User Roles in the top left corner.

6. From this page, you can edit or delete existing user roles.

Assign user role to organization member

1. Navigate to the My Organization page located near the bottom of the left sidebar.

2. Under the Roles header, click the "⋮" next to the member you want to assign the role to. Select the desired role and click the Assign role button.

Invite Members to Your Organization

To invite a member to your organization, follow the steps below:

1. In Hyperstack, navigate to the 'My Organization' tab near the bottom of the left sidebar.

2. Click the Invite user to join organization button.

3. In the Invite user modal window, enter the email of the user you are inviting and click Send invite.

4. View the status of the invitation by clicking on the Pending requests tab. You can also delete invitations by hovering over the ⋮ under the Actions header and clicking Cancel invitation.

Joining an Organization and Account Activation

When someone is invited to join an organization in Hyperstack, they will receive an email with a signup link.

• After clicking the link, the recipient must either log in to their existing Hyperstack account or create a new account using one of the supported Email or Single Sign-On (SSO) methods.
• To successfully join the inviting organization (and activate their account if newly registered), they must log in using the same method (Email or SSO) they chose during signup.

Multiple Organizations

Hyperstack supports multi-organization access, allowing users to belong to multiple organizations simultaneously. When you create a Hyperstack account, you automatically become the owner of a default organization. You can also be invited to join one or more other organizations as a member, without losing access to your original organization. Each organization has its own isolated set of resources, permissions, and billing details.

All Hyperstack resources, such as Key Pairs, Virtual Machines, Volumes, Kubernetes Clusters, Custom Images, Environments, and Firewalls, are organization-specific. Only resources from the currently selected organization will be visible.

Billing settings, credit balance, and notifications are also tied to the selected organization. Updates to billing information, such as invoices and payment methods, will only affect the organization currently in view.

API Key Behavior

API keys in Hyperstack are specific to both the user and the organization. When you switch organizations, your list of API keys will update to show only those associated with the currently selected organization. API keys are not shared between organizations or members. Each organization requires separate API key creation and management under your user identity.

Organization-Specific Permissions and Roles

As a user, you can switch between organizations at any time. You may have different roles and access permissions in each organization, such as being an owner in one and a member in another. This provides the flexibility to manage resources across different teams, projects, or business units from a single Hyperstack account.

User permissions in Hyperstack are scoped to each organization independently. When you join a new organization, you are assigned the member role by default and start with no permissions. You will not be able to view or manage any resources until an administrator or owner explicitly assigns you a user role, which defines access through a specific set of policies and permissions.

For example, you might:

• Be the owner of your original organization with full administrative access.
• Join a second organization and receive read-only access to monitor resources.
• Join a third organization and be granted full permissions to actively manage resources.

This role separation provides secure and granular control, ensuring that your level of access aligns with your responsibilities within each organization.

Switching Between Organizations

If you belong to multiple organizations, you can switch between them at any time. To switch organizations:

1. Log in to Hyperstack .
2. Hover over your account name in the top-right corner of the interface to open the dropdown menu.
3. From the dropdown, you'll see your current organization and a list of other organizations you are a member of.
4. Select the desired organization from the list to switch.

When you switch organizations:

• The dashboard, resource views, and billing info update to reflect the selected organization.
• Only resources (VMs, Volumes, Clusters, etc.) tied to that organization will be visible.
• Permissions and roles are scoped to the selected organization.

Persistent Selection

When you log out and back in, Hyperstack remembers the last organization you had selected and defaults to it.

Joining Another Organization

To join another organization, you must be invited by the owner of that organization (as described here). The invite must be sent to the email address associated with your Hyperstack account.

Follow these steps to join:

1. The inviter sends an invitation to your Hyperstack-associated email.
2. You’ll receive an invitation email with a signup link if you don’t already have a Hyperstack account.
3. After logging in or signing up, the invited organization will be added to your list of accessible organizations.

Manual Switch Required

You will not automatically switch to the new organization after accepting the invite. You must use the top-right selector to manually switch.

No Permissions by Default

Whether you join another organization or invite someone into yours, new members will not have any permissions assigned by default. Although the member appears in the organization, their user role must be explicitly set before they can interact with resources. Until a role is granted:

• They will not be able to view, create, or manage resources such as virtual machines, volumes, clusters, or key pairs.
• They will not be able to access or perform actions via the API.

Organization admins must assign appropriate roles for any functionality to be accessible.

Manage Email Notifications

Hyperstack sends email notifications about your account, resources, billing, and product updates. You choose which of these emails you receive on the Notification Settings page. To manage your preferences, navigate to My Account → Notification Settings. For a full walkthrough, see Email Notification Preferences.

Credit balance warning emails, which alert organization owners as account credit runs low, are part of these preferences under the Payment & Billing category. See Early Email Notifications for Low Balance for the warning thresholds.

Organization Management APIs

See below for a list of APIs that provide control over your organization, including member invitations and user access permissions.

Core APIs

APIs to obtain and change details about your organization.

Endpoint Name	URL	Description
Retrieve organization details	GET/auth/organizations	Retrieves details about your organization and its members.
Remove organization member	POST/auth/organizations/remove-member	Removes a member from your organization.
Change organization name	PUT/auth/organizations/update	Changes the name of your organization.

Member Invitation APIs

APIs for managing organization member invitations.

Endpoint Name	URL	Description
Invite organization member	POST/auth/invites	Invites a member to your organization.
List organization invitations	GET/auth/invites	Retrieves a list of organization invitations.
Delete organization invitations	DELETE/auth/invites/{id}	Deletes an organization invitation.

User Role APIs

APIs for managing user roles, enabling the assignment of pre-configured sets of resource access permissions and policies to users within your organization.

Endpoint Name	URL	Description
List RBAC roles	GET/auth/roles	Returns a list of existing RBAC roles.
Create RBAC role	POST/auth/roles	Creates an RBAC role.
Retrieve RBAC role details	GET/auth/roles/{id}	Retrieves the details of an existing RBAC role.
Update RBAC role	PUT/auth/roles/{id}	Modifies an RBAC role.
Delete RBAC role	DELETE/auth/roles/{id}	Deletes an RBAC role.
Assign RBAC role to organization member	PUT/auth/users/{user_id}/assign-roles	Assigns an RBAC role to a member of your organization, granting them the specified permissions and policies.
Revoke RBAC role from organization member	DELETE/auth/users/{user_id}/roles	Removes an RBAC role from a member of your organization, revoking the specified permissions and policies.

Permissions and Policies APIs

APIs for obtaining permissions/policies information.

Endpoint Name	URL	Description
List permissions	GET/auth/permissions	Lists permissions that can be added to user roles.
List Policies	GET/auth/policies	Returns a list of policies that can be added to user roles.
List my permissions	GET/auth/users/me/permissions	Retrieves a list of permissions assigned to your account.
List user permissions	GET/auth/users/{id}/permissions	Retrieves a list of permissions assinged to a user.

Manage User Role APIs

APIs for managing the user roles assigned to members within your organization, enabling you to control resource access for your users.

Endpoint Name	URL	Description
Assign RBAC role to organization member	PUT/auth/users/{user_id}/assign-roles	Assigns an RBAC role to a member of your organization, granting them the specified permissions and policies.
Revoke RBAC role from organization member	DELETE/auth/users/{user_id}/roles	Removes an RBAC role from a member of your organization, revoking the specified permissions and policies.