Versions Compared

Key

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

...

You can use this account type to connect ServiceNow Snaps with data sources that use the ServiceNow OAuth2 account.

Prerequisites

NoneCreate an app in ServiceNow portal for your ServiceNow instance.

Limitations

...

ServiceNow does not support Client Credentials grant type.

...

and

...

Known Issues

None.

Account Settings

...

Field Name

Field Type

Field Dependency

Description

Label*

String

N/A

Specify a unique label for the account.

Default Value:

 [None]

 None
ExampleServiceNow OAuth2 Account

Instance*

String/Expression

N/A

Specify the instance

to be used

to access ServiceNow endpoint.
If your ServiceNow URL is https://abc.service-now.com, then the instance name is abc.

Default Value: N/A
Examplehttps://abc.

servicenow

service-now.com

Client ID*

String

N/A

Specify

Provide the client ID

that you obtain after configuring the app in ServiceNow. For more information, see

to use for authorization. Learn more: Application configuration in ServiceNow portal to use in ServiceNow OAuth2 Account.

Default Value: N/A
Example

abcd12345xyz567

45b546f46b004d10d275c2b553bc7g44

Client secret

Client Secret

String

N/A

Specify

Provide the

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

client secret for authorization of OAuth2 account.

Default Value: N/A
Examplezcvfc098adfdb343s

Access

token

Token*

String

N/A

Specify the

Auto-generated upon account authorization. The access token for the application

, which you obtain

that is generated 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
Examplenpo98yh

Refresh token

String

N/A

Specify the

Auto-generated upon account authorization. The refresh token for the application

, which you obtain

that is generated 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

Token Expiration

Integer

N/A

Specify the expiry value for the access token

The time (in seconds) until which the access token must be valid. 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

N/A

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

Default Value: Deselected
Example: N/A

10

OAuth2 Endpoint*

String

N/A

Specify the OAuth2 endpoint in the following format to authorize the application

in the following format:

.

https://

<service now

<servicenow instance name>.service-now.com/

token

oauth_auth.do

Default Value: N/A
Example: https://

ven02371

myinstance.service-now.com/

endpoint

oauth_auth.do

OAuth2 Token*

String

N/A

Specify

the endpoint

the value for OAuth2 token in the following format to get the access token

in the following format:

.
https://

<service now

<servicenow instance name>.service-now.com/oauth_token.do

Default Value: N/A
Example: https://

ven02371

myinstance.service-now.com/oauth_token.do

Grant Type

Dropdown list

Enables Username and Password fields for password grant type.

Choose

the

an authentication grant type for

authentication to the endpointpassword: This grant type exchanges

your ServiceNow instance. 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: Exchanges your credentials for an access token.

    It is one of the simplest OAuth2 grants and
    • This grant type 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

    . NoteServiceNow supports only and authorization_code and password grant types; it does not support client_credentials grant type
    • .

    Default Value: authorization_code
    Example: password

    Username

    String

    Enabled on selecting password for Grant Type.

    Specify the username

    for the resource owner

    to connect to ServiceNow.

    Default Value: N/A
    Example: admin

    Password

    String

    Enabled on selecting password for Grant Type.

    Specify the password

    of the resource owner

    connect to ServiceNow.

    Default Value: N/A
    Example: p@$$w019

    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

    N/A

    Optional. Specify the parameter for the token endpoint.

    Default Value: N/A
    Examplescope

    Token endpoint parameter value

    Integer

    N/A

    Optional. Specify the value for the token endpoint parameter.

    Default Value: N/A
    Exampleread, 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

    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

    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.

     Deselected 

    Snap Pack History

    ...

    Related Content:

    Application Configuration in ServiceNow Portal for OAuth2 Account to use in ServiceNowhttps://docs-snaplogic.atlassian.net/wiki/spaces/SD/pages/1439233/Glossary

    https://docs-snaplogic.atlassian.net/wiki/spaces/SD/pages/1438341/Getting+Started