- 10 Dec 2024
- 1 Minute à lire
- SombreLumière
- PDF
SOAP Administration Wrappers
- Mis à jour le 10 Dec 2024
- 1 Minute à lire
- SombreLumière
- PDF
The SOAP administration wrapper maps all commands defined in the OneSpan Authentication Server administration WSDL file in a class called AdministrationBean.
The administration commands return an AdministrationCommandResponse object that wraps the server’s response. For a list of different methods defined by this class, see Overview of SOAP wrappers.
Object model
In order to comply with the object-oriented aspect of the used programming language, the OneSpan Authentication Server Administration entity is wrapped by an object model. This object is essentially a container for the entities’ properties, since it has no logic.
These properties can be accessed using a specialized getter, e.g. getUserID(). To set these properties, use a specialized setter, e.g. setUserID(String userID).
For more information, see SOAP handler.
Handler | Response | Model |
---|---|---|
AdministrationHandler | AdministrationCommandResponse | Credentials |
DigipassHandler | DigipassCommandResponse | Digipass |
DigipassQueryResponse | List<Digipass> | |
DigipassApplicationHandler | DigipassApplicationCommandResponse | DigipassApplication |
ReportHandler | ReportCommandResponse | Report |
ReportQueryResponse | List<Report> | |
ReportFormatHandler | ProvisioningCommandResponse | ReportFormat |
UserHandler | UserCommandResponse | User |
UserQueryResponse | List<User> | |
PendingOperationHandler | PendingOperationCommandResponse | PendingOperation |
PendingOperationQueryResponse | List<PendingOperation> |
Query commands
The user, authenticator, reports, and pending operation handlers provide a search command (query). Query commands require a list of fields or business objects. These fields/objects will be used in the search. When successful, queries return a list of matching business objects with relevant fields set.
Search fields are interpreted as follows:
- Wildcards are always accepted, except for user and authenticator searches where the UserID or toSerialNumber parameters are used.
- A wildcard character (*) can be added to the values at the start, the end, or both. They will be interpreted as the SQL LIKE statement.
A list of comma-separated values can be specified for the attribute that specifies the domain name. In this case it will be interpreted as the logical OR of the given values.
You cannot use wildcard characters in comma-separated values.
- If none of the above applies, the search will be done using the exact match of the given value.
The search results are a list of respective objects (see Object model).