carto
/
grpc


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GRPC C++: grpc::experimental::StsCredentialsOptions Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">GRPC C++
   &#160;<span id="projectnumber">1.36.1</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespacegrpc.html">grpc</a></li><li class="navelem"><a class="el" href="namespacegrpc_1_1experimental.html">experimental</a></li><li class="navelem"><a class="el" href="structgrpc_1_1experimental_1_1_sts_credentials_options.html">StsCredentialsOptions</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">grpc::experimental::StsCredentialsOptions Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Options for creating STS Oauth Token Exchange credentials following the IETF draft <a href="https://tools.ietf.org/html/draft-ietf-oauth-token-exchange-16">https://tools.ietf.org/html/draft-ietf-oauth-token-exchange-16</a>.  
 <a href="structgrpc_1_1experimental_1_1_sts_credentials_options.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="grpcpp_2security_2credentials_8h_source.html">credentials.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a1897f713103d4d34922a31969d766b94"><td class="memItemLeft" align="right" valign="top">grpc::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc_1_1experimental_1_1_sts_credentials_options.html#a1897f713103d4d34922a31969d766b94">token_exchange_service_uri</a></td></tr>
<tr class="separator:a1897f713103d4d34922a31969d766b94"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa5744a0ed075281222199c8edd64c773"><td class="memItemLeft" align="right" valign="top">grpc::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc_1_1experimental_1_1_sts_credentials_options.html#aa5744a0ed075281222199c8edd64c773">resource</a></td></tr>
<tr class="separator:aa5744a0ed075281222199c8edd64c773"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a810e799b972db82960ee3ee28670ed06"><td class="memItemLeft" align="right" valign="top">grpc::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc_1_1experimental_1_1_sts_credentials_options.html#a810e799b972db82960ee3ee28670ed06">audience</a></td></tr>
<tr class="separator:a810e799b972db82960ee3ee28670ed06"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a076e5a44347af833494c87d8c6357e67"><td class="memItemLeft" align="right" valign="top">grpc::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc_1_1experimental_1_1_sts_credentials_options.html#a076e5a44347af833494c87d8c6357e67">scope</a></td></tr>
<tr class="separator:a076e5a44347af833494c87d8c6357e67"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae05063309fd005e4b47a9845dd5508c0"><td class="memItemLeft" align="right" valign="top">grpc::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc_1_1experimental_1_1_sts_credentials_options.html#ae05063309fd005e4b47a9845dd5508c0">requested_token_type</a></td></tr>
<tr class="separator:ae05063309fd005e4b47a9845dd5508c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a56e8e3f272d31f95066fd1d9dcaea406"><td class="memItemLeft" align="right" valign="top">grpc::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc_1_1experimental_1_1_sts_credentials_options.html#a56e8e3f272d31f95066fd1d9dcaea406">subject_token_path</a></td></tr>
<tr class="separator:a56e8e3f272d31f95066fd1d9dcaea406"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afdb201d09684fd89bf06ca92e0d18804"><td class="memItemLeft" align="right" valign="top">grpc::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc_1_1experimental_1_1_sts_credentials_options.html#afdb201d09684fd89bf06ca92e0d18804">subject_token_type</a></td></tr>
<tr class="separator:afdb201d09684fd89bf06ca92e0d18804"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f2116ad2d225e7093fc0770967845c2"><td class="memItemLeft" align="right" valign="top">grpc::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc_1_1experimental_1_1_sts_credentials_options.html#a2f2116ad2d225e7093fc0770967845c2">actor_token_path</a></td></tr>
<tr class="separator:a2f2116ad2d225e7093fc0770967845c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a774659bcf268544f08debe45a4bef4d6"><td class="memItemLeft" align="right" valign="top">grpc::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc_1_1experimental_1_1_sts_credentials_options.html#a774659bcf268544f08debe45a4bef4d6">actor_token_type</a></td></tr>
<tr class="separator:a774659bcf268544f08debe45a4bef4d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Options for creating STS Oauth Token Exchange credentials following the IETF draft <a href="https://tools.ietf.org/html/draft-ietf-oauth-token-exchange-16">https://tools.ietf.org/html/draft-ietf-oauth-token-exchange-16</a>. </p>
<p>Optional fields may be set to empty string. It is the responsibility of the caller to ensure that the subject and actor tokens are refreshed on disk at the specified paths. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a2f2116ad2d225e7093fc0770967845c2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2f2116ad2d225e7093fc0770967845c2">&#9670;&nbsp;</a></span>actor_token_path</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">grpc::string grpc::experimental::StsCredentialsOptions::actor_token_path</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a774659bcf268544f08debe45a4bef4d6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a774659bcf268544f08debe45a4bef4d6">&#9670;&nbsp;</a></span>actor_token_type</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">grpc::string grpc::experimental::StsCredentialsOptions::actor_token_type</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a810e799b972db82960ee3ee28670ed06"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a810e799b972db82960ee3ee28670ed06">&#9670;&nbsp;</a></span>audience</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">grpc::string grpc::experimental::StsCredentialsOptions::audience</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="ae05063309fd005e4b47a9845dd5508c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae05063309fd005e4b47a9845dd5508c0">&#9670;&nbsp;</a></span>requested_token_type</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">grpc::string grpc::experimental::StsCredentialsOptions::requested_token_type</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="aa5744a0ed075281222199c8edd64c773"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa5744a0ed075281222199c8edd64c773">&#9670;&nbsp;</a></span>resource</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">grpc::string grpc::experimental::StsCredentialsOptions::resource</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a076e5a44347af833494c87d8c6357e67"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a076e5a44347af833494c87d8c6357e67">&#9670;&nbsp;</a></span>scope</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">grpc::string grpc::experimental::StsCredentialsOptions::scope</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a56e8e3f272d31f95066fd1d9dcaea406"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a56e8e3f272d31f95066fd1d9dcaea406">&#9670;&nbsp;</a></span>subject_token_path</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">grpc::string grpc::experimental::StsCredentialsOptions::subject_token_path</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="afdb201d09684fd89bf06ca92e0d18804"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afdb201d09684fd89bf06ca92e0d18804">&#9670;&nbsp;</a></span>subject_token_type</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">grpc::string grpc::experimental::StsCredentialsOptions::subject_token_type</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a1897f713103d4d34922a31969d766b94"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1897f713103d4d34922a31969d766b94">&#9670;&nbsp;</a></span>token_exchange_service_uri</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">grpc::string grpc::experimental::StsCredentialsOptions::token_exchange_service_uri</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/grpcpp/security/<a class="el" href="grpcpp_2security_2credentials_8h_source.html">credentials.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Mar 3 2021 19:17:25 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>