Skip to content
Release: Australia · Updated: 2026-07-09 · Official documentation · View source

OAuth 2.0 credentials

OAuth 2.0 credentials enable ServiceNow to obtain access to user accounts on an HTTP service.

These fields are available in the Credentials form for OAuth 2.0.

FieldInput value
NameEnter a unique and descriptive name for this credential. For example, you might call it OAuth2 credential.
ActiveSpecify whether this credential is active.
OAuth Entity ProfileAn OAuth profile is a combination of a grant type and at least one scope.
Connect to Auth Server via MID Server

Connects your ServiceNow instance to an on-premise OAuth server that resides behind a firewall through a MID Server. It can also connect your ServiceNow instance to a cloud-based OAuth server through a MID server. When this option is enabled, the request for an OAuth token is sent through the MID Server.Important:

  • The option appears when the value in the Grant type field in the OAuth Entity Profile is set to eitherClient Credentials, Authorization Code, or Resource Owner Password Credentials. To learn how to set an OAuth entity profile for a third-party OAuth provider, see Connect to a third-party OAuth provider.
  • If you select the Connect to Auth Server via MID Server checkbox, you must identify the required MID Server or MID Servers from the Applies to list.
  • MID Server user needs the oauth_admin role to Set up OAuth integration via MID Server.
Applies to

Specify if the credential record is applicable for all MID Servers, or a specific MID Server. If specific, add the MID servers as necessary.

Important:

Ensure that you are aware of these considerations if you have selected the Connect to Auth Server via MID Server check box.

  • Ensure that all the MID Servers selected in Applies to can communicate with the Auth server. This is required to execute the token request against the Token URL mentioned in the OAuth provider record (that is linked to the OAuth entity profile specified in the OAuth 2.0 credential record).
    Image omitted: mid-server-access-token-url.png
    Token URL in the OAuth provider record.</li>
  • Ensure that there is at least one MID Server (in the MID Servers selected in Applies to) with these configurations:
  • The value of the Status field is Up.
  • The value of the Validated field is Yes.
  • The capability of the MID Server is set to REST or ALL. To learn how to configure the MID server, see ../../integrate-applications/orchestration/configure-capabilities.md.
    Image omitted: MidServerDashbardGaugeOAuth2.0.png
    MID Server status.</li>

To learn more about these statuses, see MID Server dashboard.

OrderOrder \(sequence\) in which Discovery tries this credential as it attempts to log on to devices. The smaller the number, the higher in the list this credential appears. Establish credential order when using large numbers of credentials or when security locks out users after three failed login attempts. If all the credentials have the same order number \(or none\), the instance tries the credentials in a random order.
Credential aliasSpecify the credential alias that you want to tie to the OAuth 2.0 credential.
Integration Type

Indicates the integration type for the credential. Invoke an API of a third-party with an OAuth request that generates an OAuth token that is system or user specific. Following are the integration types:- System: Pull the token information based on the requester profile. The System integration type supports the following authentication mechanisms: 1. Security Assertion Markup Language (SAML) 2. JSON Web Token (JWT) - Personal: Pull the token information that is user-specific. The MID Server user must have the oauth_admin role. The Personal and System integration types support the following grant types: 1. Authorization Code 2. Resource Owner Password Credentials

If this Personal is selected on the OAuth Requestor Profile page, an additional flag called as Personal is displayed.

Note:

  • Any information that is related to a user can only be accessed with user-specific OAuth tokens with the Integration Type as Personal.
  • To use the session user-related token, you have to select the Run As filed in the Flow properties as User who initiates session.