Programming Guides › Programming Guide for C › Agent API › Data Types and Structures › Sm_AgentApi_Realm_t

Sm_AgentApi_Realm_t

This structure defines Information about the realm in which a resource is protected.

Syntax

This structure has the following format:

typedef struct Sm_AgentApi_Realm_s
{
   char lpszDomainOid[SM_AGENTAPI_SIZE_OID];
   char lpszRealmOid[SM_AGENTAPI_SIZE_OID];
   char lpszRealmName[SM_AGENTAPI_SIZE_NAME];
   long nRealmCredentials;
   char lpszFormLocation[SM_AGENTAPI_SIZE_URL];
} Sm_AgentApi_Realm_t;

Parameters

This structure has the following parameters:

• lpszDomainOid

  Unique identifier for the domain.

• lpszRealmOid

  Unique identifier for the realm.

• lpszRealmName

  Name of the realm in which the resource is protected.

• nRealmCredentials

  A bit mask of values indicating the required credentials. The values are defined in the Sm_Api_Credentials_t enumerated type (as defined in SmApi.h). The value 0 means that no credentials are required. The types are as follows:

  • Sm_AuthApi_Cred_None
    No credential required.
  • Sm_AuthApi_Cred_Basic
    Username and password required.
  • Sm_AuthApi_Cred_Digest
    Digest required.
  • Sm_AuthApi_Cred_X509Cert
    X.509 certificate required.
  • Sm_AuthApi_Cred_X509CertUserDN
    X.509 certificate and user DN required.
  • Sm_AuthApi_Cred_X509CertIssuerDN
    X.509 certificate issuer DN required.
  • Sm_AuthApi_Cred_CertOrBasic
    Either an X.509 certificate or username/password is required.
  • Sm_AuthApi_Cred_CertOrForm
    Either an X.509 certificate or a forms-based authentication scheme is required.
  • Sm_AuthApi_Cred_NTChalResp
    Use the NT challenge/response protocol.
  • Sm_AuthApi_Cred_SSLRequired
    SSL required.
  • Sm_AuthApi_Cred_FormRequired
    A redirect to an HTML form is required.
  • Sm_AuthApi_Cred_AllowSaveCreds
    Save credentials hint.
  • Sm_AuthApi_Cred_PreserveSessionId
    Session id should be preserved if the current session is still valid.
  • Sm_AuthApi_Cred_DoNotChallenge
    Do not challenge for credentials.
• lpszFormLocation

  URL of the form credential provider (http://...).