Previous Topic: Sm_AgentApi_UserCredentials_t

Next Topic: Function Return Codes

Function Declarations

The following table summarizes the C language functions that are used in the Agent API. The functions appear alphabetically.

Function

Description

Sm_AgentApi_Audit()

Audits a transaction.

Sm_AgentApi_Authorize()

Determines if a user has access to a resource.

Sm_AgentApi_ChangePassword()

Changes a user's password.

Sm_AgentApi_CreateSSOToken()

Produces an encrypted single sign-on token that can be shared between standard SiteMinder Web Agents and custom agents.

Sm_AgentApi_DecodeSSOToken()

Decodes a single sign-on token.

Sm_AgentApi_DelSessionVariables()

Deletes the specified session variables from the session store.

Sm_AgentApi_DoManagement()

Requests agent commands.

Sm_AgentApi_FreeAttributes()

Frees the buffer of response attributes.

Sm_AgentApi_FreeServers()

Frees an array of server structures after an Sm_AgentApi_GetConfig() call.

Sm_AgentApi_GetAgentApiUpdateVersion()

Retrieves the current API update version.

Sm_AgentApi_GetAllowedTunnelBufSize()

Retrieves the maximum data buffer size that can be transferred in a call to Sm_AgentApi_Tunnel().

Sm_AgentApi_GetConfig()

Retrieves agent configuration settings as defined either in the Registry (for Microsoft Windows only) or in an agent configuration file.

Sm_AgentApi_GetSessionVariables()

Retrieves the values of existing session variables.

Sm_AgentApi_Init()

Initializes the Agent API to set up connections to the Policy Servers.

Sm_AgentApi_IsProtected()

Determines if a resource is protected.

Sm_AgentApi_Login()

Performs session login and validation.

Sm_AgentApi_Logout()

Logs a user out of a session.

Sm_AgentApi_MakeCertificateHash()

Generates a hash of a certificate.

Sm_AgentApi_SetDefaultAgentId()

Sets the name of a custom agent that is configured through Central Host Configuration.

Sm_AgentApi_SetSessionVariables()

Creates new session variables or updates existing session variables.

Sm_AgentApi_Tunnel()

Transfers data between a remote service on the Policy Server side and your agent.

Sm_AgentApi_UnInit()

Uninitializes the Agent API.

Sm_AgentApi_UpdateAttributes()

Updates response attributes.

More Information:

Agent Call Sequence


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