Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/outray-tunnel/outray/llms.txt

Use this file to discover all available pages before exploring further.

OutRay is built around organizations. Every tunnel, custom domain, reserved subdomain, and API token belongs to an organization. You can be a member of multiple organizations and switch between them at any time.

​
What organizations give you

  • Shared domains — any custom domain verified by the organization is available to all members.
  • Shared subdomains — reserved subdomains are owned by the organization, not an individual user.
  • Centralized billing — one subscription covers all members.
  • Role-based access — control who can manage domains, billing, and membership.

​
Roles

RoleWhat they can do
OwnerFull access, including billing and deleting the organization.
AdminManage members, domains, and tokens. Cannot access billing.
MemberStart tunnels and use organization resources. Read-only dashboard.

​
Inviting a team member

1

Open the Members section

In the dashboard, navigate to Members in the left sidebar.
2

Click Invite Member

Click the Invite Member button in the top-right corner. If the button is disabled, you have reached your plan’s member limit.
3

Enter the email address and role

Type the invitee’s email address and select a role — Member, Admin, or Owner. Click Send Invite.
4

Invitee accepts the invitation

The invitee receives an email with a link to accept. Once accepted, they appear in the Members list and can immediately use the organization’s resources.
Pending invitations appear in the Members list with a Pending badge. You can cancel an invitation at any time before it is accepted.

​
Switching the active organization

The CLI remembers which organization you are currently working in. All tunnels you start use that organization’s resources by default.

​
Interactive switch

Run outray switch to see a list of all organizations you belong to and select one interactively: 
outray switch

​
Direct switch

If you know the organization’s slug, pass it as an argument to skip the selection prompt: 
outray switch my-org-slug

​
Check the current context

Use outray whoami to see which organization is currently active and what role you have: 
outray whoami
Example output: 
Authentication Status

Active Organization:
  Acme Corp (acme-corp)

Role: admin

​
Per-tunnel organization override

You can start a tunnel under a different organization without permanently switching your active org using the --org flag: 
outray 3000 --org my-other-org
This is useful when you routinely work across multiple organizations and want to keep them separate without constantly switching.
The --org flag does not change your default organization. Run outray whoami after the tunnel exits and you will see your original org is still active.

​
Removing a member

Members with the Admin or Owner role can remove members from the Members page using the context menu next to each member’s name. Removing a member immediately revokes their access to the organization’s resources.

Build docs developers (and LLMs) love

Get started for freeTalk to us