Versions Compared

Old Version 5

changes.mady.by.user Kalpana Malladi

Saved on

compared with

New Version 6

changes.mady.by.user Kalpana Malladi

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Limitations

ServiceNow supports only Client Credentials and Authorization code Authorization Code and Password grant types; it does not support Password Client Credentials grant type.

Known Issues

None.

...

Field Name

Field Dependency

Description

Label*

None.

Specify a unique label for the account.

Default Value: [None]
Example: ServiceNow OAuth2 Account

Instance

String/Expression

Specify the instance to be used to access ServiceNow endpoint.

Default Value: N/A
Example: https://abc.servicenow.com

Client ID*

String

Specify the client ID that you obtain after configuring the app in ServiceNow. For more information, see Application configuration in ServiceNow portal to use in ServiceNow OAuth2 Account.

Default Value: N/A
Example: abcd12345xyz567

Client secret

String

Specify the value for user authentication that you obtain after configuring the app in ServiceNow.

Default Value: N/A
Example: zcvfc098adfdb343s

Access token*

String

Specify the access token for the application, which you obtain when setting up the account for the endpoint. 

Info

Access tokens have limited lifetimes; you must get a new access token after it expires.

Default Value: N/A
Example: npo98yh

Refresh token

String

Specify the refresh token for the application, which you obtain when setting up the account for the endpoint.

Info

To access the API beyond the lifetime of a single access token, your application can obtain a refresh token. The application stores the refresh token for future use and automatically refreshes the access token before it expires.

Default Value: N/A
Example: N/A

Access token expiration

Integer

Specify the expiry value for the access token. It represents the number of refresh tokens per user account per client.

Info

If there is no date of expiration, -1 is the default value. In such cases, the access token is refreshed on a regular interval, for instance, every hour.

Default Value: N/A
Example: -1

Header authenticated

Checkbox

Select this checkbox to enable the endpoint's bearer header authentication.

Default Value: Deselected
Example: N/A

OAuth2 Endpoint*

String

Specify the endpoint to authorize the application.

Default Value: N/A
Example:

OAuth2 Token*

String

Specify the endpoint to get the access token. 

Default Value: N/A
Example:

Grant Type

Dropdown list

Choose the grant type for authentication to the endpoint. Available options are:

  • authorization_code: This grant type is used to obtain access tokens and refresh tokens from the authorization server.

  • client_credentials: This grant type allows the client to use its own credentials, instead of impersonating a user to authenticate when calling another web service.

  • password: This grant type exchanges your credentials for an access token. It is one of the simplest OAuth2 grants and involves the traditional username and password login to obtain the user's credentials and makes a POST request to the server to exchange the password for an access token.

Note

ServiceNow supports only client_credentials and authorization_code and password grant types; it does not support Password client_credentials grant type.

Default Value: authorization_code
Example: password

Token endpoint config

Use this field set to define custom properties for the OAuth2 token endpoint. This field set contains the following fields:

  • Token endpoint parameter

  • Token endpoint parameter value

Token endpoint parameter

String

Specify the parameter for the token endpoint.

Default Value: N/A
Example: scope

Token endpoint parameter value

Integer

Specify the value for the token endpoint parameter.

Default Value: N/A
Example: read, write

Auth endpoint config

Use this field set to define custom properties for the OAuth2 authentication endpoint. This field set contains the following fields:

  • Authentication parameter

  • Authentication parameter value

Authentication parameter

String

Specify the parameter for OAuth2 authentication.

Default Value: N/A
Example: redirect_uri

Authentication parameter value

Integer

Specify the value for the OAuth2 authentication parameter.

Default Value: N/A
Example: https://elastic.snaplogic.com/api/1/rest/admin/oauth2callback/rest

Auto-refresh token

Checkbox

Select this checkbox to enable auto-refresh of the access token before it expires.

Default Value: Deselected 

...