Previous Topic: Sm_PolicyApi_PolicyLink_t

Next Topic: Sm_PolicyApi_RegistrationScheme_t

Sm_PolicyApi_Realm_t

Sm_PolicyApi_Realm_t type defines a SiteMinder Realm object.

Syntax

typedef struct Sm_PolicyApi_Realm_s
{
   int iStructId;
   char pszOid[BFSIZE];
   char pszName[BFSIZE];                     /* Required */
   char pszDesc[BFSIZE];
   char pszResourceFilter[BFSIZE];
   char pszAgentOid[BFSIZE];                 /* Required */
   char pszSchemeOid[BFSIZE];                /* Required */
   char pszParentRealmOid[BFSIZE];           /* Required */
   char pszDomainOid[BFSIZE];                /* Required */
   char pszAzUserDirOid[BFSIZE];             /* Required */
   char pszRegSchemeOid[BFSIZE];             /* Required */
   bool bProcessAuthEvents;                  /* Required */
   bool bProcessAzEvents;                    /* Required */
   bool bProtectAll;                         /* Required */
   int nMaxTimeout;                          /* Required */
   int nIdleTimeout;                         /* Required */
   bool bSyncAudit;                          /* Required */
   struct Sm_PolicyApi_Realm_s* next;
} Sm_PolicyApi_Realm_t;

Field

Description

iStructId

Realm data structure ID, defined in Sm_PolicyApi_Structs_t.

pszOid

The object identifier of the Realm object.

pszName

Name of the realm.

pszDesc

Brief description of the realm.

pszResourceFilter

Path for the resource filter.

pszAgentOid

Object identifier of the agent or agent group associated with the realm.

pszSchemeOid

Object identifier of the authentication scheme associated with the realm.

pszParentRealmOid

Object identifier of the parent realm under which this realm will be added. If the realm being added is the top realm in the realm hierarchy, set this field to the domain OID. Otherwise, set it to the parent realm OID.

pszDomainOid

Object identifier of the domain.

bProcessAuthEvents

Boolean to trigger this rule in an event of authentication attempts.

Authentication event processing affects performance. If no rules in the realm are triggered by authentication events, set this field to false.

bProcessAzEvents

Boolean to trigger this rule in an event of authorization attempts.

Authorization event processing affects performance. If no rules in the realm are triggered by authorization events, set this field to false.

bProtectAll

Boolean to protect all the resources contained in the new realm.

nMaxTimeout

Maximum amount of time a user can access the protected resources in the realm before they must re-authenticate.

nIdleTimeout

Amount of time a user can remain authenticated for the protected resources in the realm without interacting with the resources before they must re-authenticate.

bSyncAudit

Boolean to enable synchronous auditing. When enabled, users cannot access resources within a realm until their activity has been successfully recorded in the audit logs of both the Policy Server and the Web Agent.

pszAzUserDirOid

OID of the directory against which users accessing resources in this realm will be authorized.

pszRegSchemeOid

OID of the registration scheme that will be used to register new users accessing resources in this realm.

next

Pointer to the next realm structure.


Copyright © 2010 CA. All rights reserved. Email CA about this topic