Previous Topic: Sm_PolicyApi_AddSAMLAffiliation()Next Topic: Sm_PolicyApi_AddSAMLServiceProvider()

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

Sm_PolicyApi_AddSAMLScheme()

Adds a new SAML 2.0 authentication scheme object or modifies an existing one. This function also defines metadata properties for the associated Identity Provider. The metadata properties are stored with the authentication scheme.

Type

SAML 2.0 Configuration function, global scope.

Syntax

int SM_EXTERN Sm_PolicyApi_AddSAMLScheme

(
   void*                                     pHandle,
   Sm_PolicyApi_Scheme_t*                    pstructScheme,
   Sm_PolicyApi_SAMLProviderProp_t*          pProps,
   const bool                                bUpdate,
   char**                                    pszErrMsg
);

Parameter

I/O

Description

pHandle

I

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

pstructScheme

I

A pointer to a completed scheme structure.

pProps

I

SAML 2.0 metadata properties associated with the authentication scheme.

If you do not assign a value to a property associated with a default value, the default will be assigned.

bUpdate

I

Specifies whether an update operation should be performed on an existing object.

pszErrMsg

O

String containing an error message if the authentication scheme is not added or updated successfully.

The Policy Management API allocates memory for this parameter dynamically. It is the responsibility of the custom application to free it using a call to Sm_PolicyApi_FreeString()..

If Sm_PolicyApi_MissingProperty or Sm_PolicyApi_InvalidProp are returned, this field contains the name of the property that is missing or invalid.

Returns