Mirrors/vsphere-automation-sdk-python
1
0
Fork 0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-22 09:39:58 -05:00
Code
gh-pages
vsphere-automation-sdk-python/vsphere/8.0.3.0/com.vmware.oauth2.html

472 lines
42 KiB
HTML
Raw Permalink Normal View History

Updated VC docs for v8.0.3.0 (#424) Signed-off-by: Prajwal Bhagat <prajwal.bhagat@broadcom.com> Co-authored-by: Prajwal Bhagat <prajwal.bhagat@broadcom.com>
2024-07-03 08:14:27 -04:00
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>com.vmware.oauth2 package &mdash; vSphere Automation SDK for Python. 8.0.3.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script 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.snapservice package" href="com.vmware.snapservice.html" />
<link rel="prev" title="com.vmware.esx.settings.hosts.software.drafts package" href="com.vmware.esx.settings.hosts.software.drafts.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.3.0
</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" aria-label="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="Navigation menu">
<p class="caption" role="heading"><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.esx_client">com.vmware.esx_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.snapservice_client">com.vmware.snapservice_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>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<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="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="com.html">com package</a></li>
<li class="breadcrumb-item"><a href="com.vmware.html">com.vmware package</a></li>
<li class="breadcrumb-item active">com.vmware.oauth2 package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/com.vmware.oauth2.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">
<section id="module-com.vmware.oauth2">
<span id="com-vmware-oauth2-package"></span><h1>com.vmware.oauth2 package<a class="headerlink" href="#module-com.vmware.oauth2" title="Permalink to this heading"></a></h1>
<section id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading"></a></h2>
</section>
<section id="module-com.vmware.oauth2.errors_client">
<span id="com-vmware-oauth2-errors-client-module"></span><h2>com.vmware.oauth2.errors_client module<a class="headerlink" href="#module-com.vmware.oauth2.errors_client" title="Permalink to this heading"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.oauth2.errors_client</span></code> module provides the OAuth 2.0
exceptions that can be included in the list of exceptions in the specification
of OAuth 2.0 methods to indicate that the method might report those exceptions.</p>
<dl class="py exception">
<dt class="sig sig-object py" id="com.vmware.oauth2.errors_client.Error">
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.oauth2.errors_client.</span></span><span class="sig-name descname"><span class="pre">Error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error</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">error_description</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">error_uri</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.oauth2.errors_client.Error" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiError</span></code></p>
<p>The OAuth2 <code class="docutils literal notranslate"><span class="pre">Error</span></code> describes the attributes common to standard OAuth 2.0
exceptions.</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<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>error</strong> (<a class="reference internal" href="#com.vmware.oauth2.errors_client.Error.Type" title="com.vmware.oauth2.errors_client.Error.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error.Type</span></code></a>) – Discriminator field to help API consumers identify the structure
type.</p></li>
<li><p><strong>error_description</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>) – Human-readable ASCII text providing additional information, used to
assist the client developer in understanding the error that
occurred. Values for the “error_description” parameter MUST NOT
include characters outside the set %x20-21 / %x23-5B / %x5D-7E.
if no additional information is available.</p></li>
<li><p><strong>error_uri</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 URI identifying a human-readable web page with information about
the error, used to provide the client developer with additional
information about the error.
if no such web-page is available.</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.oauth2.errors_client.Error.Type">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Type</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.oauth2.errors_client.Error.Type" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
<p>Enumeration of OAuth 2.0 exceptions.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="bora/vspherevmodl2/enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.oauth2.errors_client.Error.Type.invalid_client">
<span class="sig-name descname"><span class="pre">invalid_client</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Type(string='invalid_client')</span></em><a class="headerlink" href="#com.vmware.oauth2.errors_client.Error.Type.invalid_client" title="Permalink to this definition"></a></dt>
<dd><p>Discriminator for the <a class="reference internal" href="#com.vmware.oauth2.errors_client.InvalidClient" title="com.vmware.oauth2.errors_client.InvalidClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">InvalidClient</span></code></a> type. This class attribute was
added in vSphere API 8.0.3.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.oauth2.errors_client.Error.Type.invalid_grant">
<span class="sig-name descname"><span class="pre">invalid_grant</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Type(string='invalid_grant')</span></em><a class="headerlink" href="#com.vmware.oauth2.errors_client.Error.Type.invalid_grant" title="Permalink to this definition"></a></dt>
<dd><p>Discriminator for the <a class="reference internal" href="#com.vmware.oauth2.errors_client.InvalidGrant" title="com.vmware.oauth2.errors_client.InvalidGrant"><code class="xref py py-class docutils literal notranslate"><span class="pre">InvalidGrant</span></code></a> type.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.oauth2.errors_client.Error.Type.invalid_request">
<span class="sig-name descname"><span class="pre">invalid_request</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Type(string='invalid_request')</span></em><a class="headerlink" href="#com.vmware.oauth2.errors_client.Error.Type.invalid_request" title="Permalink to this definition"></a></dt>
<dd><p>Discriminator for the <a class="reference internal" href="#com.vmware.oauth2.errors_client.InvalidRequest" title="com.vmware.oauth2.errors_client.InvalidRequest"><code class="xref py py-class docutils literal notranslate"><span class="pre">InvalidRequest</span></code></a> type.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.oauth2.errors_client.Error.Type.invalid_scope">
<span class="sig-name descname"><span class="pre">invalid_scope</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Type(string='invalid_scope')</span></em><a class="headerlink" href="#com.vmware.oauth2.errors_client.Error.Type.invalid_scope" title="Permalink to this definition"></a></dt>
<dd><p>Discriminator for the <a class="reference internal" href="#com.vmware.oauth2.errors_client.InvalidScope" title="com.vmware.oauth2.errors_client.InvalidScope"><code class="xref py py-class docutils literal notranslate"><span class="pre">InvalidScope</span></code></a> type.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.oauth2.errors_client.Error.Type.invalid_target">
<span class="sig-name descname"><span class="pre">invalid_target</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Type(string='invalid_target')</span></em><a class="headerlink" href="#com.vmware.oauth2.errors_client.Error.Type.invalid_target" title="Permalink to this definition"></a></dt>
<dd><p>Discriminator for the <a class="reference internal" href="#com.vmware.oauth2.errors_client.InvalidTarget" title="com.vmware.oauth2.errors_client.InvalidTarget"><code class="xref py py-class docutils literal notranslate"><span class="pre">InvalidTarget</span></code></a> type. This class attribute was
added in vSphere API 8.0.3.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.oauth2.errors_client.Error.Type.unauthorized_client">
<span class="sig-name descname"><span class="pre">unauthorized_client</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Type(string='unauthorized_client')</span></em><a class="headerlink" href="#com.vmware.oauth2.errors_client.Error.Type.unauthorized_client" title="Permalink to this definition"></a></dt>
<dd><p>Discriminator for the <a class="reference internal" href="#com.vmware.oauth2.errors_client.UnauthorizedClient" title="com.vmware.oauth2.errors_client.UnauthorizedClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">UnauthorizedClient</span></code></a> type. This class
attribute was added in vSphere API 8.0.3.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.oauth2.errors_client.Error.Type.unsupported_grant_type">
<span class="sig-name descname"><span class="pre">unsupported_grant_type</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Type(string='unsupported_grant_type')</span></em><a class="headerlink" href="#com.vmware.oauth2.errors_client.Error.Type.unsupported_grant_type" title="Permalink to this definition"></a></dt>
<dd><p>Discriminator for the <a class="reference internal" href="#com.vmware.oauth2.errors_client.UnsupportedGrantType" title="com.vmware.oauth2.errors_client.UnsupportedGrantType"><code class="xref py py-class docutils literal notranslate"><span class="pre">UnsupportedGrantType</span></code></a> type. This class
attribute was added in vSphere API 8.0.3.0.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="com.vmware.oauth2.errors_client.InvalidClient">
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.oauth2.errors_client.</span></span><span class="sig-name descname"><span class="pre">InvalidClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'INVALID_CLIENT'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error_description</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">error_uri</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">challenge</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.oauth2.errors_client.InvalidClient" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#com.vmware.oauth2.errors_client.Error" title="com.vmware.oauth2.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error</span></code></a></p>
<p>Indicates that the client authentication failed (e.g., unknown client, no
client authentication included, or unsupported authentication method). This
class was added in vSphere API 8.0.3.0.</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<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>error</strong> (<a class="reference internal" href="#com.vmware.oauth2.errors_client.Error.Type" title="com.vmware.oauth2.errors_client.Error.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error.Type</span></code></a>) – Discriminator field to help API consumers identify the structure
type.</p></li>
<li><p><strong>error_description</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>) – Human-readable ASCII text providing additional information, used to
assist the client developer in understanding the error that
occurred. Values for the “error_description” parameter MUST NOT
include characters outside the set %x20-21 / %x23-5B / %x5D-7E.
if no additional information is available.</p></li>
<li><p><strong>error_uri</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 URI identifying a human-readable web page with information about
the error, used to provide the client developer with additional
information about the error.
if no such web-page is available.</p></li>
<li><p><strong>challenge</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Authentication header as defined in <a class="reference external" href="https://tools.ietf.org/html/rfc9110#name-www-authenticate">RFC 9110, Section 11.6.1 -
WWW-Authenticate</a>. The
“WWW-Authenticate” response header field indicates the
authentication scheme(s) and parameters applicable to the target
resource. This attribute was added in vSphere API 8.0.3.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="com.vmware.oauth2.errors_client.InvalidGrant">
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.oauth2.errors_client.</span></span><span class="sig-name descname"><span class="pre">InvalidGrant</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'INVALID_GRANT'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error_description</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">error_uri</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.oauth2.errors_client.InvalidGrant" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#com.vmware.oauth2.errors_client.Error" title="com.vmware.oauth2.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error</span></code></a></p>
<p>Indicates that the provided authorization grant (e.g., authorization code,
resource owner credentials) or refresh token is invalid, expired, revoked,
does not match the redirection URI used in the authorization request, or
was issued to another client.</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<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>error</strong> (<a class="reference internal" href="#com.vmware.oauth2.errors_client.Error.Type" title="com.vmware.oauth2.errors_client.Error.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error.Type</span></code></a>) – Discriminator field to help API consumers identify the structure
type.</p></li>
<li><p><strong>error_description</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>) – Human-readable ASCII text providing additional information, used to
assist the client developer in understanding the error that
occurred. Values for the “error_description” parameter MUST NOT
include characters outside the set %x20-21 / %x23-5B / %x5D-7E.
if no additional information is available.</p></li>
<li><p><strong>error_uri</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 URI identifying a human-readable web page with information about
the error, used to provide the client developer with additional
information about the error.
if no such web-page is available.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="com.vmware.oauth2.errors_client.InvalidRequest">
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.oauth2.errors_client.</span></span><span class="sig-name descname"><span class="pre">InvalidRequest</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'INVALID_REQUEST'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error_description</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">error_uri</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.oauth2.errors_client.InvalidRequest" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#com.vmware.oauth2.errors_client.Error" title="com.vmware.oauth2.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error</span></code></a></p>
<p>Indicates that the request is missing a required parameter, includes an
unsupported parameter value (other than grant type), repeats a parameter,
includes multiple credentials, utilizes more than one mechanism for
authenticating the client, or is otherwise malformed</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<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>error</strong> (<a class="reference internal" href="#com.vmware.oauth2.errors_client.Error.Type" title="com.vmware.oauth2.errors_client.Error.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error.Type</span></code></a>) – Discriminator field to help API consumers identify the structure
type.</p></li>
<li><p><strong>error_description</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>) – Human-readable ASCII text providing additional information, used to
assist the client developer in understanding the error that
occurred. Values for the “error_description” parameter MUST NOT
include characters outside the set %x20-21 / %x23-5B / %x5D-7E.
if no additional information is available.</p></li>
<li><p><strong>error_uri</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 URI identifying a human-readable web page with information about
the error, used to provide the client developer with additional
information about the error.
if no such web-page is available.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="com.vmware.oauth2.errors_client.InvalidScope">
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.oauth2.errors_client.</span></span><span class="sig-name descname"><span class="pre">InvalidScope</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'INVALID_SCOPE'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error_description</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">error_uri</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.oauth2.errors_client.InvalidScope" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#com.vmware.oauth2.errors_client.Error" title="com.vmware.oauth2.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error</span></code></a></p>
<p>Indicates that the requested scope is invalid, unknown, malformed, or
exceeds the scope granted by the resource owner.</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<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>error</strong> (<a class="reference internal" href="#com.vmware.oauth2.errors_client.Error.Type" title="com.vmware.oauth2.errors_client.Error.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error.Type</span></code></a>) – Discriminator field to help API consumers identify the structure
type.</p></li>
<li><p><strong>error_description</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>) – Human-readable ASCII text providing additional information, used to
assist the client developer in understanding the error that
occurred. Values for the “error_description” parameter MUST NOT
include characters outside the set %x20-21 / %x23-5B / %x5D-7E.
if no additional information is available.</p></li>
<li><p><strong>error_uri</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 URI identifying a human-readable web page with information about
the error, used to provide the client developer with additional
information about the error.
if no such web-page is available.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="com.vmware.oauth2.errors_client.InvalidTarget">
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.oauth2.errors_client.</span></span><span class="sig-name descname"><span class="pre">InvalidTarget</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'INVALID_TARGET'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error_description</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">error_uri</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.oauth2.errors_client.InvalidTarget" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#com.vmware.oauth2.errors_client.Error" title="com.vmware.oauth2.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error</span></code></a></p>
<p>Indicates that the authorization server is unwilling or unable to issue a
token for any target service. This class was added in vSphere API 8.0.3.0.</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<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>error</strong> (<a class="reference internal" href="#com.vmware.oauth2.errors_client.Error.Type" title="com.vmware.oauth2.errors_client.Error.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error.Type</span></code></a>) – Discriminator field to help API consumers identify the structure
type.</p></li>
<li><p><strong>error_description</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>) – Human-readable ASCII text providing additional information, used to
assist the client developer in understanding the error that
occurred. Values for the “error_description” parameter MUST NOT
include characters outside the set %x20-21 / %x23-5B / %x5D-7E.
if no additional information is available.</p></li>
<li><p><strong>error_uri</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 URI identifying a human-readable web page with information about
the error, used to provide the client developer with additional
information about the error.
if no such web-page is available.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.oauth2.errors_client.StubFactory">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.oauth2.errors_client.</span></span><span class="sig-name descname"><span class="pre">StubFactory</span></span><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.oauth2.errors_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></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>
<dl class="py exception">
<dt class="sig sig-object py" id="com.vmware.oauth2.errors_client.UnauthorizedClient">
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.oauth2.errors_client.</span></span><span class="sig-name descname"><span class="pre">UnauthorizedClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'UNAUTHORIZED_CLIENT'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error_description</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">error_uri</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.oauth2.errors_client.UnauthorizedClient" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#com.vmware.oauth2.errors_client.Error" title="com.vmware.oauth2.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error</span></code></a></p>
<p>Indicates that the authenticated client is not authorized to use this
authorization grant type. This class was added in vSphere API 8.0.3.0.</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<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>error</strong> (<a class="reference internal" href="#com.vmware.oauth2.errors_client.Error.Type" title="com.vmware.oauth2.errors_client.Error.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error.Type</span></code></a>) – Discriminator field to help API consumers identify the structure
type.</p></li>
<li><p><strong>error_description</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>) – Human-readable ASCII text providing additional information, used to
assist the client developer in understanding the error that
occurred. Values for the “error_description” parameter MUST NOT
include characters outside the set %x20-21 / %x23-5B / %x5D-7E.
if no additional information is available.</p></li>
<li><p><strong>error_uri</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 URI identifying a human-readable web page with information about
the error, used to provide the client developer with additional
information about the error.
if no such web-page is available.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="com.vmware.oauth2.errors_client.UnsupportedGrantType">
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.oauth2.errors_client.</span></span><span class="sig-name descname"><span class="pre">UnsupportedGrantType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'UNSUPPORTED_GRANT_TYPE'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error_description</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">error_uri</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.oauth2.errors_client.UnsupportedGrantType" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#com.vmware.oauth2.errors_client.Error" title="com.vmware.oauth2.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error</span></code></a></p>
<p>Indicates that the authorization grant type is not supported by the
authorization server. This class was added in vSphere API 8.0.3.0.</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<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>error</strong> (<a class="reference internal" href="#com.vmware.oauth2.errors_client.Error.Type" title="com.vmware.oauth2.errors_client.Error.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error.Type</span></code></a>) – Discriminator field to help API consumers identify the structure
type.</p></li>
<li><p><strong>error_description</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>) – Human-readable ASCII text providing additional information, used to
assist the client developer in understanding the error that
occurred. Values for the “error_description” parameter MUST NOT
include characters outside the set %x20-21 / %x23-5B / %x5D-7E.
if no additional information is available.</p></li>
<li><p><strong>error_uri</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 URI identifying a human-readable web page with information about
the error, used to provide the client developer with additional
information about the error.
if no such web-page is available.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="com.vmware.esx.settings.hosts.software.drafts.html" class="btn btn-neutral float-left" title="com.vmware.esx.settings.hosts.software.drafts package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="com.vmware.snapservice.html" class="btn btn-neutral float-right" title="com.vmware.snapservice package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2024, Broadcom, 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>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
Copy Permalink