Skip to content

Setting Up OAuth 2.0 with Okta for Integration Accounts

The following guide outlines how to authenticate to Vault API using OAuth 2.0, using a token from Postman to obtain a valid Vault session ID. Integrating external applications with Vault requires an integration user account to facilitate communication between the two systems. These accounts must rely upon OAuth 2.0 to authenticate since they can never access the Vault UI directly. Learn more about configuring OAuth 2.0 profiles.

The types of user accounts are:

  • Integration: does not require a physical user to authenticate
  • Non-integration: primarily interacts with systems via APIs rather than graphical user interfaces (GUIs)

You must satisfy the following prerequisites before proceeding with the authentication process:

To authenticate with OAuth 2.0:

  1. In your Vault Platform Postman Collection, navigate to the Veeva Vault API [version] > Authentication > OAuth 2.0 / OpenID Connect endpoint.

  2. Select the Authorization tab and change the Auth Type to OAuth 2.0.

    Postman Authorization tab showing the Configure New Token sectionPostman Authorization tab showing the Configure New Token section
  3. Under Configure New Token, set the values according to whether you're configuring a token for a non-integration account or an integration account.

  4. Scroll down and click Get new access token.

  5. Once authenticated, click Use Token.

  6. Select the Headers tab and clear the X-VaultAPI-ClientID checkbox.

  7. Select the Headers tab, then select the checkbox for vaultDNS and client_id. Set client_id to the Application Client ID from your client application in Vault.

  8. Copy the Vault Session ID URL from your OAuth 2.0/OpenID Connect profile in Vault and paste it into the URL box in Postman.

    Postman request URL with Vault Session ID URLPostman request URL with Vault Session ID URL
  9. Click Send.

Configuring Tokens for Non-Integration Accounts

Section link for Configuring Tokens for Non-Integration Accounts

When configuring a new token within Postman for a non-integration account, populate the fields as follows:

  • Set Grant type to Authorization Code.
  • Select Authorize using browser.
  • Populate Auth URL with the OAuth 2.0 authorization endpoint (v2) constructed from your Okta application (format will be: https://DOMAIN.com/oauth2/AUTHSERVERID/v1/authorize).
  • Populate Access Token URL with the OAuth 2.0 token endpoint (v2) constructed from your Okta application (format will be: https://DOMAIN.com/oauth2/AUTHSERVERID/v1/token).
  • Populate Client ID with the Client ID from your Okta application.
  • Leave Client Secret blank.
  • Set Code Challenge Mode to SHA-256.
  • Populate Code Verifier with a random, 43-128 character string. Vault API uses this value to connect the authorization request to the token request.
  • Populate Scope with openid.
  • (Optional) Populate a State, which is an opaque value used for preventing cross-site request forgery.
  • Set Client Authentication to Send client credentials in body.

Configuring Tokens for Integration Accounts

Section link for Configuring Tokens for Integration Accounts

When configuring a new token within Postman for an integration account, populate the fields as follows:

  • Set Grant type to Client Credentials.
  • Populate Auth URL with the OAuth 2.0 authorization endpoint (v2) constructed from your Okta application (format will be: https://DOMAIN.com/oauth2/AUTHSERVERID/v1/authorize).
  • Populate Access Token URL with the OAuth 2.0 token endpoint (v2) constructed from your Okta application (format will be: https://DOMAIN.com/oauth2/AUTHSERVERID/v1/token).
  • Populate Client ID with the Client ID from your Okta application.
  • Populate Client Secret with the Client Secret value from your Okta application.
  • Populate Scope with openid.
  • Set Client Authentication to Send client credentials in body.