OAuth2 API Authentication

Gisual's API supports authenticating via OAuth2.

This means that all API requests your integration makes to the Gisual API would be authenticated by your OAuth2 system.

To set up your Gisual account for OAuth2 API authentication, we only need a few pieces of information:

1. The OAuth2 system you are using, such as Service Now or Auth0
2. The OAuth2 flow your system uses
   1. Gisual supports the Client Credentials Grant flow.
3. The OAuth2 verification data
   1. Most often this is simply a static signing key or a JWKS URL
   2. If your OAuth2 system uses a token verification API endpoint, we would instead need
      1. The token verification API endpoint URL
      2. A client ID and secret to authenticate to the endpoint

To get these details, your engineering team will set up an application configuration in your OAuth2 server, which will provide them.

Once you have this information, please contact [e-mail], or reach out to your Account Executive, and we will work with your engineering team to configure your account.

As part of the configuration process, we will provide you an SSO identity value to send in your requests. This value must be provided with each request to the Gisual API along with your SSO token. It can be set either as the value of the X-SSO-Identity HTTP header, or as the sso_identity query parameter.