Sm_PolicyApi_AddWSFEDScheme()

Creates a new or updates an existing stmndr WSFED authentication scheme (WSFED auth scheme) object. Validation of properties (values and dependencies on other properties) is performed.
casso127
Creates a new or updates an existing
CA Single Sign-On
WSFED authentication scheme (WSFED auth scheme) object. Validation of properties (values and dependencies on other properties) is performed.
Syntax
int SM_EXTERN Sm_PolicyApi_AddWSFEDScheme(
        void* 
pSessionHandle
,
        Sm_PolicyApi_Scheme_t* 
pstructScheme
,
        Sm_PolicyApi_WSFEDProviderProp_t* 
pProps
,
        const bool 
bUpdate
,
        char **
pszErrMsg
);
Parameters
  • pSessionHandle
    [in] A pointer to an internal Policy Management API data structure. The structure holds information about the administrator session and the client session.
  • pstructScheme
    [in] A pointer to a completely filled-in scheme structure.
  • pProps
    [in] A pointer to a linked list of WSFED provider properties.
  • bUpdate
    [in] A flag to indicate that if an existing object is found, it should be updated.
  • pszErrMsg
    [out] When a call to this function returns a value of Sm_PolicyApi_WSFED_UnknownProperty, Sm_PolicyApi_MissingProperty or Sm_PolicyApi_InvalidProp, this variable contains the name of the property which produced the error. You release the memory allocated for this variable by using a call to SmPolicyApi_FreeString().
Return Values
  • Sm_PolicyApi_Success. The WSFED auth scheme was created successfully.
  • Sm_PolicyApi_Failure. The WSFED auth scheme was not created successfully.
  • Sm_PolicyApi_InvalidHandle. There was no valid initialization prior to this call.
  • Sm_PolicyApi_NoSession. There is no valid administrator session.
  • Sm_PolicyApi_NoPrivilege. The administrator does not have the privilege to create a WSFED auth scheme.
  • Sm_PolicyApi_WSFEDAP_IncorrectParameters. Supplied WSFED Account Partner properties are incomplete or incorrect.
  • Sm_PolicyApi_WSFEDAP_ProviderIdNotUnique. Supplied WSFED Account Partner ID is not unique.
  • Sm_PolicyApi_WSFED_UnknownProperty. An unknown property name was provided.
  • Sm_PolicyApi_MissingProperty. A property which is required, potentially due to a dependency, was not provided.
  • Sm_PolicyApi_InvalidProp. The value for a provided property is invalid.