| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>StandardOauth2AccessTokenProvider</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">StandardOauth2AccessTokenProvider</h1><h2>Description: </h2><p>Provides OAuth 2.0 access tokens that can be used as Bearer authorization header in HTTP requests. Uses Resource Owner Password Credentials Grant.</p><h3>Tags: </h3><p>oauth2, provider, authorization, access token, http</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Display Name</th><th>API Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Authorization Server URL</strong></td><td>authorization-server-url</td><td></td><td id="allowable-values"></td><td id="description">The URL of the authorization server that issues access tokens.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Grant Type</strong></td><td>grant-type</td><td id="default-value">User Password</td><td id="allowable-values"><ul><li>User Password <img src="../../../../../html/images/iconInfo.png" alt="Resource Owner Password Credentials Grant. Used to access resources available to users. Requires username and password and usually Client ID and Client Secret" title="Resource Owner Password Credentials Grant. Used to access resources available to users. Requires username and password and usually Client ID and Client Secret"></img></li><li>Client Credentials <img src="../../../../../html/images/iconInfo.png" alt="Client Credentials Grant. Used to access resources available to clients. Requires Client ID and Client Secret" title="Client Credentials Grant. Used to access resources available to clients. Requires Client ID and Client Secret"></img></li></ul></td><td id="description">The OAuth2 Grant Type to be used when acquiring an access token.</td></tr><tr><td id="name"><strong>Username</strong></td><td>service-user-name</td><td></td><td id="allowable-values"></td><td id="description">Username on the service that is being accessed.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong><br/><br/><strong>This Property is only considered if </strong><strong>the [Grant Type] Property has a value of "User Password".</strong></td></tr><tr><td id="name"><strong>Password</strong></td><td>service-password</td><td></td><td id="allowable-values"></td><td id="description">Password for the username on the service that is being accessed.<br/><strong>Sensitive Property: true</strong><br/><br/><strong>This Property is only considered if </strong><strong>the [Grant Type] Property has a value of "User Password".</strong></td></tr><tr><td id="name">Client ID</td><td>client-id</td><td></td><td id="allowable-values"></td><td id="description">No Description Provided.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Client secret</strong></td><td>client-secret</td><td></td><td id="allowable-values"></td><td id="description">No Description Provided.<br/><strong>Sensitive Property: true</strong><br/><br/><strong>This Property is only considered if </strong><strong>the [Client ID] Property has a value specified.</strong></td></tr><tr><td id="name">Scope</td><td>scope</td><td></td><td id="allowable-values"></td><td id="description">Space-delimited, case-sensitive list of scopes of the access request (as per the OAuth 2.0 specification)</td></tr><tr><td id="name"><strong>Refresh Window</strong></td><td>refresh-window</td><td id="default-value">0 s</td><td id="allowable-values"></td><td id="description">The service will attempt to refresh tokens expiring within the refresh window, subtracting the configured duration from the token expiration.</td></tr><tr><td id="name">SSL Context Service</td><td>ssl-context-service</td><td></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>SSLContextService<br/><strong>Implementations: </strong><a href="../../../nifi-ssl-context-service-nar/1.19.1/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</a><br/><a href="../../../nifi-ssl-context-service-nar/1.19.1/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></td><td id="description">No Description Provided.</td></tr><tr><td id="name"><strong>HTTP Protocols</strong></td><td>HTTP Protocols</td><td id="default-value">h2 http/1.1</td><td id="allowable-values"><ul><li>http/1.1 <img src="../../../../../html/images/iconInfo.png" alt="HTTP/1.1" title="HTTP/1.1"></img></li><li>h2 http/1.1 <img src="../../../../../html/images/iconInfo.png" alt="HTTP/2 and HTTP/1.1 negotiated based on requested protocols" title="HTTP/2 and HTTP/1.1 negotiated based on requested protocols"></img></li><li>h2 <img src="../../../../../html/images/iconInfo.png" alt="HTTP/2" title="HTTP/2"></img></li></ul></td><td id="description">HTTP Protocols supported for Application Layer Protocol Negotiation with TLS<br/><br/><strong>This Property is only considered if </strong><strong>the [SSL Context Service] Property has a value specified.</strong></td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>System Resource Considerations:</h3>None specified.</body></html> |