GetSecurityToken Method

Gets the security token.

Syntax

ANSI (Cross Platform)
int GetSecurityToken();

Unicode (Windows)
INT GetSecurityToken();
- (void)getSecurityToken;
#define MID_SAML_GETSECURITYTOKEN 4

IPWORKSAUTH_EXTERNAL int IPWORKSAUTH_CALL IPWorksAuth_SAML_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

Remarks

This method communicates with FederationSTS and LocalSTS as applicable to obtain a security token. The SecurityTokenXML property will be populated with the retrieved token.

When AuthMode is set to 0 (camSharePointOnline) or 1 (camDynamicsCRM) the class will automatically populate various properties to known values to reduce the number of required settings. Typically only the following properties are required:

When AuthMode is set to 2 (camADFS) or 3 (camCustom) the following properties are required:

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Auth 2020 C++ Edition - Version 20.0 [Build 8155]