AuthorizationScope Property

The authorization scope 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_OPENID_AUTHORIZATIONSCOPE 3

IPWORKSAUTH_EXTERNAL void* IPWORKSAUTH_CALL IPWorksAuth_OpenID_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
IPWORKSAUTH_EXTERNAL int IPWORKSAUTH_CALL IPWorksAuth_OpenID_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);

Default Value

"openid"

Remarks

This property specifies the authorization scopes sent in the authorization request. The value specified here must be a space separated list of scopes. For instance openid profile email.

The openid scope is always required to be present. The default value is openid.

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