<spanid="com-vmware-vapi-package"></span><h1>com.vmware.vapi package<aclass="headerlink"href="#module-com.vmware.vapi"title="Permalink to this headline">¶</a></h1>
<divclass="section"id="subpackages">
<h2>Subpackages<aclass="headerlink"href="#subpackages"title="Permalink to this headline">¶</a></h2>
<spanid="com-vmware-vapi-std-client-module"></span><h2>com.vmware.vapi.std_client module<aclass="headerlink"href="#module-com.vmware.vapi.std_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client</span></code> module provides standard types that can be
used in the interface specification of any class.</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.std_client.</code><codeclass="descname">AuthenticationScheme</code><aclass="headerlink"href="#com.vmware.vapi.std_client.AuthenticationScheme"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">NO_AUTHENTICATION</code><emclass="property"> = 'com.vmware.vapi.std.security.no_authentication'</em><aclass="headerlink"href="#com.vmware.vapi.std_client.AuthenticationScheme.NO_AUTHENTICATION"title="Permalink to this definition">¶</a></dt>
<dd><p>Indicates that the request doesn’t need any authentication.</p>
<codeclass="descname">OAUTH_ACCESS_TOKEN</code><emclass="property"> = 'com.vmware.vapi.std.security.oauth'</em><aclass="headerlink"href="#com.vmware.vapi.std_client.AuthenticationScheme.OAUTH_ACCESS_TOKEN"title="Permalink to this definition">¶</a></dt>
<dd><p>Indicates that the security context in a request is using OAuth2 based
authentication scheme.</p>
<p>In this scheme, the following pieces of information has to be passed in the
SecurityContext structure in the execution context of the request:</p>
<li>Valid OAuth2 access token - This is usually acquired by OAuth2 Authorization
Server after successful authentication of the end user.</li>
</ul>
<blockquote>
<div>Sample security context in JSON format that matches the specification: <ahref="#id1"><spanclass="problematic"id="id2">``</span></a>{</div></blockquote>
<codeclass="descname">SAML_BEARER_TOKEN</code><emclass="property"> = 'com.vmware.vapi.std.security.saml_bearer_token'</em><aclass="headerlink"href="#com.vmware.vapi.std_client.AuthenticationScheme.SAML_BEARER_TOKEN"title="Permalink to this definition">¶</a></dt>
<dd><p>Indicates that the security context in a request is using a SAML bearer token
based authentication scheme.</p>
<p>In this scheme, the following pieces of information has to be passed in the
SecurityContext structure in the execution context of the request:</p>
<div>Sample security context in JSON format that matches the specification: <ahref="#id3"><spanclass="problematic"id="id4">``</span></a>{</div></blockquote>
<codeclass="descname">SAML_HOK_TOKEN</code><emclass="property"> = 'com.vmware.vapi.std.security.saml_hok_token'</em><aclass="headerlink"href="#com.vmware.vapi.std_client.AuthenticationScheme.SAML_HOK_TOKEN"title="Permalink to this definition">¶</a></dt>
<dd><p>Indicates that the security context in a request is using a SAML holder-of-key
token based authentication scheme.</p>
<p>In this scheme, the following pieces of information has to be passed in the
SecurityContext structure in the execution context of the request:</p>
<li>Signature of the request: This includes - algorithm used for signing the
request, SAML holder of key token and signature digest</li>
<li>Request timestamp: This includes the <codeclass="docutils literal notranslate"><spanclass="pre">created</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">expires</span></code> timestamp of
the request. The timestamp should match the following format -
<div>Sample security context in JSON format that matches the specification: <ahref="#id5"><spanclass="problematic"id="id6">``</span></a>{</div></blockquote>
<codeclass="descname">SESSION_ID</code><emclass="property"> = 'com.vmware.vapi.std.security.session_id'</em><aclass="headerlink"href="#com.vmware.vapi.std_client.AuthenticationScheme.SESSION_ID"title="Permalink to this definition">¶</a></dt>
<dd><p>Indicates that the security context in a request is using a session identifier
based authentication scheme.</p>
<p>In this scheme, the following pieces of information has to be passed in the
SecurityContext structure in the execution context of the request:</p>
<li>Valid session identifier - This is usually returned by a login method of a
session manager interface for a particular vAPI service of this authentication
scheme</li>
</ul>
<blockquote>
<div>Sample security context in JSON format that matches the specification: <ahref="#id7"><spanclass="problematic"id="id8">``</span></a>{</div></blockquote>
<codeclass="descname">USER_PASSWORD</code><emclass="property"> = 'com.vmware.vapi.std.security.user_pass'</em><aclass="headerlink"href="#com.vmware.vapi.std_client.AuthenticationScheme.USER_PASSWORD"title="Permalink to this definition">¶</a></dt>
<dd><p>Indicates that the security context in a request is using username/password
based authentication scheme.</p>
<p>In this scheme, the following pieces of information has to be passed in the
SecurityContext structure in the execution context of the request:</p>
<div>Sample security context in JSON format that matches the specification: <ahref="#id9"><spanclass="problematic"id="id10">``</span></a>{</div></blockquote>
vAPI runtime provides convenient factory methods that take username and
password as input parameters and create a security context that conforms to the
above format.</p>
</dd></dl>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vapi.std_client.DynamicID">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.std_client.</code><codeclass="descname">DynamicID</code><spanclass="sig-paren">(</span><em>type=None</em>, <em>id=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.std_client.DynamicID"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) –<p>The type of resource being identified (for example
<p>Classes that contain methods for creating and deleting resources
typically contain a class attribute specifying the resource type
for the resources being created and deleted. The API metamodel
metadata classes include a class that allows retrieving all the
known resource types.</p>
</li>
<li><strong>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier for a resource whose type is specified by
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.std_client.</code><codeclass="descname">LocalizableMessage</code><spanclass="sig-paren">(</span><em>id=None</em>, <em>default_message=None</em>, <em>args=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.std_client.LocalizableMessage"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) –<p>Unique identifier of the localizable string or message template.</p>
<p>This identifier is typically used to retrieve a locale-specific
string or message template from a message catalog.</p>
</li>
<li><strong>default_message</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The value of this localizable string or message template in the
to a message template, the default message will contain the
substituted arguments. This value can be used by clients that do
not need to display strings and messages in the native language of
the user. It could also be used as a fallback if a client is unable
to access the appropriate message catalog.</li>
<li><strong>args</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Arguments to be substituted into a message template.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vapi.std_client.StubFactory">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.std_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.std_client.StubFactory"title="Permalink to this definition">¶</a></dt>
Built with <ahref="http://sphinx-doc.org/">Sphinx</a> using a <ahref="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <ahref="https://readthedocs.org">Read the Docs</a>.
