PCAuthorizationAPIParams

 

<p><span style="color:gray;">Version 1.5 - Updated on 10/20/2016</span></p>

 

<p>Superclass: <a href="../PCAPIParams/"><code>PCAPIParams</code></a><br>

Declared In: <code>PCAuthorizationAPIParams.h</code></p>

 

<h2>Contents</h2>

<nav id="TableOfContents">

<ul>

<li><a href="#pcauthorizationapiparams">PCAuthorizationAPIParams</a>

<ul>

<li><a href="#introduction">Introduction</a></li>

<li><a href="#properties">Properties</a>

<ul>

<li><a href="#clientid"><code>clientID</code></a></li>

<li><a href="#deviceid"><code>deviceID</code></a></li>

<li><a href="#redirecturl"><code>redirectURL</code></a></li>

<li><a href="#redirecturlstring"><code>redirectURLString</code></a></li>

<li><a href="#responsetype"><code>responseType</code></a></li>

<li><a href="#state"><code>state</code></a></li>

</ul></li>

</ul></li>

</ul>

</nav>

 

<h2 id="introduction">Introduction</h2>

 

<p><code>PCAuthorizationAPIParams</code> stores parameters required to authorize a client.</p>

 

<h2 id="properties">Properties</h2>

 

<h3 id="clientid"><code>clientID</code></h3>

 

<pre><code class="language-objectivec">@property (nonatomic,

copy) NSString *clientID;

</code></pre>

 

<ul>

<li><strong>Discussion</strong><br>

OAuth 2.0 client identifier (key). Required.</li>

</ul>

 

<h3 id="deviceid"><code>deviceID</code></h3>

 

<pre><code class="language-objectivec">@property (nonatomic,

copy) NSString *deviceID;

</code></pre>

 

<ul>

<li><strong>Discussion</strong>

An identifier of the device to be authorized.</li>

</ul>

 

<h3 id="redirecturl"><code>redirectURL</code></h3>

 

<pre><code class="language-objectivec">@property (nonatomic,

readonly) NSURL *redirectURL;

</code></pre>

 

<ul>

<li><strong>Discussion</strong><br>

Callback URL used to return app’s access token for a specified user. Required.</li>

</ul>

 

<h3 id="redirecturlstring"><code>redirectURLString</code></h3>

 

<pre><code class="language-objectivec">@property (nonatomic,

copy) NSString *redirectURLString;

</code></pre>

 

<ul>

<li><strong>Discussion</strong><br>

Callback URI invoked after successful or unsuccessful user authorization. A ‘code’ query string is appended if authentication is successful and an ‘error’ query string if it is not successful. Required.</li>

</ul>

 

<h3 id="responsetype"><code>responseType</code></h3>

 

<pre><code class="language-objectivec">@property (nonatomic,

copy) NSString *responseType;

</code></pre>

 

<ul>

<li><strong>Discussion</strong><br>

OAuth 2.0 response type. Must be ‘code’. Required.</li>

</ul>

 

<h3 id="state"><code>state</code></h3>

 

<pre><code class="language-objectivec">@property (nonatomic,

copy) NSString *state;

</code></pre>

 

<ul>

<li><strong>Discussion</strong><br>

This parameter is preserved in the authorization flow and returned to the client as a query string parameter in the ‘redirect_uri’. The client may validate this in order to protect against a Cross Site Request Forgery (XSRF) attempt.</li>

</ul>

 

<p>Copyright © 2015-2017, Verizon and/or its Licensors. All rights reserved.</p>