Authorization code grant workflow

  • 릴리스 버전: Australia
  • 업데이트 날짜 2026년 03월 13일
  • 소요 시간: 13분

    • ServiceNow® handles both authentication and API access by acting as the authorization and resource server. When single sign-on (SSO) is enabled, it redirects users to the configured IdP for authentication and issues tokens after successful login.

    시작하기 전에

    Role required: oauth_admin, mi_admin, admin

    이 태스크 정보

    This topic collection provides information about how ServiceNow manages authentication and API access when acting as both the authorization server and the resource server. It describes the behavior when SSO is enabled, including redirection to the identity provider (IdP) for user authentication and the issuance of an authorization code by ServiceNow after successful authentication. The usage of authorization code ensures that ServiceNow retains control over token issuance and access to protected resources.

    그림 1. Authorization workflow
    Authorization Workflow

    프로시저

    1. Log in from the client application.

      The user begins the login process from the client application interface.

    2. Initiate the authorization request.
      The client redirects the user to ServiceNow authorization endpoint to initiate the authorization request. The authorization request can be initiated either by including the Client Secret or PKCE Code Challenge in the request body, based on the client type- private or public. In the authorization request body, include Client Secret for private clients, and PKCE Code Challenge for public clients.
      For Private clients
      Include the Client Secret in the request body, while initiating the token request for private clients. Follow the procedure to initiate the authorization request using Client Secret for private clients.
      Perform a GET request to the authorization endpoint with the following parameters:
      Method: GET
Endpoint: https://<servicenow_base_url>/oauth_auth.do
      표 1. Authorization Request Parameters (Private Client-Client Secret)
      Parameter Required Description
      response_type Yes Set the value to code to initiate the authorization code flow.
      client_id Yes The unique identifier for your client application.

      Format: YOUR_CLIENT_ID
      redirect_uri Yes The URI to which ServiceNow sends the authorization code.

      Example: https://yourapp.com/callback
      scope Yes A space-delimited list of requested scopes.

      Example: incident_read incident_write.
      state Yes A client-generated value used to avoid Cross-Site Request Forgery (CSRF) attacks. The value is returned unchanged in the redirect URI, enabling the client to validate it
      For Public clients
      Include the PKCE Code Challenge in the request body, while initiating the token request for public clients. Follow the procedure to initiate the authorization request using PKCE Code Challenge for public clients.
      Perform a GET request to the authorization endpoint with the following parameters:
      Method: GET
Endpoint: https://<servicenow_base_url>/oauth_auth.do
      표 2. Authorization Request Parameters (Public Client - PKCE)
      Parameter Required Description
      response_type Yes Set the value to code to initiate the authorization code flow.
      client_id Yes The unique identifier for your client application.

      Format: YOUR_CLIENT_ID
      redirect_uri Yes The URI to which ServiceNow sends the authorization code.

      Example: https://yourapp.com/callback
      code_challenge Yes A base64url-encoded SHA-256 hash of the code verifier. This is used as part of the PKCE flow.
      code_challenge_method Yes Specifies the transformation method used for the code challenge. Set to S256.
      scope Yes A space-delimited list of requested scopes.

      Example: incident_read incident_write.
      state Yes A client-generated value used to avoid CSRF attacks. The value is returned unchanged in the redirect URI, enabling the client to validate it.
      주:
      Starting with the Madrid release, the system property glide.oauth.state.parameter.required mandates the use of the state parameter in the OAuth requests. The state property is set to true by default in the new instances, and optional in upgraded instances. In case of missing state parameter, the authorization request fails and the following error is displayed: Missing State parameter in request.
    3. Grant access consent to the client application.
      Access the ServiceNow login page (or IdP, if SSO is enabled), and grant access consent to the client application.
    4. ServiceNow (or IdP, if SSO is enabled) validates the credentials and ServiceNow returns an authorization code to the client.
      After the successful authentication, the browser is redirected to the redirect_uri, and the authorization code is included in the query string:
      https://yourapp.com/callback?code=AUTH_CODE&state=xyz123
    5. The client exchanges the authorization code for an access token (and a refresh token, if it’s a private client) by making a call to ServiceNow’s token endpoint.
      The authorization code for access token can be initiated either by including the Client Secret or PKCE Code Challenge in the request body, based on the client type- private or public. In the token request body, include Client Secret for private clients, and PKCE Code Challenge for public clients.
      For Private clients
      Include the Client Secret in the request body, while initiating the token request for private clients. Follow the procedure to initiate the token request using Client Secret for private clients.
      In case of private clients, the client sends a POST request to token endpoint with the following parameters:
      
Method: POST 
Endpoint: https://<servicenow_base_url>/oauth_token.do   
Headers: Content-Type: application/x-www-form-urlencoded
      표 3. Token Request Parameters (Private Client-Client Secret)
      Parameter Required Description
      grant_type Yes Set the value to authorization_code to exchange the code for a token.
      code Yes The authorization code received from the authorization endpoint.
      redirect_uri Yes The URI used in the initial authorization request.

      Example: https://yourapp.com/callback
      client_id Yes The unique identifier for your client application.
      client_secret Yes The client’s secret used to authenticate with the token endpoint.
      state Yes A client-generated value used to help prevent CSRF attacks. The value is returned unchanged in the redirect URI, enabling the client to validate it.
      For Public clients
      Include the PKCE Code Challenge in the request body, while initiating the token request for public clients. Follow the procedure to initiate the authorization request using PKCE Code Challenge for public clients.
      The client sends a POST request to token endpoint with the following parameters:
      
Method: POST  
Endpoint: https://<servicenow_base_url>/oauth_token.do  
Headers: Content-Type: application/x-www-form-urlencoded
      표 4. Token Request Parameters (Public Client-PKCE)
      Parameter Required Description
      grant_type Yes Set the value to authorization_code to exchange the code for a token.
      code Yes The authorization code received from the authorization endpoint.
      redirect_uri Yes The URI used in the initial authorization request.

      Example: https://yourapp.com/callback
      client_id Yes The unique identifier for your client application.
      code_verifier Yes The original string used to generate the PKCE code_challenge.
      state Yes A client-generated value used to help prevent CSRF attacks. The value is returned unchanged in the redirect URI, enabling the client to validate it.
    6. Access the ServiceNow APIs with the access token.
      Example:
      Make a GET request to the APIs using the access token. Include the access token in the Authorization header.
      Method: GET
End Point: https://<servicenow_base_url>/api/now/incident  
Authorization: Bearer YOUR_ACCESS_TOKEN
    7. Renew the access token if it has expired.
      Make a POST request to refresh the access token (private clients only) with the following parameters:
      
Method: POST  
Endpoint: https://<servicenow_base_url>/oauth_token.do  
Headers: Content-Type: application/x-www-form-urlencoded
      표 5. Refresh Token Request Parameters (Private Client)
      Parameter Required Description
      grant_type Yes Set the value to refresh_token to request a new access token.
      refresh_token Yes The refresh token previously issued by the token endpoint.
      client_id Yes The unique identifier for your client application.
      client_secret Yes The client secret used to authenticate with the token endpoint.