> For the complete documentation index, see [llms.txt](https://docs.tpi.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.tpi.dev/guide/client-management/gtw-oauth-2.0-idp.md).

# GTW OAuth 2.0 IdP

<mark style="color:green;">**Path: Client Management > GTW OAuth 2.0 IdP**</mark>

In this section, you can find instructions on how to maintain the OAuth 2.0 third-party authentication servers using the gateway.

<figure><img src="https://content.gitbook.com/content/0choIC1BbdPOkKWOYGgk/blobs/BNIq79XtbKOfxzvup9yw/image.png" alt=""><figcaption></figcaption></figure>

### Search GTW OAuth 2.0 IdP <a href="#toc169186058" id="toc169186058"></a>

To search for GTW OAuth 2.0 IdP, you can search using the relevant information as keywords.

<figure><img src="https://content.gitbook.com/content/0choIC1BbdPOkKWOYGgk/blobs/OISVJtl04OrfusEtrOQo/image.png" alt=""><figcaption></figcaption></figure>

### GTW OAuth 2.0 IdP Client List <a href="#toc169186059" id="toc169186059"></a>

To view the GTW OAuth 2.0 IdP, first search using the information as keywords, and click on the![](https://content.gitbook.com/content/0choIC1BbdPOkKWOYGgk/blobs/1bFF7eyDHrhIwxf2BnwV/2.png)icon to access the page of the GTW OAuth 2.0 IdP details.

<figure><img src="https://content.gitbook.com/content/0choIC1BbdPOkKWOYGgk/blobs/596Nv5GvTUYHCx2l8BUL/image.png" alt=""><figcaption></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/0choIC1BbdPOkKWOYGgk/blobs/eh43DPW5arGj7YDekcoW/image.png" alt=""><figcaption></figcaption></figure>

#### **Create GTW OAuth 2.0 IdP**

In this section, you can find instructions on how to add a new IdP integration under this client.

1. Click **Create** to access the IdP creation page.

<figure><img src="https://content.gitbook.com/content/0choIC1BbdPOkKWOYGgk/blobs/5cJRqrPuzenDiQsnBynN/image.png" alt=""><figcaption></figcaption></figure>

2. Fill in the data or make selections as instructed below. The fields marked with “<mark style="color:red;">\*</mark>” are required.

* **Client Id**<mark style="color:red;">\*</mark>**:** A unique identifier used by third-party applications for identification and accessing protected resources.
* **Enable**<mark style="color:red;">\*</mark>**:** This account is active (**Y**) or inactive (**N**).
* **Type**<mark style="color:red;">\*</mark>**:** License Type, a third-party application authorized by the user.
* **Remark:** User's comments.
* **IdP Client ID**<mark style="color:red;">\*</mark>**:** A unique identifier used by digiRunner for identification and accessing protected resources.
* **IdP Client Name**<mark style="color:red;">\*</mark>**:** An identifiable username.
* **IdP Client Password**<mark style="color:red;">\*</mark>**:** User password.
  * ![](https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FlUGw7hepg2FoHLUZXYkK%2Fimage.png?alt=media\&token=03ce20ca-2d89-4ade-94bf-b73b606ae790) / ![](https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FHzXIw6Sf0Yt0X1yqmKtB%2Fimage.png?alt=media\&token=46a9a892-9708-4299-ad27-ab13aa9af12d) : Click the icon to toggle password visibility.
  * ![](https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FV4lLmQPNAOg5EL4p2Dod%2Fimage.png?alt=media\&token=b96af5a6-8591-40f4-81c6-87dcf8c3a746) : Click to copy the password.
* **Callback URL**<mark style="color:red;">\*</mark>**:** Redirect the user back to the specific URL of the client application and include the license certificate
* **Well Known URL**<mark style="color:red;">\*</mark>**:** A set of public, fixed URL paths used to store specific configuration information for a website or application.
* **Auth URL:** The entry URL for user authentication, used to guide users to log in and authorize the application to access resources.
* **Access Token URL:** The URL used to exchange the authorization code for the Access Token, enabling the application to access protected resources.
* **Scope:** Specify the scope of resource access requested by the application. The scope is defined by the authorization server and determines the extent of user authorization and access permissions.

3. Click **Create** to save and exit.

<figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2F06eS7txu1u5QekA8tL33%2Fimage.png?alt=media&amp;token=91f43f12-ebc0-4105-b943-3a667c6bdf0d" alt=""><figcaption></figcaption></figure>

#### **View GTW OAuth 2.0 IdP**

Search for the GTW OAuth 2.0 IdP to view details, and click on the![](https://content.gitbook.com/content/0choIC1BbdPOkKWOYGgk/blobs/w2fPJme5ROgaaI28aI2N/7.png)icon to access the page of the GTW OAuth 2.0 IdP details.

<figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2Fxhzds4efNqYMS1kfPg6z%2Fimage.png?alt=media&amp;token=8d8cc05a-949e-499c-b486-850c3603e93e" alt=""><figcaption></figcaption></figure>

<figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FgS8TWc2KZkiVWjFjZCRw%2Fimage.png?alt=media&amp;token=84f49c12-1002-45a8-af90-2a630ea019bf" alt=""><figcaption></figcaption></figure>

#### **Update GTW OAuth 2.0 IdP**

1. Search for the information to modify, and click on the ![](https://content.gitbook.com/content/0choIC1BbdPOkKWOYGgk/blobs/QGA7CNc2sbErwm8e4oOR/10.png) icon to access the update page.

<figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FAk4Q2SPZbluNOuT3ccek%2Fimage.png?alt=media&amp;token=8c72661f-812d-4d84-a1c5-293fa0b41e5d" alt=""><figcaption></figcaption></figure>

2. Modify the desired fields, and click **Update** to save and exit.

<figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FO3lNCrq3fithkiZmCiFn%2Fimage.png?alt=media&amp;token=0ed784a3-aa91-4abf-8cd6-1d325474af5a" alt=""><figcaption></figcaption></figure>

#### **Delete GTW OAuth 2.0 IdP**

In this section, you can find instructions on how to delete GTW Oauth 2.0 IdP.

1. Search for the GTW OAuth 2.0 IdP to delete, and click on the ![](https://content.gitbook.com/content/0choIC1BbdPOkKWOYGgk/blobs/R1w2fWpRcYD1WXAf23pl/13.png) icon to proceed.

<figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FxNvNN4TmzF14VMl1gRal%2Fimage.png?alt=media&amp;token=083ff9d1-9507-46ec-8337-a630fbca77df" alt=""><figcaption></figcaption></figure>

2. A warning prompt displaying the message “**Confirm Delete?**” will pop up. Click **Confirm** to delete this GTW OAuth 2.0 IdP and exit.

<div align="left"><figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FNVTBmBim9iZJ9fk0iup6%2Fimage.png?alt=media&amp;token=780e0003-bd92-4020-85e4-d9422f48c41f" alt=""><figcaption></figcaption></figure></div>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.tpi.dev/guide/client-management/gtw-oauth-2.0-idp.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.