2019-01-16 05:37:32 -05:00
<!DOCTYPE html>
2020-09-11 09:36:05 -04:00
< html class = "writer-html5" lang = "en" >
2019-01-16 05:37:32 -05:00
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
2020-11-09 23:31:11 -05:00
< title > vmware.vapi.vmc package — vmc 1.30.0 documentation< / title >
2019-01-16 05:37:32 -05:00
2020-09-11 09:36:05 -04:00
< link rel = "stylesheet" href = "_static/css/theme.css" type = "text/css" / >
< link rel = "stylesheet" href = "_static/pygments.css" type = "text/css" / >
2019-01-16 05:37:32 -05:00
2020-09-11 09:36:05 -04:00
<!-- [if lt IE 9]>
< script src = "_static/js/html5shiv.min.js" > < / script >
<![endif]-->
2019-04-17 00:48:58 -04:00
2019-04-15 06:06:35 -04:00
2019-05-29 06:01:09 -04:00
< script type = "text/javascript" id = "documentation_options" data-url_root = "./" src = "_static/documentation_options.js" > < / script >
2020-02-11 05:55:07 -05:00
< script src = "_static/jquery.js" > < / script >
< script src = "_static/underscore.js" > < / script >
< script src = "_static/doctools.js" > < / script >
< script src = "_static/language_data.js" > < / script >
2019-05-29 06:01:09 -04:00
< script type = "text/javascript" src = "_static/js/theme.js" > < / script >
2019-01-16 05:37:32 -05:00
2019-05-29 06:01:09 -04:00
2019-01-16 05:37:32 -05:00
< link rel = "index" title = "Index" href = "genindex.html" / >
< link rel = "search" title = "Search" href = "search.html" / >
< link rel = "prev" title = "vmware.vapi package" href = "vmware.vapi.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" >
2019-05-29 06:01:09 -04:00
< div class = "wy-side-nav-search" >
2019-01-16 05:37:32 -05:00
2020-09-11 09:36:05 -04:00
< a href = "index.html" class = "icon icon-home" alt = "Documentation Home" > vmc
2019-01-16 05:37:32 -05:00
< / a >
< div class = "version" >
2020-11-09 23:31:11 -05:00
1.30.0
2019-01-16 05:37:32 -05:00
< / 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 >
2020-09-11 09:36:05 -04:00
2019-01-16 05:37:32 -05:00
< 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" > < a class = "reference internal" href = "com.html" > com package< / a > < / li >
< li class = "toctree-l1 current" > < a class = "reference internal" href = "vmware.html" > vmware package< / a > < ul class = "current" >
< li class = "toctree-l2 current" > < a class = "reference internal" href = "vmware.html#subpackages" > Subpackages< / a > < ul class = "current" >
< li class = "toctree-l3 current" > < a class = "reference internal" href = "vmware.vapi.html" > vmware.vapi package< / a > < ul class = "current" >
< li class = "toctree-l4 current" > < a class = "reference internal" href = "vmware.vapi.html#subpackages" > Subpackages< / a > < / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< / div >
2020-09-11 09:36:05 -04:00
2019-01-16 05:37:32 -05:00
< / 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 >
2019-10-16 07:29:13 -04:00
< a href = "index.html" > vmc< / a >
2019-01-16 05:37:32 -05:00
< / nav >
< div class = "wy-nav-content" >
< div class = "rst-content" >
< div role = "navigation" aria-label = "breadcrumbs navigation" >
< ul class = "wy-breadcrumbs" >
2020-09-11 09:36:05 -04:00
< li > < a href = "index.html" class = "icon icon-home" > < / a > » < / li >
2019-01-16 05:37:32 -05:00
< li > < a href = "vmware.html" > vmware package< / a > » < / li >
< li > < a href = "vmware.vapi.html" > vmware.vapi package< / a > » < / li >
< li > vmware.vapi.vmc package< / li >
< li class = "wy-breadcrumbs-aside" >
< a href = "_sources/vmware.vapi.vmc.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-vmware.vapi.vmc" >
< span id = "vmware-vapi-vmc-package" > < / span > < h1 > vmware.vapi.vmc package< a class = "headerlink" href = "#module-vmware.vapi.vmc" title = "Permalink to this headline" > ¶< / a > < / h1 >
< div class = "section" id = "submodules" >
< h2 > Submodules< a class = "headerlink" href = "#submodules" title = "Permalink to this headline" > ¶< / a > < / h2 >
< / div >
2020-01-30 01:11:02 -05:00
< div class = "section" id = "vmware-vapi-vmc-client-module" >
< h2 > vmware.vapi.vmc.client module< a class = "headerlink" href = "#vmware-vapi-vmc-client-module" title = "Permalink to this headline" > ¶< / a > < / h2 >
2019-01-16 05:37:32 -05:00
< / div >
< div class = "section" id = "module-vmware.vapi.vmc.csp_filter" >
< span id = "vmware-vapi-vmc-csp-filter-module" > < / span > < h2 > vmware.vapi.vmc.csp_filter module< a class = "headerlink" href = "#module-vmware.vapi.vmc.csp_filter" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > CSP Refresh token based SecurityContextFilter< / p >
2020-05-15 16:54:03 -04:00
< dl class = "py class" >
2019-01-16 05:37:32 -05:00
< dt id = "vmware.vapi.vmc.csp_filter.CSPSecurityContextFilter" >
2020-05-15 16:54:03 -04:00
< em class = "property" > class < / em > < code class = "sig-prename descclassname" > vmware.vapi.vmc.csp_filter.< / code > < code class = "sig-name descname" > CSPSecurityContextFilter< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > session< / span > < / em > , < em class = "sig-param" > < span class = "n" > refresh_token< / span > < / em > , < em class = "sig-param" > < span class = "n" > refresh_url< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#vmware.vapi.vmc.csp_filter.CSPSecurityContextFilter" title = "Permalink to this definition" > ¶< / a > < / dt >
2019-01-16 05:37:32 -05:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.security.client.security_context_filter.SecurityContextFilter< / span > < / code > < / p >
< p > CSP Security Context filter in API Provider chain adds the security
context based on a refresh token to the execution context passed in.< / p >
< p > Initialize SecurityContextFilter< / p >
2019-06-08 00:29:34 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > session< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > requests.Session< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > refresh_token< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > refresh_url< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) –
access token< / p > < / li >
2019-01-16 05:37:32 -05:00
< / ul >
2019-06-08 00:29:34 -04:00
< / dd >
< / dl >
2020-05-15 16:54:03 -04:00
< dl class = "py method" >
2019-01-16 05:37:32 -05:00
< dt id = "vmware.vapi.vmc.csp_filter.CSPSecurityContextFilter.get_max_retries" >
2019-06-08 00:29:34 -04:00
< code class = "sig-name descname" > get_max_retries< / code > < span class = "sig-paren" > (< / span > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#vmware.vapi.vmc.csp_filter.CSPSecurityContextFilter.get_max_retries" title = "Permalink to this definition" > ¶< / a > < / dt >
2019-01-16 05:37:32 -05:00
< dd > < p > Get the max number of retries< / p >
2019-06-08 00:29:34 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Return type< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > int< / span > < / code > < / p >
< / dd >
< dt class = "field-even" > Returns< / dt >
< dd class = "field-even" > < p > Number of retries< / p >
< / dd >
< / dl >
2019-01-16 05:37:32 -05:00
< / dd > < / dl >
2020-05-15 16:54:03 -04:00
< dl class = "py method" >
2019-01-16 05:37:32 -05:00
< dt id = "vmware.vapi.vmc.csp_filter.CSPSecurityContextFilter.get_security_context" >
2020-05-15 16:54:03 -04:00
< code class = "sig-name descname" > get_security_context< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > on_error< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#vmware.vapi.vmc.csp_filter.CSPSecurityContextFilter.get_security_context" title = "Permalink to this definition" > ¶< / a > < / dt >
2019-01-16 05:37:32 -05:00
< dd > < p > Retrieve security context. If this method is called after an error
occured, then a new access token is obtained using the refresh token and
a new security context is created.< / p >
2019-06-08 00:29:34 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < p > < strong > on_error< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > bool< / span > < / code > ) – < / p >
< / 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" > vmware.vapi.core.SecurityContext< / span > < / code > < / p >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > Security context< / p >
< / dd >
< / dl >
2019-01-16 05:37:32 -05:00
< / dd > < / dl >
2020-05-15 16:54:03 -04:00
< dl class = "py method" >
2019-01-16 05:37:32 -05:00
< dt id = "vmware.vapi.vmc.csp_filter.CSPSecurityContextFilter.should_retry" >
2020-05-15 16:54:03 -04:00
< code class = "sig-name descname" > should_retry< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > error_value< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#vmware.vapi.vmc.csp_filter.CSPSecurityContextFilter.should_retry" title = "Permalink to this definition" > ¶< / a > < / dt >
2019-01-16 05:37:32 -05:00
< dd > < p > Returns whether the request should be retried or not based on the error
specified.< / p >
2019-06-08 00:29:34 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < p > < strong > error_value< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.data.value.ErrorValue< / span > < / code > ) – < / p >
< / 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" > bool< / span > < / code > < / p >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > Returns True if request should be retried in case the error is
either Unauthenticated or Unauthorized else False< / p >
< / dd >
< / dl >
2019-01-16 05:37:32 -05:00
< / dd > < / dl >
< / dd > < / dl >
< / div >
< / div >
< / div >
< / div >
< footer >
< div class = "rst-footer-buttons" role = "navigation" aria-label = "footer navigation" >
2019-05-29 06:01:09 -04:00
< a href = "vmware.vapi.html" class = "btn btn-neutral float-left" title = "vmware.vapi package" accesskey = "p" rel = "prev" > < span class = "fa fa-arrow-circle-left" > < / span > Previous< / a >
2019-01-16 05:37:32 -05:00
< / div >
< hr / >
< div role = "contentinfo" >
< p >
2020-09-11 09:36:05 -04:00
2020-01-16 23:32:45 -05:00
© Copyright 2020, VMware, Inc.
2019-01-16 05:37:32 -05:00
< / p >
< / div >
2020-09-11 09:36:05 -04:00
Built with < a href = "http://sphinx-doc.org/" > Sphinx< / a > using a
< a href = "https://github.com/rtfd/sphinx_rtd_theme" > theme< / a >
provided by < a href = "https://readthedocs.org" > Read the Docs< / a > .
2019-01-16 05:37:32 -05:00
< / footer >
< / div >
< / div >
< / section >
< / div >
< script type = "text/javascript" >
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
2019-05-29 06:01:09 -04:00
< / script >
2019-01-16 05:37:32 -05:00
< / body >
< / html >
