---
sourceDocument: Xanadu Platform security
sourceDocumentLink: https://www.servicenow.com/docs/r/xanadu/platform-security

 Release :

    - xanadu

ft:locale :

    - en-US

ft:publication_title :

    - Xanadu Platform security

ft:clusterId :

    - psec

bundleId :

    - psec

workflow :

    - Platform


---

# Set up OAuth

# Set up OAuth {#ariaid-title1}

* Release version: Xanadu
* 
* Updated August 1, 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 1 minute to read

Set up and activate OAuth, enable the OAuth system property, create an OAuth
application endpoint for external client applications to access the instance, and set OAuth
parameters.

## Before you begin

Role required: admin

## Procedure

1. Make sure the [OAuth plugin](https://www.servicenow.com/docs/DB8w35oGdumK_o~NDXOGaQ "By default, the OAuth 2.0 (com.snc.platform.security.oauth) plugin is active on new and upgraded instances. If the plugin is not active on your instance, you can activate it.") is active and the [OAuth activation property](https://www.servicenow.com/docs/UAoFLHPNyZk0OxlY_QrcOQ "To generate OAuth 2.0 tokens to registered applications, the com.snc.platform.security.oauth.is.active property must be active for the instance.") is set to true.
2. Create an OAuth application registry using one of the following methods:
   * [Create an endpoint
     for external clients](https://www.servicenow.com/docs/965ZkcEDRRWS6RlYYp_8SQ "Create an OAuth application endpoint for external client applications to access the ServiceNow instance.") that want to access your instance. This creates an OAuth client application record and generates a client ID and client secret that the client needs to access the restricted resources on the instance.
   * [Use a third-party
     OAuth provider](https://www.servicenow.com/docs/access?context=t_UseAThirdPartyOAuthProvider&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US) that provides the authorization for access to your instance.

     [Specify an OAuth
     profile](https://www.servicenow.com/docs/access?context=t_SpecifyAnOAuthProfile&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US) and [Specify an OAuth
     scope](https://www.servicenow.com/docs/access?context=t_SpecifyAnOAuthScope&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US) when you are connecting to another OAuth
     provider.
   {#t_SettingUpOAuth__choices_kpp_wqv_yq}
3. Configure your client applications to create an HTTP POST that requests an OAuth token.  
   The application must also be able to parse the JSON response to use the returned access token and refresh token.
{#t_SettingUpOAuth__steps_uw3_zbs_dw}