Share a project and choose who can open it

Who can open an organization's project, the five levels from View to Manage, and running against production at the Run level.

In short

An organization's project is open to the people its Share dialog names, at one of five levels: View, Comment, Run, Edit or Manage. Run lets people run what is saved without changing it; Edit can also use the project's secrets. Running against Production is protected at the Run level.

Before you start

• Who: only people who manage the project change who it is shared with. Anyone who can open it sees the "Visible to" line and the Share dialog's list.
• Plan: every plan.
• First: the project must be in an organization. A project in your Personal Workspace is shared another way (see /help/api-testing/inheritance-and-access).

Steps

1. Open the project. The "Visible to" mark beside its name says who can open it, such as "Visible to the Payments team"; its hint says what you can do.
2. Press "Share" - its label names who can open the project, such as "Private" or "Visible to the Payments team" - or press that line. Only people who manage the project change who it is shared with.
3. Under "Who can open it", choose "Private", "Team", "Team and below", "Everyone" or "Read-only for others". "Filed under" sets the team it is listed under.
4. Add a person, a team or a role at a level, with "Access until" if the share should end.

Result: changes apply at once.

Share with someone from outside the team

A guest joins the organization but reaches only what is shared with them by name, and can comment at most. They make no projects and see nothing else in API Tester. A guest takes one of your plan's guest places, not a member place, and no paid seat. You need the right to invite people.

1. In the Share dialog, turn on "Invite new people as guests".
2. Type their email address and press "Invite ... as a guest".
3. Send the invitation. The project opens for them when they join.

If you do not see the switch, you may not invite people here. Ask someone who manages the organization's members. To change someone from guest to member, give them another role under Members; that needs a free member place.

The five levels on a project

Edit is trust with the project's secrets Whoever can change a request can make it send a secret variable to a host of their own. Give Run to people who should only run what is saved: at Run, a request with any part changed is refused with "You can run this request as saved".

Running against production

An environment marked Production is protected at the Run level. "People who can run may also run against production" is off for a new project: then only people who can change the project run it against Production. Turn it on to let the Run level run saved requests there too. Once a project has an environment marked Production, the line under its name says which it is: "Production: people who may edit run it" or "Production: anyone who may run it".

• Production is the environment's tier and nothing else. An environment nobody marked Production is not protected.
• Where an environment points, its tier, its sign-in, its secrets and its switches are the managers' to change. People at Edit can rename it and change its plain variables.
• A run of several environments or requests runs what it may and lists the rest as not run, with the reason - never as failed.

Monitors run as a person

A monitor runs as the person who made it, or who took it over last; its row says "Runs as" and the name. Each run checks that the person may still run what it covers. If they no longer may, it stops, says why, and is listed as stopped work. "Take over", for anyone who can edit what it covers, makes it run as you.

Good to know

• Your organization role is the ceiling: without Use API Tester you reach no project, whatever a share says. Whoever makes a project manages it. See /help/organizations/sharing.
• A project filed under no team starts open to everyone in the organization; one filed under a team starts open to that team, unless defaults say otherwise.
• Someone who may invite people can type an email address and choose "Invite": the project is shared with them when they join.
• A published API page, a mock server, webhook inboxes and release record links answer people outside the organization, whoever the project is open to inside. The Share dialog lists them under "Also open from outside", with "Close". Making the project private closes none of them.
• A project in your Personal Workspace is shared another way - see /help/api-testing/inheritance-and-access.
• What happens next: a person you add finds the project in their list. Removing a share takes it from their lists and search at once.

If something goes wrong

• "You can run this request as saved": your level is Run. Ask for Edit, or run it unchanged.
• A run against Production is listed as not run: your level is Run and the project does not allow it there.
• A monitor says it stopped: the person it runs as lost access. Press "Take over".

Related

• /help/organizations/sharing
• /help/api-testing/inheritance-and-access
• /help/api-testing/scheduled-monitoring