componentExecute (Command) Mis à jour le 18 Dec 2024 2 Minutes à lire The content is currently unavailable in French. You are viewing the default English version.
Avez-vous trouvé ce résumé utile ?
Merci pour vos commentaires
The componentExecute command executes component–related administrative operations.
Table: Command Description COMPONENTCMD_CREATE Registers a new client component (see COMPONENTCMD_CREATE ). COMPONENTCMD_DELETE Deletes the specified client component (see COMPONENTCMD_DELETE ). COMPONENTCMD_UPDATE Updates the specified client component record (see COMPONENTCMD_UPDATE ). COMPONENTCMD_VIEW Retrieves the settings of the specified client component (see COMPONENTCMD_VIEW ).
Parameters Table: Parameter name Data type Description sessionID
String
Required . The session identifier of the current administrative session. The logon command returns this identifier after a successful logon (see logon (Command) ).
cmd
ComponentCmdIDEnum
Required . The operation to be executed. See Table: componentExecute commands (SOAP administration) .
attributeSet
ComponentAttributeSet
Required . A set containing zero or more attribute fields.
Table: Parameter name Data type Description results
ComponentResults
Required . Result structure containing return and status codes and a list of zero or more result attribute fields.
The following field attributes are available for the operations of this command:
Table: Attribute name Data type Description COMPONENTFLD_CHARACTER_ENCODING String The encoding/locale format required by the RADIUS server. COMPONENTFLD_COMPONENT_LOCATION String The IP address (or range, CIDR notation) of the machine represented by the component record (IPv4).
Up to 255 characters.
COMPONENTFLD_COMPONENT_TYPE String The type of client component represented by the data record.
Up to 60 characters.
COMPONENTFLD_CREATE_TIME DateTime The date and time the data record was created.
COMPONENTFLD_DESCRIPTION String A custom description for the client component
Up to 128 characters.
COMPONENTFLD_ENABLED Boolean Indicates whether the client component is enabled and allowed to communicate with OneSpan Authentication Server. COMPONENTFLD_LICENSE_KEY String Up to 1024 characters. COMPONENTFLD_MODIFY_TIME DateTime The date and time the data record was last modified.
COMPONENTFLD_POLICY_ID String The name of the policy that should be used for requests from the client component.
Up to 60 characters.
COMPONENTFLD_PROTOCOL_ID String The protocol used for requests from the client component.
Up to 32 characters.
COMPONENTFLD_RADIUS_SHARED_SECRET String The shared secret between OneSpan Authentication Server and the RADIUS client.
Up to 255 characters.
COMPONENTFLD_REQUEST_FORWARDING Boolean Indicates whether the client is considered to be trusted to forward SOAP requests from other clients. COMPONENTFLD_TCP_PORT Integer Possible values: 1 –65535 COMPONENTFLD_VASCO_PUBLIC_KEY String Up to 1024 characters.
COMPONENTCMD_CREATE registers a new client component.
Parameters The following attributes can be specified in the attributeSet input parameter of this command:
Table: Attribute name Optionality COMPONENTFLD_CHARACTER_ENCODING Optional COMPONENTFLD_COMPONENT_LOCATION Mandatory COMPONENTFLD_COMPONENT_TYPE Mandatory COMPONENTFLD_DESCRIPTION Optional COMPONENTFLD_ENABLED Optional COMPONENTFLD_LICENSE_KEY Optional COMPONENTFLD_POLICY_ID Mandatory COMPONENTFLD_PROTOCOL_ID Optional COMPONENTFLD_RADIUS_SHARED_SECRET Optional COMPONENTFLD_REQUEST_FORWARDING Optional COMPONENTFLD_TCP_PORT Optional COMPONENTFLD_VASCO_PUBLIC_KEY Optional
The following attributes will be specified in the results output parameter of this command:
Table: Attribute name Returned COMPONENTFLD_CHARACTER_ENCODING If defined COMPONENTFLD_COMPONENT_LOCATION Always COMPONENTFLD_COMPONENT_TYPE Always COMPONENTFLD_CREATE_TIME Always COMPONENTFLD_DESCRIPTION If defined COMPONENTFLD_ENABLED Optional COMPONENTFLD_LICENSE_KEY If defined COMPONENTFLD_MODIFY_TIME Always COMPONENTFLD_POLICY_ID Always COMPONENTFLD_PROTOCOL_ID If defined COMPONENTFLD_RADIUS_SHARED_SECRET If defined COMPONENTFLD_REQUEST_FORWARDING Optional COMPONENTFLD_TCP_PORT If defined COMPONENTFLD_VASCO_PUBLIC_KEY If defined
Requirements Required administrative privileges:
COMPONENTCMD_DELETE deletes the specified client component.
Parameters The following attributes can be specified in the attributeSet input parameter of this command:
Table: Attribute name Optionality COMPONENTFLD_COMPONENT_LOCATION Mandatory COMPONENTFLD_COMPONENT_TYPE Mandatory
This command returns no result attributes.
Requirements Required administrative privileges:
COMPONENTCMD_UPDATE updates the specified client component record.
Parameters The following attributes can be specified in the attributeSet input parameter of this command:
Table: Attribute name Optionality COMPONENTFLD_CHARACTER_ENCODING Optional COMPONENTFLD_COMPONENT_LOCATION Mandatory COMPONENTFLD_COMPONENT_TYPE Mandatory COMPONENTFLD_DESCRIPTION Optional COMPONENTFLD_ENABLED Optional COMPONENTFLD_LICENSE_KEY Optional COMPONENTFLD_POLICY_ID Optional COMPONENTFLD_PROTOCOL_ID Optional COMPONENTFLD_RADIUS_SHARED_SECRET Optional COMPONENTFLD_REQUEST_FORWARDING Optional COMPONENTFLD_TCP_PORT Optional COMPONENTFLD_VASCO_PUBLIC_KEY Optional
The following attributes will be specified in the results output parameter of this command:
Table: Attribute name Returned COMPONENTFLD_CHARACTER_ENCODING If defined COMPONENTFLD_COMPONENT_LOCATION Always COMPONENTFLD_COMPONENT_TYPE Always COMPONENTFLD_CREATE_TIME Always COMPONENTFLD_DESCRIPTION If defined COMPONENTFLD_ENABLED Always COMPONENTFLD_LICENSE_KEY If defined COMPONENTFLD_MODIFY_TIME Always COMPONENTFLD_POLICY_ID If defined COMPONENTFLD_PROTOCOL_ID If defined COMPONENTFLD_RADIUS_SHARED_SECRET If defined COMPONENTFLD_REQUEST_FORWARDING Always COMPONENTFLD_TCP_PORT If defined COMPONENTFLD_VASCO_PUBLIC_KEY If defined
Requirements Required administrative privileges:
COMPONENTCMD_VIEW retrieves the settings of the specified client component.
Parameters The following attributes can be specified in the attributeSet input parameter of this command:
Table: Attribute name Optionality COMPONENTFLD_COMPONENT_LOCATION Mandatory COMPONENTFLD_COMPONENT_TYPE Mandatory COMPONENTFLD_DESCRIPTION Optional
The following attributes will be specified in the results output parameter of this command:
Table: Attribute name Returned COMPONENTFLD_CHARACTER_ENCODING If defined COMPONENTFLD_COMPONENT_LOCATION Always COMPONENTFLD_COMPONENT_TYPE Always COMPONENTFLD_CREATE_TIME Always COMPONENTFLD_DESCRIPTION If defined COMPONENTFLD_ENABLED Always COMPONENTFLD_LICENSE_KEY If defined COMPONENTFLD_MODIFY_TIME Always COMPONENTFLD_POLICY_ID Always COMPONENTFLD_PROTOCOL_ID If defined COMPONENTFLD_RADIUS_SHARED_SECRET If defined COMPONENTFLD_REQUEST_FORWARDING Always COMPONENTFLD_TCP_PORT If defined COMPONENTFLD_VASCO_PUBLIC_KEY If defined
Requirements Required administrative privileges:
Cet article vous a-t-il été utile ?
Merci pour vos commentaires! Notre équipe vous répondra
