Mirrors/vsphere-automation-sdk-python
1
0
Fork 0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-25 02:39:59 -05:00
Code
d1dca03db1
vsphere-automation-sdk-python/vsphere/8.0.0.1/com.vmware.vcenter.namespace_management.supervisors.html

862 lines
73 KiB
HTML
Raw Normal View History

Added docs for vSphere 8.0GA Signed-off-by: Ankit Agrawal <aagrawal3@vmware.com>
2022-10-12 08:01:15 -04:00
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>com.vmware.vcenter.namespace_management.supervisors package &mdash; vSphere Automation SDK for Python. 8.0.0.1 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="com.vmware.vcenter.namespace_management.supervisors.networks package" href="com.vmware.vcenter.namespace_management.supervisors.networks.html" />
<link rel="prev" title="com.vmware.vcenter.namespace_management.networks.nsx package" href="com.vmware.vcenter.namespace_management.networks.nsx.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python.
</a>
<div class="version">
8.0.0.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="vmware.html">vmware package</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">vSphere Automation SDK for Python.</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="com.html">com package</a> &raquo;</li>
<li><a href="com.vmware.html">com.vmware package</a> &raquo;</li>
<li><a href="com.vmware.vcenter.html">com.vmware.vcenter package</a> &raquo;</li>
<li><a href="com.vmware.vcenter.namespace_management.html">com.vmware.vcenter.namespace_management package</a> &raquo;</li>
<li>com.vmware.vcenter.namespace_management.supervisors package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/com.vmware.vcenter.namespace_management.supervisors.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="module-com.vmware.vcenter.namespace_management.supervisors">
<span id="com-vmware-vcenter-namespace-management-supervisors-package"></span><h1>com.vmware.vcenter.namespace_management.supervisors package<a class="headerlink" href="#module-com.vmware.vcenter.namespace_management.supervisors" title="Permalink to this headline"></a></h1>
<div class="section" id="subpackages">
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.networks.html">com.vmware.vcenter.namespace_management.supervisors.networks package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.networks.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.networks.html#module-com.vmware.vcenter.namespace_management.supervisors.networks.management_client">com.vmware.vcenter.namespace_management.supervisors.networks.management_client module</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.networks.html#module-com.vmware.vcenter.namespace_management.supervisors.networks.workload_client">com.vmware.vcenter.namespace_management.supervisors.networks.workload_client module</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="module-com.vmware.vcenter.namespace_management.supervisors.identity_client">
<span id="com-vmware-vcenter-namespace-management-supervisors-identity-client-module"></span><h2>com.vmware.vcenter.namespace_management.supervisors.identity_client module<a class="headerlink" href="#module-com.vmware.vcenter.namespace_management.supervisors.identity_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.supervisors.identity_client</span></code>
module provides classes related to identity management for a Supervisor.</p>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management.supervisors.identity_client.Providers">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.supervisors.identity_client.</span></code><code class="sig-name descname"><span class="pre">Providers</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors.identity_client.Providers" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Providers</span></code> class provides methods to configure identity management
on a Supervisor. This class was added in vSphere API 8.0.0.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management.supervisors.identity_client.Providers.CreateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">display_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">issuer_url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">username_claim</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">groups_claim</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_secret</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">certificate_authority_data</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">additional_scopes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">additional_authorize_parameters</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors.identity_client.Providers.CreateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.CreateSpec</span></code> class is used to register a new upstream
identity provider for use with a Supervisor. This class was added in
vSphere API 8.0.0.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – A name to be used for the given identity provider. This name will
be displayed in the vCenter UI. This attribute was added in vSphere
API 8.0.0.1.</p></li>
<li><p><strong>issuer_url</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The URL to the identity provider issuing tokens. The OIDC discovery
URL will be derived from the issuer URL, according to <a class="reference external" href="https://datatracker.ietf.org/doc/html/rfc8414">RFC8414</a>:
<a class="reference external" href="https://issuerURL/.well-known/openid-configuration">https://issuerURL/.well-known/openid-configuration</a>. This must use
HTTPS as the scheme. This attribute was added in vSphere API
8.0.0.1.</p></li>
<li><p><strong>username_claim</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The claim from the upstream identity provider ID token or user info
endpoint to inspect to obtain the username for the given user. This
attribute was added in vSphere API 8.0.0.1.
If None, the upstream issuer URL will be concatenated with the
‘sub’ claim to generate the username to be used with Kubernetes.</p></li>
<li><p><strong>groups_claim</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The claim from the upstream identity provider ID token or user info
endpoint to inspect to obtain the groups for the given user. This
attribute was added in vSphere API 8.0.0.1.
If None, no groups will be used from the upstream identity
provider.</p></li>
<li><p><strong>client_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The clientID is the OAuth 2.0 client ID registered in the upstream
identity provider and used by the Supervisor. This attribute was
added in vSphere API 8.0.0.1.</p></li>
<li><p><strong>client_secret</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The OAuth 2.0 client secret to be used by the Supervisor when
authenticating to the upstream identity provider. This attribute
was added in vSphere API 8.0.0.1.</p></li>
<li><p><strong>certificate_authority_data</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Certificate authority data to be used to establish HTTPS
connections with the identity provider. This must be a PEM-encoded
value. This attribute was added in vSphere API 8.0.0.1.
If None, HTTPS connections with the upstream identity provider will
rely on a default set of system trusted roots.</p></li>
<li><p><strong>additional_scopes</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Additional scopes to be requested in tokens issued by this identity
provider. This attribute was added in vSphere API 8.0.0.1.
If None, no additional scopes will be requested.</p></li>
<li><p><strong>additional_authorize_parameters</strong> ((<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Any additional parameters to be sent to the upstream identity
provider during the authorize request in the OAuth2 authorization
code flow. One use case is to pass in a default tenant ID if you
have a multi-tenant identity provider. For instance, with VMware’s
Cloud Services Platform, if your organization ID is
‘long-form-org-id’, the ‘orgLink’ parameter can be set to
“/csp/gateway/am/api/orgs/long-form-org-id” to allow users logging
in to leverage that organization. This attribute was added in
vSphere API 8.0.0.1.
If None, no additional parameters will be sent to the upstream
identity provider.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management.supervisors.identity_client.Providers.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">provider</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">display_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">issuer_url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">username_claim</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">groups_claim</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">certificate_authority_data</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">additional_scopes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">additional_authorize_parameters</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors.identity_client.Providers.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.Info</span></code> class provides details about an identity provider
configured with a Supervisor. This class was added in vSphere API 8.0.0.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The immutable identifier of an identity provider generated when an
identity provider is registered for a Supervisor. This attribute
was added in vSphere API 8.0.0.1.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.identity.Provider</span></code>. When
methods return a value of this class as a return value, the
attribute will be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.identity.Provider</span></code>.</p></li>
<li><p><strong>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – A name to be used for the given identity provider. This name will
be displayed in the vCenter UI. This attribute was added in vSphere
API 8.0.0.1.</p></li>
<li><p><strong>issuer_url</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>The URL to the identity provider issuing tokens. The OIDC discovery
URL will be derived from the issuer URL, according to <a class="reference external" href="https://datatracker.ietf.org/doc/html/rfc8414">RFC8414</a>:
<a class="reference external" href="https://issuerURL/.well-known/openid-configuration">https://issuerURL/.well-known/openid-configuration</a>. This must use
HTTPS as the scheme. This attribute was added in vSphere API
8.0.0.1.</p>
</p></li>
<li><p><strong>username_claim</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The claim from the upstream identity provider ID token or user info
endpoint to inspect to obtain the username for the given user. This
attribute was added in vSphere API 8.0.0.1.
If None, the upstream issuer URL will be concatenated with the
‘sub’ claim to generate the username to be used with Kubernetes.</p></li>
<li><p><strong>groups_claim</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The claim from the upstream identity provider ID token or user info
endpoint to inspect to obtain the groups for the given user. This
attribute was added in vSphere API 8.0.0.1.
If None, no groups will be used from the upstream identity
provider.</p></li>
<li><p><strong>client_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The clientID is the OAuth 2.0 client ID registered in the upstream
identity provider and used by the Supervisor. This attribute was
added in vSphere API 8.0.0.1.</p></li>
<li><p><strong>certificate_authority_data</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The certificate authority data holds the trusted roots to be used
to establish HTTPS connections with the identity provider. This
attribute was added in vSphere API 8.0.0.1.
If None, HTTPS connections with the upstream identity provider will
rely on a default set of system trusted roots.</p></li>
<li><p><strong>additional_scopes</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Additional scopes to be requested in tokens issued by this identity
provider. The ‘openid’ scope will always be requested. This
attribute was added in vSphere API 8.0.0.1.
If None, no additional scopes will be requested.</p></li>
<li><p><strong>additional_authorize_parameters</strong> ((<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Any additional parameters to be sent to the upstream identity
provider during the authorize request in the OAuth2 authorization
code flow. One use case is to pass in a default tenant ID if you
have a multi-tenant identity provider. For instance, with VMware’s
Cloud Services Platform, if your organization ID is
‘long-form-org-id’, the ‘orgLink’ parameter can be set to
“/csp/gateway/am/api/orgs/long-form-org-id” to allow users logging
in to leverage that organization. This attribute was added in
vSphere API 8.0.0.1.
If None, no additional parameters will be sent to the upstream
identity provider.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management.supervisors.identity_client.Providers.SetSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">SetSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">display_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">issuer_url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">username_claim</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">groups_claim</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_secret</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">certificate_authority_data</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">additional_scopes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">additional_authorize_parameters</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors.identity_client.Providers.SetSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.SetSpec</span></code> class is used to fully replace the configuration
of an upstream identity provider for use with a Supervisor. This class was
added in vSphere API 8.0.0.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – A name to be used for the given identity provider. This name will
be displayed in the vCenter UI. This attribute was added in vSphere
API 8.0.0.1.</p></li>
<li><p><strong>issuer_url</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>The URL to the identity provider issuing tokens. The OIDC discovery
URL will be derived from the issuer URL, according to <a class="reference external" href="https://datatracker.ietf.org/doc/html/rfc8414">RFC8414</a>:
<a class="reference external" href="https://issuerURL/.well-known/openid-configuration">https://issuerURL/.well-known/openid-configuration</a>. This must use
HTTPS as the scheme. This attribute was added in vSphere API
8.0.0.1.</p>
</p></li>
<li><p><strong>username_claim</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The claim from the upstream identity provider ID token or user info
endpoint to inspect to obtain the username for the given user. This
attribute was added in vSphere API 8.0.0.1.
If None, the upstream issuer URL will be concatenated with the
‘sub’ claim to generate the username to be used with Kubernetes.</p></li>
<li><p><strong>groups_claim</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The claim from the upstream identity provider ID token or user info
endpoint to inspect to obtain the groups for the given user. This
attribute was added in vSphere API 8.0.0.1.
If None, no groups will be used from the upstream identity
provider.</p></li>
<li><p><strong>client_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The clientID is the OAuth 2.0 client ID registered in the upstream
identity provider and used by the Supervisor. This attribute was
added in vSphere API 8.0.0.1.</p></li>
<li><p><strong>client_secret</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The OAuth 2.0 client secret to be used by the Supervisor when
authenticating to the upstream identity provider. This attribute
was added in vSphere API 8.0.0.1.</p></li>
<li><p><strong>certificate_authority_data</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Certificate authority data to be used to establish HTTPS
connections with the identity provider. This must be a PEM-encoded
value. This attribute was added in vSphere API 8.0.0.1.
If None, HTTPS connections with the upstream identity provider will
rely on a default set of system trusted roots.</p></li>
<li><p><strong>additional_scopes</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Additional scopes to be requested in tokens issued by this identity
provider. This attribute was added in vSphere API 8.0.0.1.
If None, no additional scopes will be requested.</p></li>
<li><p><strong>additional_authorize_parameters</strong> ((<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Any additional parameters to be sent to the upstream identity
provider during the authorize request in the OAuth2 authorization
code flow. One use case is to pass in a default tenant ID if you
have a multi-tenant identity provider. For instance, with VMware’s
Cloud Services Platform, if your organization ID is
‘long-form-org-id’, the ‘orgLink’ parameter can be set to
“/csp/gateway/am/api/orgs/long-form-org-id” to allow users logging
in to leverage that organization. This attribute was added in
vSphere API 8.0.0.1.
If None, no additional parameters will be sent to the upstream
identity provider.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management.supervisors.identity_client.Providers.Summary">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Summary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">provider</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">display_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors.identity_client.Providers.Summary" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.Summary</span></code> class provides an overview of an identity
provider configured for the given Supervisor. This class was added in
vSphere API 8.0.0.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The immutable identifier of an identity provider generated when an
identity provider is registered for a Supervisor. This attribute
was added in vSphere API 8.0.0.1.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.identity.Provider</span></code>. When
methods return a value of this class as a return value, the
attribute will be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.identity.Provider</span></code>.</p></li>
<li><p><strong>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – A name to be used for the given identity provider. This name will
be displayed in the vCenter UI. This attribute was added in vSphere
API 8.0.0.1.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management.supervisors.identity_client.Providers.UpdateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">UpdateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">display_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">issuer_url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">username_claim</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">unset_username_claim</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">groups_claim</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">unset_groups_claim</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_secret</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">certificate_authority_data</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">unset_certificate_authority_data</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">additional_scopes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">additional_authorize_parameters</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors.identity_client.Providers.UpdateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.UpdateSpec</span></code> class contains the specification required to
update the configuration of an identity provider used with a Supervisor.
This class was added in vSphere API 8.0.0.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – A name to be used for the given identity provider. This name will
be displayed in the vCenter UI. This attribute was added in vSphere
API 8.0.0.1.
if None, the name will remained unchanged.</p></li>
<li><p><strong>issuer_url</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>The URL to the identity provider issuing tokens. The OIDC discovery
URL will be derived from the issuer URL, according to <a class="reference external" href="https://datatracker.ietf.org/doc/html/rfc8414">RFC8414</a>:
<a class="reference external" href="https://issuerURL/.well-known/openid-configuration">https://issuerURL/.well-known/openid-configuration</a>. This must use
HTTPS as the scheme. This attribute was added in vSphere API
8.0.0.1.
If None, the issuer URL will not be updated.</p>
</p></li>
<li><p><strong>username_claim</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The claim from the upstream identity provider ID token or user info
endpoint to inspect to obtain the username for the given user. This
attribute was added in vSphere API 8.0.0.1.
If None, the username claim will not be updated.</p></li>
<li><p><strong>unset_username_claim</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – This represents the intent of the change to
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.UpdateSpec.username_claim</span></code>. If this field is set
to <code class="docutils literal notranslate"><span class="pre">true</span></code>, the existing ‘usernameClaim’ value will be removed. If
this field is set to <code class="docutils literal notranslate"><span class="pre">false</span></code>, the existing username claim will be
changed to the value specified in
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.UpdateSpec.username_claim</span></code>, if any. This attribute
was added in vSphere API 8.0.0.1.
If None, the existing ‘usernameClaim’ value will be changed to the
value specified in <code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.UpdateSpec.username_claim</span></code>, if
any.</p></li>
<li><p><strong>groups_claim</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The claim from the upstream identity provider ID token or user info
endpoint to inspect to obtain the groups for the given user. This
attribute was added in vSphere API 8.0.0.1.
If None, the groups claim will not be updated.</p></li>
<li><p><strong>unset_groups_claim</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – This represents the intent of the change to
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.UpdateSpec.groups_claim</span></code>. If this field is set to
<code class="docutils literal notranslate"><span class="pre">true</span></code>, the existing ‘groupsClaim’ value will be removed. If this
field is set to <code class="docutils literal notranslate"><span class="pre">false</span></code>, the existing groups claim will be
changed to the value specified in
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.UpdateSpec.groups_claim</span></code>, if any. This attribute
was added in vSphere API 8.0.0.1.
If None, the existing ‘groupsClaim’ value will be changed to the
value specified in <code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.UpdateSpec.groups_claim</span></code>, if
any.</p></li>
<li><p><strong>client_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The clientID is the OAuth 2.0 client ID registered in the upstream
identity provider and used by the Supervisor. This attribute was
added in vSphere API 8.0.0.1.
If None, the client ID will not be updated.</p></li>
<li><p><strong>client_secret</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The OAuth 2.0 client secret to be used by the Supervisor when
authenticating to the upstream identity provider. This attribute
was added in vSphere API 8.0.0.1.
If None, the client secret will not be updated.</p></li>
<li><p><strong>certificate_authority_data</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Certificate authority data to be used to establish HTTPS
connections with the identity provider. This must be a PEM-encoded
value. This attribute was added in vSphere API 8.0.0.1.
If None, the certificate authority data will not be updated.</p></li>
<li><p><strong>unset_certificate_authority_data</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – This represents the intent of the change to
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.UpdateSpec.certificate_authority_data</span></code>. If this
field is set to <code class="docutils literal notranslate"><span class="pre">true</span></code>, the existing ‘certificateAuthorityData’
value will be removed. If this field is set to <code class="docutils literal notranslate"><span class="pre">false</span></code>, the
existing certificate authority data will be changed to the value
specified in
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.UpdateSpec.certificate_authority_data</span></code>, if any.
This attribute was added in vSphere API 8.0.0.1.
If None, the existing ‘certificateAuthorityData’ value will be
changed to the value specified in
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.UpdateSpec.certificate_authority_data</span></code>, if any.</p></li>
<li><p><strong>additional_scopes</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Additional scopes to be requested in tokens issued by this identity
provider. This attribute was added in vSphere API 8.0.0.1.
If None, the additional scopes will not be updated.</p></li>
<li><p><strong>additional_authorize_parameters</strong> ((<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Any additional parameters to be sent to the upstream identity
provider during the authorize request in the OAuth2 authorization
code flow. One use case is to pass in a default tenant ID if you
have a multi-tenant identity provider. For instance, with VMware’s
Cloud Services Platform, if your organization ID is
‘long-form-org-id’, the ‘orgLink’ parameter can be set to
“/csp/gateway/am/api/orgs/long-form-org-id” to allow users logging
in to leverage that organization. This attribute was added in
vSphere API 8.0.0.1.
If None, the additional parameters will not be updated.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management.supervisors.identity_client.Providers.create">
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">supervisor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors.identity_client.Providers.create" title="Permalink to this definition"></a></dt>
<dd><p>Create a new identity provider to be used with a Supervisor. Currently,
only a single identity provider can be created. This method was added
in vSphere API 8.0.0.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>supervisor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – the Supervisor for which the identity provider is being registered.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.supervisor.Supervisor</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors.identity_client.Providers.CreateSpec" title="com.vmware.vcenter.namespace_management.supervisors.identity_client.Providers.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.CreateSpec</span></code></a>) – the {#link CreateSpec} describing the identity provider to be
registered.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>a unique identifier for the identity provider that was registered.
The return value will be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.identity.Provider</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if the \&#64;{param.name spec} contains any errors.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
if the specified Supervisor does not exist, or if an identity
provider is already configured.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user cannot be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user is missing the Namespaces.Manage privilege on the
Supervisor.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management.supervisors.identity_client.Providers.delete">
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">supervisor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">provider</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors.identity_client.Providers.delete" title="Permalink to this definition"></a></dt>
<dd><p>Remove an identity provider configured with a given Supervisor. This
will result in users no longer being able to log in to either the
Supervisor or any of its workload clusters with that identity provider.
This method was added in vSphere API 8.0.0.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>supervisor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – the identifier of the Supervisor which is associated with the
identity provider being removed.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.supervisor.Supervisor</span></code>.</p></li>
<li><p><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – the identifier for the identity provider that is to be deleted.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.identity.Provider</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the given identity provider or Supervisor cannot be found.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user cannot be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user is missing the Namespaces.Manage privilege on the
Supervisor.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management.supervisors.identity_client.Providers.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">supervisor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">provider</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors.identity_client.Providers.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns information about an identity provider configured for a
Supervisor. This method was added in vSphere API 8.0.0.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>supervisor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – identifier for the Supervisor for which the identity provider is
being read.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.supervisor.Supervisor</span></code>.</p></li>
<li><p><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – identifier for the identity provider that is being read.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.identity.Provider</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors.identity_client.Providers.Info" title="com.vmware.vcenter.namespace_management.supervisors.identity_client.Providers.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>An {#link Info} representing the requested identity provider.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the given identity provider or Supervisor cannot be found.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user cannot be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user is missing the System.Read privilege on the Supervisor.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management.supervisors.identity_client.Providers.list">
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">supervisor</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors.identity_client.Providers.list" title="Permalink to this definition"></a></dt>
<dd><p>List the identity providers configured for a given Supervisor. This
method was added in vSphere API 8.0.0.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>supervisor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – the Supervisor for which identity providers are being listed.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.supervisor.Supervisor</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors.identity_client.Providers.list" title="com.vmware.vcenter.namespace_management.supervisors.identity_client.Providers.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors.identity_client.Providers.Summary" title="com.vmware.vcenter.namespace_management.supervisors.identity_client.Providers.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Summary</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>A list of {#link Summary} with details about the identity providers
associated with a given Supervisor.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the given Supervisor cannot be found.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user cannot be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user is missing the System.Read privilege on the Supervisor.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management.supervisors.identity_client.Providers.set">
<code class="sig-name descname"><span class="pre">set</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">supervisor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">provider</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors.identity_client.Providers.set" title="Permalink to this definition"></a></dt>
<dd><p>Update the entire configuration for an existing identity provider used
with a Supervisor. This method was added in vSphere API 8.0.0.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>supervisor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – the identifier for the Supervisor associated with the identity
provider to be updated.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.supervisor.Supervisor</span></code>.</p></li>
<li><p><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – the identifier for the identity provider that is to be updated.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.identity.Provider</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors.identity_client.Providers.SetSpec" title="com.vmware.vcenter.namespace_management.supervisors.identity_client.Providers.SetSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.SetSpec</span></code></a>) – the {#link SetSpec} to be applied to the identity provider
configuration.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if the \&#64;{param.name spec} contains any errors.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the given identity provider or Supervisor cannot be found.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user cannot be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user is missing the Namespaces.Manage privilege on the
Supervisor.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management.supervisors.identity_client.Providers.update">
<code class="sig-name descname"><span class="pre">update</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">supervisor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">provider</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors.identity_client.Providers.update" title="Permalink to this definition"></a></dt>
<dd><p>Update an existing identity provider used with a Supervisor. This
method was added in vSphere API 8.0.0.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>supervisor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – the identifier for the Supervisor associated with the identity
provider to be updated.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.supervisor.Supervisor</span></code>.</p></li>
<li><p><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – the identifier for the identity provider that is to be updated.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.identity.Provider</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors.identity_client.Providers.UpdateSpec" title="com.vmware.vcenter.namespace_management.supervisors.identity_client.Providers.UpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.UpdateSpec</span></code></a>) – the {#UpdateSpec} to be applied to the identity provider
configuration.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if the \&#64;{param.name spec} contains any errors.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the given identity provider or Supervisor cannot be found.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user cannot be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user is missing the Namespaces.Manage privilege on the
Supervisor.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management.supervisors.identity_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.supervisors.identity_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors.identity_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="com.vmware.vcenter.namespace_management.supervisors.networks.html" class="btn btn-neutral float-right" title="com.vmware.vcenter.namespace_management.supervisors.networks package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="com.vmware.vcenter.namespace_management.networks.nsx.html" class="btn btn-neutral float-left" title="com.vmware.vcenter.namespace_management.networks.nsx package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; Copyright 2022, VMware, Inc..
</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
Copy Permalink