Sm_AgentApi_Authorize()
Determines if a defined user is authorized by stmndr to perform a defined action on a defined resource and returns response attributes about the user with respect to the resource.
sm1252sp1
Determines if a defined user is authorized by
CA Single Sign-On
to perform a defined action on a defined resource and returns response attributes about the user with respect to the resource.Syntax
int SM_EXTERN Sm_AgentApi_Authorize (const void* pHandle,const char* lpszClientIpAddr,const char* lpszTransactionId,const Sm_AgentApi_ResourceContext_t* pResourceContext,const Sm_AgentApi_Realm_t* pRealm,Sm_AgentApi_Session_t* pSession,long* pNumAttributes,Sm_AgentApi_Attribute_t** ppAttributes);
Parameter | I/O | Description |
pHandle
| I | Agent API session handle returned in parameter ppHandle of Sm_AgentApi_Init(). |
lpszClientIpAddr
| I | The IP address of the client asking for the resource. This parameter is optional. If the client IP begins with a star (*), the Policy Server logs the IP address but does not validate it against a session specification. |
lpszTransactionId
| I | The ID that the agent uses to associate application activity with security activity. The Policy Server logs this ID. This is an optional parameter. |
pResourceContext
| I | A resource definition structure. |
pRealm
| I | A realm definition structure. |
pSession
| I | A session definition structure. |
pNumAttributes
| O | The number of returned attributes. |
ppAttributes
| O | A pointer to an array of response attribute definition structures. |
Return Values
- SM_AGENTAPI_YES. The user is authorized.
- SM_AGENTAPI_NO. The user is not authorized.
- SM_AGENTAPI_NOCONNECTION. The initialization was not done.
- SM_AGENTAPI_FAILURE. The server could not be reached.
- SM_AGENTAPI_TIMEOUT. The function timed out.
Example
See the sample smagentexample.cpp for an example of this function.