Skip to navigation

Request access to call an API in Passport

As a Passport Member, you can browse Passport and request access to call APIs your team has made available. When your request is approved, Passport issues you a secret reference you can use to send authenticated requests without handling the underlying secret.

To learn more about Passport roles, see Passport roles.

Prerequisites

Before you begin, make sure you have the following:

  • A Passport account on your team — If your team already uses Passport, join using the email invite from your Admin.
  • At least one API available to request — An Admin adds APIs to a namespace as resources. If you don’t see a namespace or any resources, your team hasn’t made any available yet. Check with your Admin.

Request access to call an API

To request access to call an API, do the following:

  1. In the Passport app, select a namespace in the left sidebar.

  2. In the Resources tab, find the resource you want access to and click Request access.

  3. Provide the following details:

    • Access duration — Select the duration for your access. You can choose 7 days, 30 days, 90 days, or Unlimited.
    • Reason — Enter a reason for your request.
  4. Click Request access.

Your request is sent to the Passport Admin for review. You’ll be notified when it’s approved or denied.

After an Admin approves your request, you can send requests to the API using the provided secret references. To learn more, see Call an API with Passport.

If your request is denied, contact your Admin for more information.

View your access

The My access screen lists every resource you can currently reach and when your access expires.

To view your access, do the following:

  1. In the left sidebar, select My access.
  2. Expand a resource’s row to see the secret references bound to it.

To copy a secret reference and call an API with it, see Call an API with Passport.