PCAuthorizationAPIParams

Version 1.3 - Updated on 8/11/2016

Superclass: PCAPIParams
Declared In: PCAuthorizationAPIParams.h

Contents

Introduction

PCAuthorizationAPIParams stores parameters required to authorize a client.

Properties

clientID

@property (nonatomic,
    copy) NSString *clientID; 
  • Discussion
    OAuth 2.0 client identifier (key). Required.

deviceID

@property (nonatomic,
    copy) NSString *deviceID;
  • Discussion An identifier of the device to be authorized.

redirectURL

@property (nonatomic,
    readonly) NSURL *redirectURL;
  • Discussion
    Callback URL used to return app’s access token for a specified user. Required.

redirectURLString

@property (nonatomic,
    copy) NSString *redirectURLString; 
  • Discussion
    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.

responseType

@property (nonatomic,
    copy) NSString *responseType; 
  • Discussion
    OAuth 2.0 response type. Must be ‘code’. Required.

state

@property (nonatomic,
    copy) NSString *state; 
  • Discussion
    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.

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