# GTW API IdP

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

In this section, you can find instructions on how to maintain the API authentication servers using the gateway.

<figure><img src="/files/e92uy61pD5a1jqcC2rjA" alt=""><figcaption></figcaption></figure>

### Search GTW API IdP <a href="#up157b1vwxmp" id="up157b1vwxmp"></a>

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

<figure><img src="/files/W0F10V0rnjuxcitg9fWh" alt=""><figcaption></figcaption></figure>

### Client List of GTW API IdP <a href="#rvzwa88xe9ud" id="rvzwa88xe9ud"></a>

1. To view the details of GTW API IdP, you can search using the relevant information as keywords, and click on the ![](/files/g4updz0gHLQcvyCuEKen) icon to access the **GTW API IdP Client List** page.

<figure><img src="/files/7CgZKWTlFCC7IN7LbimA" alt=""><figcaption></figcaption></figure>

2. Users can create, update, view details, and delete the clients.

<figure><img src="/files/medmK5iUGpYHppTix48K" alt=""><figcaption></figcaption></figure>

#### **Create API IdP Clients**

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

<figure><img src="/files/hQxnYhy6mMwIyOy9xfp6" 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.

* **Enable**<mark style="color:red;">\*</mark>**:** This account is active (**Y**) or inactive (**N**).
* **Page Title**<mark style="color:red;">\*</mark>**:** Header of the login page.
* **Icon:** Click **Choose file** to select and upload an identifiable GTW API IdP image. If no image is uploaded, the system will automatically use the digiRunner logo.
* **Request URL**<mark style="color:red;">\*</mark>**:** Specify the Uniform Resource Locator (URL) of the resource or service to be accessed.
* **Request Header:** The header section of an HTTP request contains key information, including client environment details, authentication credentials, and content format, enabling the server to interpret the request and respond accordingly.
* **Request Body**<mark style="color:red;">\*</mark>**:** Select from **none / form-data / x-www-form-urlencoded / raw**.
* **Response**<mark style="color:red;">\*</mark>**:** Select the response type from **HTTP status, and** **HTTP status + return code**.
  * Select **HTTP status** to define a response of 200\~299 as successful verification. The following fields required: **ID Token.name, ID Token.email, ID Token.picture.**
  * Select **HTTP status + return code** to define matching JSON Field + Value as successful verification. The following fields required: **JSON Field**<mark style="color:red;">\*</mark>**, Value**<mark style="color:red;">\*</mark>**, ID Token.name, ID Token.email, ID Token.picture.**
    * **JSON Field**<mark style="color:red;">\*</mark>**:** The key for verification.
    * **Value**<mark style="color:red;">\*</mark>**:** The value for verification.
    * **ID Token.name:** A standard claim in the ID Token that represents the verified user's name. It is used by the client to identify the user.
      \
      The ID Token is a JWT issued by the authorization server upon successful OIDC authentication, and it contains the user's identity information.
    * **ID Token.email:** In OAuth 2.0 and OpenID Connect (OIDC), the ID Token typically includes the email claim representing the verified user's email address.\
      The field can be used to identify the user or passed to the application for further use.
    * **ID Token.picture:** In OpenID Connect (OIDC), picture is an optional claim that provides the URL of the verified user’s profile image.
      \
      Applications may use this information to display the user’s profile image and enhance the personalized user experience.

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

<figure><img src="/files/jUTfXN7134Cn5SfxzMv1" alt=""><figcaption></figcaption></figure>

#### **Manage API IdP Clients**

1. Search for the API IdP client you want to view details, and click on the![](/files/dFo8vceCQkOJyDHioMoZ)icon to proceed.

<figure><img src="/files/0y70h0HKnvhme5IoqGGw" alt=""><figcaption></figcaption></figure>

2. View the API IdP client details.

<figure><img src="/files/Eh8qU02U4lGR1dSkT4pk" alt=""><figcaption></figcaption></figure>

3. Search for the API IdP client you want to modify, and click on the ![](/files/jYOB1BEamDx5kOOYWbAX) icon to access the update page.

<figure><img src="/files/0xwYvLkcnRySNA3I6O6f" alt=""><figcaption></figcaption></figure>

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

<figure><img src="/files/fyGT3UeDloaEPdBuYphg" alt=""><figcaption></figcaption></figure>

5. Search for the client ID to delete, and click on the ![](/files/HAetnCNN4DZitSAlbJxG) icon to proceed.

<figure><img src="/files/e2bjghzcI9k4fA7VEZT1" alt=""><figcaption></figcaption></figure>

6. A warning prompt displaying the message “**Confirm Delete?**” will pop up. Click **Confirm** to delete this API IdP client and exit.

<figure><img src="/files/nYI5j0T3RDv6O5j5GLbO" alt=""><figcaption></figcaption></figure>


---

# Agent Instructions: 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:

```
GET https://docs.tpi.dev/guide/client-management/gtw-api-idp.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.