| INT SetBearerToken( |
| |
LPTSTR lpszBearerToken |
|
| ); |
The SetBearerToken method sets the OAuth 2.0 bearer
token used to authenticate the client session with a web service.
Parameters
- lpszBearerToken
- A pointer to a null terminated string buffer which contains
the bearer token used to authorize client requests. If this parameter
is NULL or a zero length string, the current bearer token will be
cleared and no client authentication will be performed.
Return Value
If the method succeeds, the return value is zero. If the method
fails, the return value is HTTP_ERROR. To get extended error
information, call GetLastError.
Remarks
Using OAuth 2.0 requires you to understand the process
of how to request the bearer (access) token. Obtaining a bearer token
requires registering your application with the web service provider,
getting a unique client ID associated with your application and
then requesting the token using the appropriate scope for
the service. Obtaining the initial token will typically involve
interactive confirmation on the part of the user, requiring they
grant permission to your application to access the service.
Your application should not store a bearer token for later
use. They have a relatively short lifespan, typically about an hour, and
are designed to be used with that session. You should specify offline
access as part of the OAuth 2.0 scope if necessary and store the refresh
token provided by the service. The refresh token has a much longer
validity period and can be used to obtain a new bearer token when needed.
Requirements
Minimum Desktop Platform: Windows 7 (Service Pack 1)
Minimum Server Platform: Windows Server 2008 R2 (Service Pack 1)
Header File: cstools11.h
Import Library: cshtpv11.lib
Unicode: Implemented as Unicode and ANSI versions
See Also
Authenticate,
GetBearerToken,
SetHeader
|