AuthorizationScope Property

The scope request or response parameter used during authorization.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
char* GetAuthorizationScope();
int SetAuthorizationScope(const char* lpszAuthorizationScope);

Unicode (Windows)
LPWSTR GetAuthorizationScope();
INT SetAuthorizationScope(LPCWSTR lpszAuthorizationScope);

@property (nonatomic,readwrite,assign,getter=authorizationScope,setter=setAuthorizationScope:) NSString* authorizationScope;
- (NSString*)authorizationScope;
- (void)setAuthorizationScope:(NSString*)newAuthorizationScope;

#define PID_OAUTH_AUTHORIZATIONSCOPE 3

IPWORKS_EXTERNAL void* IPWORKS_CALL IPWorks_OAuth_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
IPWORKS_EXTERNAL int IPWORKS_CALL IPWorks_OAuth_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);

Default Value

""

Remarks

If the scope is not set, the authorization server will use the default access scope for your application as determined by the server. To request a specific access scope set this property to a space separated list of strings as defined by the authorization server.

After calling GetAuthorization this property will be updated with the scope sent in the response from the server and will indicate the scope that was actually granted.

Data Type

String