carto
/
grpc


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239
							<!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 Core: grpc_sts_credentials_options 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 Core
   &#160;<span id="projectnumber">15.0.0</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><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">grpc_sts_credentials_options 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__sts__credentials__options.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="grpc__security_8h_source.html">grpc_security.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:ac40c27040b88f70a8a51e5a854eee68d"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__sts__credentials__options.html#ac40c27040b88f70a8a51e5a854eee68d">token_exchange_service_uri</a></td></tr>
<tr class="separator:ac40c27040b88f70a8a51e5a854eee68d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acccf3e0c9f7f8865718fbb8e51f2d5ab"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__sts__credentials__options.html#acccf3e0c9f7f8865718fbb8e51f2d5ab">resource</a></td></tr>
<tr class="separator:acccf3e0c9f7f8865718fbb8e51f2d5ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a91d3976529603354ce8bdf92394ef074"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__sts__credentials__options.html#a91d3976529603354ce8bdf92394ef074">audience</a></td></tr>
<tr class="separator:a91d3976529603354ce8bdf92394ef074"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1da17c75496e5debe7b89d3f43fc511b"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__sts__credentials__options.html#a1da17c75496e5debe7b89d3f43fc511b">scope</a></td></tr>
<tr class="separator:a1da17c75496e5debe7b89d3f43fc511b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a139402921fe862ba5c177d28c3d1ea90"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__sts__credentials__options.html#a139402921fe862ba5c177d28c3d1ea90">requested_token_type</a></td></tr>
<tr class="separator:a139402921fe862ba5c177d28c3d1ea90"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a26907053e134770f20c2e3506a7b3979"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__sts__credentials__options.html#a26907053e134770f20c2e3506a7b3979">subject_token_path</a></td></tr>
<tr class="separator:a26907053e134770f20c2e3506a7b3979"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a467b1184da37adc95e8180b66a3a628f"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__sts__credentials__options.html#a467b1184da37adc95e8180b66a3a628f">subject_token_type</a></td></tr>
<tr class="separator:a467b1184da37adc95e8180b66a3a628f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6085040c96239e50ee0650bd92b2a972"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__sts__credentials__options.html#a6085040c96239e50ee0650bd92b2a972">actor_token_path</a></td></tr>
<tr class="separator:a6085040c96239e50ee0650bd92b2a972"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a238c61ccc9d4b8091d34a6e525290a4c"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__sts__credentials__options.html#a238c61ccc9d4b8091d34a6e525290a4c">actor_token_type</a></td></tr>
<tr class="separator:a238c61ccc9d4b8091d34a6e525290a4c"><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 NULL or 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. This API is used for experimental purposes for now and may change in the future. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a6085040c96239e50ee0650bd92b2a972"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6085040c96239e50ee0650bd92b2a972">&#9670;&nbsp;</a></span>actor_token_path</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* grpc_sts_credentials_options::actor_token_path</td>
        </tr>
      </table>
</div><div class="memdoc">

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* grpc_sts_credentials_options::actor_token_type</td>
        </tr>
      </table>
</div><div class="memdoc">

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* grpc_sts_credentials_options::audience</td>
        </tr>
      </table>
</div><div class="memdoc">

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* grpc_sts_credentials_options::requested_token_type</td>
        </tr>
      </table>
</div><div class="memdoc">

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* grpc_sts_credentials_options::resource</td>
        </tr>
      </table>
</div><div class="memdoc">

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* grpc_sts_credentials_options::scope</td>
        </tr>
      </table>
</div><div class="memdoc">

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* grpc_sts_credentials_options::subject_token_path</td>
        </tr>
      </table>
</div><div class="memdoc">

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* grpc_sts_credentials_options::subject_token_type</td>
        </tr>
      </table>
</div><div class="memdoc">

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* grpc_sts_credentials_options::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/grpc/<a class="el" href="grpc__security_8h_source.html">grpc_security.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Mar 3 2021 19:17:11 for GRPC Core 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>