Programming Guides › Programming Guide for C › Policy Management API Guidance › Function Declarations for the Policy Management API › Sm_PolicyApi_GetUseSecureAuthPropFromAffiliate()

Sm_PolicyApi_GetUseSecureAuthPropFromAffiliate()

Retrieves the value of the UseSecureAuthURL property from a SAML 1.x affiliate.

Syntax

int SM_EXTERN Sm_PolicyApi_GetUseSecureAuthPropFromAffiliate(
   void*    pHandle,
   char*    pszAffiliateOID,
   bool     &bUseSecureAuthURL
                           
);

Parameters

pHandle

[in] A pointer to an internal Policy Management API data structure. The structure holds information about the administrator session and the client session.

pszAffiliateOid

[in] A pointer to the OID of an existing SMAL 1.x affiliate.

bUseSecureAuthURL

[in] A Boolean value that specifies whether to use a secure authentication URL for this affiliate.

Returns

• Sm_PolicyApi_Success. The action was completed successfully.
• Sm_PolicyApi_Failure. The action was unsuccessful.
• Sm_PolicyApi_NoSession. There was no valid initialization prior to this call.
• Sm_PolicyApi_NoPrivilege. The administrator did not have sufficient access privileges.