Skip to navigation

Set up authorization for public APIs using Guided Auth

View as Markdown

An increasing number of public APIs offer Guided Auth in Postman, including Stripe, Open AI, Notion, and Spotify. When you create an HTTP request to an API that supports Guided Auth, Postman automatically recognizes if the API requires authentication.

If you’re an API publisher, you can set up Guided Auth for your public APIs in your team dashboard. For more information, see Set up Guided Auth for public APIs.

Set up authorization

  1. Select the Authorization tab of an HTTP request to a public API that uses Guided Auth.

  2. Select No Auth in the Auth Type dropdown list.

  3. Under Quick Setup, you can choose from the authentication options configured for the API with Guided Auth.

    Guided Auth supports public APIs that require bearer, basic, API key, or OAuth 2.0 authentication credentials.

  4. Follow the instructions to get your credentials, then enter them in the relevant fields.

Once you enter your credentials you can store them as variables or in Postman Vault as a vault secret. Hover over Secret warning icon Sensitive value, click Set as Variable, enter a name, then select the scope you’d like to add it to.

Send authorized requests with a body

Guided Auth works the same way for any request, including POST, PUT, and PATCH requests that send JSON data. You don’t add your credentials to the JSON in the Body tab. Instead, Postman adds the credentials you enter in the Authorization tab to the relevant part of the request, such as a header or query parameter, when you send it.

To send an authorized request with a JSON body, do the following:

  1. Set up authorization in the Authorization tab as described in Set up authorization.
  2. Click the Body tab, select raw, then select JSON from the dropdown list.
  3. Enter your JSON data, then click Send.

To learn more about request bodies, see Send parameters and body data with API requests in Postman. To confirm where Postman added your credentials, see View authorization details.