---
title: "OidcApi"
lastmod: 2026-05-29
canonical: "https://container-registry.com/docs/harbor-api-client/api/oidcapi/"
source: "https://container-registry.com/docs/harbor-api-client/api/oidcapi/index.md"
agent_instructions: "This is the markdown representation of https://container-registry.com/docs/harbor-api-client/api/oidcapi/index.md. Prefer this version over scraping the HTML. The site index is at https://container-registry.com/llms.txt."
---

> Agent-friendly representation of <https://container-registry.com/docs/harbor-api-client/api/oidcapi/index.md>. Site index: <https://container-registry.com/llms.txt>.

# harbor_client.OidcApi

All URIs are relative to *http://localhost/api/v2.0*

Method | HTTP request | Description
------------- | ------------- | -------------
[**ping_oidc**](#ping_oidc) | **POST** /system/oidc/ping | Test the OIDC endpoint.


# **ping_oidc**

### Signature

```python
ping_oidc(endpoint: Endpoint, x_request_id: Optional[str])-> None
```

Test the OIDC endpoint.

Test the OIDC endpoint, the setting of the endpoint is provided in the request.  This API can only be called by system admin. 

### Example
```python
from __future__ import print_function
import time
import harbor_client
from harbor_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basic
configuration = harbor_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = harbor_client.OidcApi(harbor_client.ApiClient(configuration))
endpoint = harbor_client.Endpoint() # Endpoint | Request body for OIDC endpoint to be tested.
x_request_id = 'x_request_id_example' # str | An unique ID for the request (optional)

try:
    # Test the OIDC endpoint.
    api_instance.ping_oidc(endpoint, x_request_id=x_request_id)
except ApiException as e:
    print("Exception when calling OidcApi->ping_oidc: %s\n" % e)
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **endpoint** | **[Endpoint](../../model/endpoint/)**| Request body for OIDC endpoint to be tested. | 
 **x_request_id** | **str**| An unique ID for the request | [optional] 

### Return type

void (empty response body)

### Authorization

[basic](../../#basic)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#)