Sm_PolicyApi_AddGroup()

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

Sm_PolicyApi_AddGroup()

Adds a new group object to the Siteminder policy store. The attributes of the group are contained in the pStructGroup structure.

Note: Groups of global objects are not supported.

The pszDomainOid parameter is required by a rule group or response group. An agent group does not require a domain OID because it is not a domain-based object.

If the group object exists and the bUpdate flag is true, the item is updated.

Type

Group function, global scope (agents) or domain scope (responses, rules).

Syntax

int SM_EXTERN Sm_PolicyApi_AddGroup (
   void*                    pSessionHandle,
   Sm_PolicyApi_Groups_t    dwGroup,
   const char*              pszDomainOid,
   Sm_PolicyApi_Group_t*    pStructGroup,
   const bool               bUpdate
);

Parameter	I/O	Description
pSession Handle	I	A pointer to an internal Policy Management API data structure. The structure holds information about the administrator session and the client session.
dwGroup	I	Indicates the type of group to be added.
pszDomainOid	I	A null-terminated string containing the name of an existing domain. Required parameter for rule or response group. (Global rule or response groups are not supported.)
pStructGroup	I	A pointer to a completely filled-in group structure.
bUpdate	I	A flag to indicate that if an existing object is found, it should be updated.

Returns

Sm_PolicyApi_Success. The add was successful.
Sm_PolicyApi_Failure. The add was not successful.
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 group.
Sm_PolicyApi_InvalidOid. The domain OID was not found (for a domain-based group).
Sm_PolicyApi_BadGroup. The dwGroup parameter is not the rule, response, or agent group type.

Email CA about this topic