IUpdateEndpointAuthProvider::GetEndpointToken method

Request a token for the endpoint of the service using the specified credentials.

Syntax

HRESULT GetEndpointToken(
  [in]  GUID                        serviceId,
  [in]  UpdateEndpointType          endpointType,
  [in]  UpdateEndpointProxySettings proxySettings,
  [in]  HANDLE_PTR                  hUserToken,
  [in]  UpdateEndpointAuthTokenType tokenType,
  [in]  BOOL                        fRefreshOnline,
  [out] IUnknown                    **ppEndpointToken
);

Parameters

serviceId [in]

Identifies the service to be updated.

endpointType [in]

Identifies the type of endpoint that is implemented by the service.

proxySettings [in]

The settings to be used when connecting to a proxy server. See the UpdateEndpointProxySettings structure for more details.

hUserToken [in]

tokenType [in]

Identifies the type of authentication token that is used for authentication.

fRefreshOnline [in]

Indicates weather WUA requests a new token. True indicates that a new token is requested. False indicates that a new or cached token is requested. See Remarks for more information.

ppEndpointToken [out]

Specify the endpoint token to be used.

Return value

Returns S_OK if successful. Otherwise, returns a COM or Windows error code.

Remarks

WUA typically sets the fRefreshOnline parameter to false when this method is first called, then if a connection error occurs WUA sets that parameter to true when the method is called again. However, the implementation of this method can request a new token from a Security Token Service (STS) or provide a cached token at any time.

Requirements

See also

IUpdateEndpointAuthProvider