In this article
Overview
You can use this account type to connect ServiceNow Snaps with data sources that use the ServiceNow OAuth2 account.
Prerequisites
None.
Limitations
ServiceNow does not support Client Credentials grant type.
It supports only Authorization Code and Password grant types.
Known Issues
None.
Account Settings
Field names marked with an asterisk ( * ) are mandatory.
Field Name | Field Type | Field Dependency | Description |
---|---|---|---|
Label* | String | N/A | Specify a unique label for the account. Default Value: [None] |
Instance | String/Expression | N/A | Specify the instance to be used to access ServiceNow endpoint. Default Value: N/A |
Client ID* | String | N/A | 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 |
Client secret | String | N/A | Specify the value for user authentication that you obtain after configuring the app in ServiceNow. Default Value: N/A |
Access token* | String | N/A | Specify the access token for the application, which you obtain when setting up the account for the endpoint. Access tokens have limited lifetimes; you must get a new access token after it expires. Default Value: N/A |
Refresh token | String | N/A | Specify the refresh token for the application, which you obtain when setting up the account for the endpoint. 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 |
Access token expiration | Integer | N/A | Specify the expiry value for the access token. It represents the number of refresh tokens per user account per client. 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 |
Header authenticated | Checkbox | N/A | Select this checkbox to enable the endpoint's bearer header authentication. Default Value: Deselected |
OAuth2 Endpoint* | String | N/A | Specify the endpoint to authorize the application in the following format: Default Value: N/A |
OAuth2 Token* | String | N/A | Specify the endpoint to get the access token in the following format: Default Value: N/A |
Grant Type | Dropdown list | Enables Username and Password fields for password grant type. | Choose the grant type for authentication to the endpoint. Available options are:
ServiceNow supports only and authorization_code and password grant types; it does not support client_credentials grant type. Default Value: authorization_code |
Username | String | Enabled on selecting password for Grant Type. | Specify the username for the resource owner. Default Value: N/A |
Password | String | Enabled on selecting password for Grant Type. | Specify the password of the resource owner. Default Value: N/A |
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 | String | N/A | Optional. Specify the parameter for the token endpoint. Default Value: N/A |
Token endpoint parameter value | Integer | N/A | Optional. Specify the value for the token endpoint parameter. Default Value: N/A |
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 | String | N/A | Optional. Specify the parameter for OAuth2 authentication. Default Value: N/A |
Authentication parameter value | Integer | N/A | Optional. Specify the value for the OAuth2 authentication parameter. Default Value: N/A |
Auto-refresh token | Checkbox | N/A | Select this checkbox to enable auto-refresh of the access token before it expires. Default Value: Deselected |
Troubleshooting
Error | Reason | Resolution |
---|---|---|
401 authentication error. | The Header authentication checkbox must be selected, if the endpoint uses bearer header authentication. | Select the Header authenticated checkbox. |
Snap Pack History
See Also
Application Configuration in ServiceNow Portal for OAuth2 Account to use in ServiceNow
https://docs-snaplogic.atlassian.net/wiki/spaces/SD/pages/1439233/Glossary
https://docs-snaplogic.atlassian.net/wiki/spaces/SD/pages/1438341/Getting+Started