Your advanced code editor is loading.

Please wait a moment.

#editor-loading { display: none; }

””” Kubernetes

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501

The version of the OpenAPI document: release-1.31 Generated by: https://openapi-generator.tech

””“

from future import absolute_import

import re # noqa: F401

python 2 and python 3 compatibility library

import six

from kubernetes.client.api_client import ApiClient from kubernetes.client.exceptions import ( # noqa: F401 ApiTypeError, ApiValueError )

class WellKnownApi(object): “”“NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.
          """
          
          def init(self, api_client=None):
          if api_client is None:
          api_client = ApiClient()
          self.api_client = api_client
          def get_service_account_issuer_open_id_configuration(self, **kwargs):  # noqa: E501
          """get_service_account_issuer_open_id_configuration  # noqa: E501
          get service account issuer OpenID configuration, also known as the 'OIDC discovery doc'  # noqa: E501
          This method makes a synchronous HTTP request by default. To make an
          asynchronous HTTP request, please pass async_req=True
          >>> thread = api.get_service_account_issuer_open_id_configuration(async_req=True)
          >>> result = thread.get()
          :param async_req bool: execute request asynchronously
          :param _preload_content: if False, the urllib3.HTTPResponse object will
          be returned without reading/decoding response
          data. Default is True.
          :param _request_timeout: timeout setting for this request. If one
          number provided, it will be total request
          timeout. It can also be a pair (tuple) of
          (connection, read) timeouts.
          :return: str
          If the method is called asynchronously,
          returns the request thread.
          """
          kwargs['_return_http_data_only'] = True
          return self.get_service_account_issuer_open_id_configuration_with_http_info(**kwargs)  # noqa: E501
          def get_service_account_issuer_open_id_configuration_with_http_info(self, **kwargs):  # noqa: E501
          """get_service_account_issuer_open_id_configuration  # noqa: E501
          get service account issuer OpenID configuration, also known as the 'OIDC discovery doc'  # noqa: E501
          This method makes a synchronous HTTP request by default. To make an
          asynchronous HTTP request, please pass async_req=True
          >>> thread = api.get_service_account_issuer_open_id_configuration_with_http_info(async_req=True)
          >>> result = thread.get()
          :param async_req bool: execute request asynchronously
          :param _return_http_data_only: response data without head status code
          and headers
          :param _preload_content: if False, the urllib3.HTTPResponse object will
          be returned without reading/decoding response
          data. Default is True.
          :param _request_timeout: timeout setting for this request. If one
          number provided, it will be total request
          timeout. It can also be a pair (tuple) of
          (connection, read) timeouts.
          :return: tuple(str, status_code(int), headers(HTTPHeaderDict))
          If the method is called asynchronously,
          returns the request thread.
          """
          local_var_params = locals()
          all_params = [
          ]
          all_params.extend(
          [
          'async_req',
          '_return_http_data_only',
          '_preload_content',
          '_request_timeout'
          ]
          )
          for key, val in six.iteritems(local_var_params['kwargs']):
          if key not in all_params:
          raise ApiTypeError(
          "Got an unexpected keyword argument '%s'"
          " to method get_service_account_issuer_open_id_configuration" % key
          )
          local_var_params[key] = val
          del local_var_params['kwargs']
          collection_formats = {}
          path_params = {}
          query_params = []
          header_params = {}
          form_params = []
          local_var_files = {}
          body_params = None
          HTTP header Accept
          header_params[‘Accept’] = self.api_client.select_header_accept(
          [‘application/json’])  # noqa: E501
          Authentication setting
          auth_settings = [‘BearerToken’]  # noqa: E501
          return self.api_client.call_api(
          ‘/.well-known/openid-configuration’, ‘GET’,
          path_params,
          query_params,
          header_params,
          body=body_params,
          post_params=form_params,
          files=local_var_files,
          response_type=’str’,  # noqa: E501
          auth_settings=auth_settings,
          async_req=local_var_params.get(‘async_req’),
          _return_http_data_only=local_var_params.get(‘_return_http_data_only’),  # noqa: E501
          _preload_content=local_var_params.get(‘_preload_content’, True),
          _request_timeout=local_var_params.get(‘_request_timeout’),
          collection_formats=collection_formats)

Explanation

This code defines a Python class called WellKnownApi that interacts with the Kubernetes API.

Class Structure:

__init__ method: Initializes the WellKnownApi instance with an ApiClient object. If no ApiClient is provided, it creates a new one.
get_service_account_issuer_open_id_configuration method: This method makes a GET request to the Kubernetes API’s “well-known” endpoint, specifically “/.well-known/openid-configuration”. This endpoint is used to retrieve the OpenID Configuration document, also known as the OIDC discovery document. This document contains information about the OpenID Connect (OIDC) provider used by Kubernetes for service account authentication.
get_service_account_issuer_open_id_configuration_with_http_info method: This method is similar to the previous one, but it returns a tuple containing the response data, status code, and headers. This allows the caller to access more detailed information about the API request.

Key Concepts:

OpenID Connect (OIDC): A standard authentication protocol used for issuing and verifying JSON Web Tokens (JWTs). Kubernetes uses OIDC to authenticate service accounts, which are used by applications running in the Kubernetes cluster to access resources.
Well-Known Endpoint: A standard endpoint (“.well-known/openid-configuration”) used by OIDC providers to publish their configuration information.

Code Overview:

The get_service_account_issuer_open_id_configuration and get_service_account_issuer_open_id_configuration_with_http_info methods both perform the same HTTP request to the Kubernetes API.
The methods use the ApiClient object to handle the request and return the response.
The Accept header is set to application/json to specify that the client expects a JSON response.
The methods use the BearerToken authentication scheme, which means that the request must include a valid access token.
The response_type parameter in the call_api method is set to str because the expected response is a JSON string representing the OpenID Configuration document.

Use Case:

This code can be used to retrieve the OpenID Configuration document from a Kubernetes cluster. This document can then be used to configure an application to authenticate with the Kubernetes OIDC provider and access cluster resources using service accounts.

Your advanced code editor is loading.

Please wait a moment.

Explanation

Graph

Symbols

We couldn't identify any entrypoints. If you believe this to be incorrect then please contact support.