CLI Policy Management Response Methods
This content describes the CLI response methods.
casso127
This content describes the CLI response methods.
CreateAttribute Method Creates a Static Response Attribute for the Response
The CreateAttribute method creates a Static response attribute for the response.
Syntax
The CreateAttribute method has the following format:
Netegrity::PolicyMgtResponse->CreateAttribute(attrName, varValue [, TTL])
Parameters
The CreateAttribute method accepts the following parameters:
- attrName(string)Specifies the name of the attribute to create. Valid attribute names vary with the type of agent associated with the response.Agent type is specified in theCA Single Sign-OnResponse Dialog, which is displayed when you create a response. To see the list of attributes associated with a given agent type, select the agent type in theCA Single Sign-OnResponse Dialog, click Create, then view the choices in the Attribute field of theCA Single Sign-OnResponse Attribute Editor.For example, if you are creating a response with aCA Single Sign-OnWeb Agent type, you can create any of the following response attributes:
- WebAgent-HTTP-Header-Variable
- WebAgent-HTTP-Cookie-Variable
- WebAgent-OnAccept-Redirect
- WebAgent-OnAccept-Text
- WebAgent-OnAuthAccept-Session-Idle-Timeout
- WebAgent-OnAuthAccept-Session-Max-Timeout
- WebAgent-OnReject-Redirect
- WebAgent-OnReject-Text
- varValue(string)Specifies the value of the static attribute. This value appears in the Value column of theCA Single Sign-OnResponse Dialog. The value represents either a variable or cookie value or a name/value pair. If you need to specify a name as well as a value, use the form name=value. For example, the attribute WebAgent-HTTP-Header-Variable requires a name/value pair. If the name is show_content and the value is yes, you would assign show_content=yes to varValue.
- TTL(int)(Optional) Specifies the amount of time in seconds that can elapse before the value of the response attribute is recalculated.
Return Value
The CreateAttribute method returns one of the following values:
- A PolicyMgtResponseAttr object
- undefif the call is unsuccessful
Remarks
You cannot create response attributes of type User Attribute or DN Attribute with the Command Line Interface.
See also the descriptions of the PolicyMgtResponse>CreateActiveAttribute method and the PolicyMgtResponse>CreateVariableAttribute method.
DeleteAttribute Method Deletes a Response Attribute in the Response
The DeleteAttribute method deletes a response attribute in the response.
Syntax
The DeleteAttribute method has the following format:
Netegrity::PolicyMgtResponse->DeleteAttribute(respAttr)
Parameters
The DeleteAttribute method accepts the following parameter:
- respAttr(PolicyMgtResponseAttr)Specifies the response attribute to delete.
Return Value
The DeleteAttribute method returns one of the following values:
- 0 on success
- -1 if the call is unsuccessful
Description Method Sets or Retrieves the Response Description
The Description method sets or retrieves the response description.
Syntax
The Description method has the following format:
Netegrity::PolicyMgtResponse->Description([resDesc])
Parameters
The Description method accepts the following parameter:
- resDesc(string)(Optional) Specifies the response description.
Return Value
The Description method returns one of the following values:
- The new or existing response description
- An empty string if the call is unsuccessful
GetAllAttributes Method Retrieves a List of Configured Response Attributes
The GetAllAttributes method retrieves a list of configured response attributes.
Syntax
The GetAllAttributes method has the following format:
Netegrity::PolicyMgtResponse->GetAllAttributes() (returnCode)
Parameters
The GetAllAttributes method accepts the following parameters:
- returnCode(int)Output variable that is populated on return of the function call. The value populated is 0 if the call is a success. If the call fails, the value populated is a negative number that corresponds with the Policy Management API error code.
Return Value
The GetAllAttributes method returns the following value:
- An array of PolicyMgtResponseAttr objects
Name Method Sets or Retrieves the Response Name
The Name method sets or retrieves the response name.
Syntax
The Name method has the following format:
Netegrity::PolicyMgtResponse->Name([resName])
Parameters
The Name method accepts the following parameter:
- resName(string)(Optional) Specifies the response name.
Return Value
The Name method returns one of the following values:
- A new or existing response name
- undefif the call is unsuccessful