blob: ecd038e33903f6378af70ebcdaddac745b0b7d05 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>OpenIdProviderMetadata</title>
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../../script.js"></script>
<link rel="shortcut icon" href="/img/jakarta-favicon.ico">
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="OpenIdProviderMetadata";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../jakarta/security/enterprise/authentication/mechanism/http/openid/OpenIdConstant.html" title="interface in jakarta.security.enterprise.authentication.mechanism.http.openid"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../jakarta/security/enterprise/authentication/mechanism/http/openid/PromptType.html" title="enum in jakarta.security.enterprise.authentication.mechanism.http.openid"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?jakarta/security/enterprise/authentication/mechanism/http/openid/OpenIdProviderMetadata.html" target="_top">Frames</a></li>
<li><a href="OpenIdProviderMetadata.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Required&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.element.detail">Element</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">jakarta.security.enterprise.authentication.mechanism.http.openid</div>
<h2 title="Annotation Type OpenIdProviderMetadata" class="title">Annotation Type OpenIdProviderMetadata</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>@Retention(value=RUNTIME)
public @interface <span class="memberNameLabel">OpenIdProviderMetadata</span></pre>
<div class="block"><a href="../../../../../../../jakarta/security/enterprise/authentication/mechanism/http/openid/OpenIdProviderMetadata.html" title="annotation in jakarta.security.enterprise.authentication.mechanism.http.openid"><code>OpenIdProviderMetadata</code></a> annotation overrides the openid connect
provider's endpoint value, discovered using providerUri.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="annotation.type.optional.element.summary">
<!-- -->
</a>
<h3>Optional Element Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation">
<caption><span>Optional Elements</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Optional Element and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../jakarta/security/enterprise/authentication/mechanism/http/openid/OpenIdProviderMetadata.html#authorizationEndpoint--">authorizationEndpoint</a></span></code>
<div class="block">Required.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../jakarta/security/enterprise/authentication/mechanism/http/openid/OpenIdProviderMetadata.html#endSessionEndpoint--">endSessionEndpoint</a></span></code>
<div class="block">Optional.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../jakarta/security/enterprise/authentication/mechanism/http/openid/OpenIdProviderMetadata.html#idTokenSigningAlgorithmsSupported--">idTokenSigningAlgorithmsSupported</a></span></code>
<div class="block">Required.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../jakarta/security/enterprise/authentication/mechanism/http/openid/OpenIdProviderMetadata.html#issuer--">issuer</a></span></code>
<div class="block">Required.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../jakarta/security/enterprise/authentication/mechanism/http/openid/OpenIdProviderMetadata.html#jwksURI--">jwksURI</a></span></code>
<div class="block">Required.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../jakarta/security/enterprise/authentication/mechanism/http/openid/OpenIdProviderMetadata.html#responseTypeSupported--">responseTypeSupported</a></span></code>
<div class="block">Required.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../jakarta/security/enterprise/authentication/mechanism/http/openid/OpenIdProviderMetadata.html#subjectTypeSupported--">subjectTypeSupported</a></span></code>
<div class="block">Required.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../jakarta/security/enterprise/authentication/mechanism/http/openid/OpenIdProviderMetadata.html#tokenEndpoint--">tokenEndpoint</a></span></code>
<div class="block">Required.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../jakarta/security/enterprise/authentication/mechanism/http/openid/OpenIdProviderMetadata.html#userinfoEndpoint--">userinfoEndpoint</a></span></code>
<div class="block">Required.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="annotation.type.element.detail">
<!-- -->
</a>
<h3>Element Detail</h3>
<a name="authorizationEndpoint--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>authorizationEndpoint</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;authorizationEndpoint</pre>
<div class="block">Required. The URL for the OAuth2 provider to provide authentication.
This must be a https endpoint.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>URL for the OAuth2 provider.</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="tokenEndpoint--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>tokenEndpoint</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;tokenEndpoint</pre>
<div class="block">Required. The URL for the OAuth2 provider to give the authorization token</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>URL for the OAuth2 provider.</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="userinfoEndpoint--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>userinfoEndpoint</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;userinfoEndpoint</pre>
<div class="block">Required. An OAuth 2.0 Protected Resource that returns Claims about the
authenticated End-User.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>URL for User Info.</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="endSessionEndpoint--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>endSessionEndpoint</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;endSessionEndpoint</pre>
<div class="block">Optional. OP endpoint to notify that the End-User has logged out of the
site and might want to log out of the OP as well.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>URL for logging out of server session.</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="jwksURI--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>jwksURI</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;jwksURI</pre>
<div class="block">Required. An OpenId Connect Provider's JSON Web Key Set document
<p>
This contains the signing key(s) the RP uses to validate signatures from
the OP. The JWK Set may also contain the Server's encryption key(s),
which are used by RPs to encrypt requests to the Server.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>URL pointing to the JWK Set.</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="issuer--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>issuer</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;issuer</pre>
<div class="block">Required. The issuer of the tokens issued by the Provider.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="subjectTypeSupported--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>subjectTypeSupported</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;subjectTypeSupported</pre>
<div class="block">Required. The supported subject Types by the Provider.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
<dl>
<dt>Default:</dt>
<dd>"public"</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="idTokenSigningAlgorithmsSupported--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>idTokenSigningAlgorithmsSupported</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;idTokenSigningAlgorithmsSupported</pre>
<div class="block">Required. The supported Signing algorithms for the ID token by provider.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
<dl>
<dt>Default:</dt>
<dd>"RS256"</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="responseTypeSupported--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>responseTypeSupported</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;responseTypeSupported</pre>
<div class="block">Required. The supported response types by the Provider.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
<dl>
<dt>Default:</dt>
<dd>"code,id_token,token id_token"</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../jakarta/security/enterprise/authentication/mechanism/http/openid/OpenIdConstant.html" title="interface in jakarta.security.enterprise.authentication.mechanism.http.openid"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../jakarta/security/enterprise/authentication/mechanism/http/openid/PromptType.html" title="enum in jakarta.security.enterprise.authentication.mechanism.http.openid"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?jakarta/security/enterprise/authentication/mechanism/http/openid/OpenIdProviderMetadata.html" target="_top">Frames</a></li>
<li><a href="OpenIdProviderMetadata.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Required&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.element.detail">Element</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>