Sm_PolicyApi_AddUsersToSAMLServiceProvider()

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

Sm_PolicyApi_AddUsersToSAMLServiceProvider()

Associates a user directory entry with SAML 2.0 Service Provider.

Type

SAML 2.0 Configuration function, domain scope.

Syntax

int SM_EXTERN Sm_PolicyApi_AddUsersToSAMLServiceProvider

(
   void*                          pSessionHandle,
   const char*                    pszProviderOid,
   Sm_PolicyApi_User_t*           pStructUsers,
   int                            iPolicyFlags
);

Parameter	I/O	Description
pSessionHandle	I	A pointer to an internal Policy Management API data structure. The structure holds information about the administrator session and the client session.
pszProviderOid	I	A null-terminated string containing the object identifier of an existing SAML Service Provider.
pStructUsers	I	Pointer to a Sm_PolicyApi_User_t structure containing information about the user directory.
iPolicyFlags	I	A bit field that indicates whether: The policy created for the SAML Service Provider includes a user The policy should be applied recursively

Returns

Sm_PolicyApi_Success. The user was added successfully.
Sm_PolicyApi_Failure. The user was not added 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 add a user.
Sm_PolicyApi_InvalidOid. The Service Provider OID was not found.
Sm_PolicyApi_DuplicateEntry. The user is already part of the Service Provider.