policyQuery (Command)

Mis à jour le 18 Dec 2024
4 Minutes à lire

Partager
Sombre
Lumière
PDF

The content is currently unavailable in French. You are viewing the default English version.

Résumé de l’article

Avez-vous trouvé ce résumé utile ?

Merci pour vos commentaires

The policyQuery command allows to query policies that match specified search criteria.

Parameters

Table: policyQuery input parameters (SOAP administration)
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)).
attributeSet	PolicyAttributeSet	Required. A set containing zero or more attribute fields that specify the query search criteria. See PolicyAttributeSet (Data type). If you submit an empty attribute set, all records are returned.
fieldSet	PolicyFieldSet	Optional. Specifies the attribute fields to be returned for all the records matching the search criteria. See PolicyFieldSet (Data type). If fieldSet is omitted, all possible output parameters are returned. If a policy attribute field is not set in the database, it is not returned for that specific policy record.
queryOptions	PolicyQueryOptions	Optional. Options to determine what results should be returned. See PolicyQueryOptions (Data type).

Table: policyQuery output parameters (SOAP administration)
Parameter name	Data type	Description
results	PolicyQueryResults	Required.

PolicyAttributeSet (Data type)

The attributes specified in this attribute set define the search criteria.

Search attribute fields are interpreted as follows:

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.

Table: PolicyAttributeSet (Data type)
Element name	Data type	Description
attributes	PolicyAttribute	Attributes specifying the policy query search criteria (see Table: PolicyAttribute (Data type)).

Table: PolicyAttribute (Data type)
Element name	Data type	Description
attributeOptions	AttributeOptions	Specifies how to handle the attribute value during request processing, where each option is added as a single element to attributeOptions, e.g.: <negative>true</negative> Supported values: negative. Indicates that the specified user attribute value should not be equal to the one specified. null. Indicates that the specified attribute should be handled as zero-value.
value	Any	The attribute value. The data type has to be specified by setting the xsi:type XML attribute.
attributeID	PolicyAttributeIDEnum	The attribute identifier (see Table: policyQuery (Supported input attributes)).

Table: policyQuery (Supported input attributes)
Attribute name	Optionality
POLICYFLD_ACCEPTED_DOMAIN	Optional
POLICYFLD_ACT_MSG_VALIDITY	Optional
POLICYFLD_ACTIVATION_COMPLETED_NOTIFICATION	Optional
POLICYFLD_ACTIVATION_DELAYED_NOTIFICATION	Optional
POLICYFLD_ACTIVATION_NOTIFICATION_DELIVERY_METHOD	Optional
POLICYFLD_APPL_NAMES	Optional
POLICYFLD_APPL_TYPE	Optional
POLICYFLD_ASSIGN_MODE	Optional
POLICYFLD_ASSIGN_SEARCH_UP_OU_PATH	Optional
POLICYFLD_AUTHUSER_MAX_THREAD_SUSPEND	Optional
POLICYFLD_AUTOLEARN	Optional
POLICYFLD_AVOID_INITIAL_SYNC	Optional
POLICYFLD_BACKEND_AUTH	Optional
POLICYFLD_BACKEND_PROTOCOL_ID	Optional
POLICYFLD_BACKUP_VDP_ENABLED	Optional
POLICYFLD_BACKUP_VDP_MAX_DAYS	Optional
POLICYFLD_BACKUP_VDP_MAX_USES	Optional
POLICYFLD_BACKUP_VDP_REQUEST_KEYWORD	Optional
POLICYFLD_BACKUP_VDP_REQUEST_METHOD	Optional
POLICYFLD_CHALLENGE_REQUEST_KEYWORD	Optional
POLICYFLD_CHALLENGE_REQUEST_METHOD	Optional
POLICYFLD_CHECKCHALLENGE	Optional
POLICYFLD_CHG_WIN_PWD_ENABLED	Optional
POLICYFLD_CHG_WIN_PWD_LENGTH	Optional
POLICYFLD_CHKINACTDAYS	Optional
POLICYFLD_CLIENT_GROUP_LIST	Optional
POLICYFLD_CLIENT_GROUP_MODE	Optional
POLICYFLD_CREATE_TIME	Optional
POLICYFLD_CUSTOM_REQUEST_BODY	Optional
POLICYFLD_DCR	Optional
POLICYFLD_DEFAULT_DOMAIN	Optional
POLICYFLD_DELAYED_ACTIVATION_PERIOD	Optional
POLICYFLD_DESCRIPTION	Optional
POLICYFLD_DIGIPASS_TYPES	Optional
POLICYFLD_DP_EXPIRATION_PERIOD	Optional
POLICYFLD_DP_TYPE_LIMIT	Optional
POLICYFLD_DUR	Optional
POLICYFLD_EVENTWINDOW	Optional
POLICYFLD_GRACE_PERIOD	Optional
POLICYFLD_GROUP_CHECK_MODE	Optional
POLICYFLD_GROUP_LIST	Optional
POLICYFLD_ITHRESHOLD	Optional
POLICYFLD_ITIMEWINDOW	Optional
POLICYFLD_LOCAL_AUTH	Optional
POLICYFLD_LOCK_DURATION_MULTIPLIER	Optional
POLICYFLD_MAX_UNLOCK_TRIES	Optional
POLICYFLD_MIN_APP_VERSION	Optional
POLICYFLD_MIN_LOCK_DURATION	Optional
POLICYFLD_MODIFY_TIME	Optional
POLICYFLD_MULTI_DP_APPL_VALIDATION_MODE	Optional
POLICYFLD_OFFLINE_AUTH_ENABLED	Optional
POLICYFLD_OFFLINE_MAX_EVENTS	Optional
POLICYFLD_OFFLINE_TIME_INTERVAL	Optional
POLICYFLD_ONE_STEP_CHAL_CHECKDIGIT	Optional
POLICYFLD_ONE_STEP_CHAL_LENGTH	Optional
POLICYFLD_ONE_STEP_CHAL_RESP	Optional
POLICYFLD_ONLINESG	Optional
POLICYFLD_PARENT_POLICY_ID	Optional
POLICYFLD_PIN_CHANGE_ALLOWED	Optional
POLICYFLD_POLICY_ID	Optional
POLICYFLD_PRIMARY_VDP_REQUEST_KEYWORD	Optional
POLICYFLD_PRIMARY_VDP_REQUEST_METHOD	Optional
POLICYFLD_PRIVILEGED_USERS	Optional
POLICYFLD_RADIUS_ALLOWED_PROTOCOLS	Optional
POLICYFLD_RADIUS_REP_ATTR_ENABLED	Optional
POLICYFLD_RADIUS_REP_ATTR_GROUP_LIST	Optional
POLICYFLD_RADIUS_SESSION_LIFETIME	Optional
POLICYFLD_RADIUS_SESSION_TICKET_LIFETIME	Optional
POLICYFLD_RADIUS_SESSION_TICKET_REUSE	Optional
POLICYFLD_SECOND_OTP_SYNC_ENABLED	Optional
POLICYFLD_SECURE_CHAL_FONT_INDEX	Optional
POLICYFLD_SECURE_CHAL_REQ_PIN	Optional
POLICYFLD_SECURE_CHAL_TEMPLATE_NO	Optional
POLICYFLD_SECURE_CHANNEL	Optional
POLICYFLD_SECURE_SIGN_FONT_INDEX	Optional
POLICYFLD_SECURE_SIGN_REQ_PIN	Optional
POLICYFLD_SECURE_SIGN_SHOW_RESPONSE	Optional
POLICYFLD_SECURE_SIGN_SHOW_WARNING	Optional
POLICYFLD_SECURE_SIGN_TEMPLATE_NO	Optional
POLICYFLD_SELF_ASSIGN_SEPARATOR	Optional
POLICYFLD_STATIC_PWD_DIFF_TO_PREV	Optional
POLICYFLD_STATIC_PWD_EXPIRATION_NOTIFICATION	Optional
POLICYFLD_STATIC_PWD_MAX_AGE	Optional
POLICYFLD_STATIC_PWD_MIN_AGE	Optional
POLICYFLD_STATIC_PWD_MIN_LENGTH	Optional
POLICYFLD_STATIC_PWD_MIN_LOWER_ALPHA	Optional
POLICYFLD_STATIC_PWD_MIN_NUMBER	Optional
POLICYFLD_STATIC_PWD_MIN_SYMBOL	Optional
POLICYFLD_STATIC_PWD_MIN_UPPER_ALPHA	Optional
POLICYFLD_STATIC_PWD_NOT_USERID_BASED	Optional
POLICYFLD_STHRESHOLD	Optional
POLICYFLD_STIMEWINDOW	Optional
POLICYFLD_STORED_PASSWORD_PROXY	Optional
POLICYFLD_SYNCWINDOW	Optional
POLICYFLD_USE_GENERIC_AUTH_STATUS_CODES	Optional
POLICYFLD_USER_INACT_DAYS	Optional
POLICYFLD_USER_INFO_SYNC	Optional
POLICYFLD_USER_LOCK_THRESHOLD	Optional
POLICYFLD_VDP_DELIVERY_METHOD	Optional
POLICYFLD_VDP_MDC_PROFILE	Optional
POLICYFLD_VDP_SIGN_DELIVERY_METHOD	Optional
POLICYFLD_VDP_SIGN_ENABLED	Optional
POLICYFLD_VDP_SIGN_MDC_PROFILE	Optional

For more information about the specific attributes, refer to Table: policyExecute field attributes.

PolicyFieldSet (Data type)

The attributes specified in the fieldSet parameter specify the policy attribute fields that should be returned by OneSpan Authentication Server for the policy accounts matching the search criteria.

If fieldSet is omitted, all possible output parameters are returned. If an attribute field is not set in the database, it is not returned for that specific record.

Table: PolicyFieldSet (Data type)
Element name	Data type	Description
attributeID	PolicyAttributeIDEnum	The identifier of an attribute to return (see Table: policyQuery (Supported output attributes)).

Table: policyQuery (Supported output attributes)
Attribute name	Returned?
POLICYFLD_ACCEPTED_DOMAIN	If defined
POLICYFLD_ACT_MSG_VALIDITY	If defined
POLICYFLD_ACTIVATION_COMPLETED_NOTIFICATION	If defined
POLICYFLD_ACTIVATION_DELAYED_NOTIFICATION	If defined
POLICYFLD_ACTIVATION_NOTIFICATION_DELIVERY_METHOD	If defined
POLICYFLD_APPL_NAMES	If defined
POLICYFLD_APPL_TYPE	If defined
POLICYFLD_ASSIGN_MODE	If defined
POLICYFLD_ASSIGN_SEARCH_UP_OU_PATH	If defined
POLICYFLD_AUTHUSER_MAX_THREAD_SUSPEND	If defined
POLICYFLD_AUTOLEARN	If defined
POLICYFLD_AVOID_INITIAL_SYNC	If defined
POLICYFLD_BACKEND_AUTH	If defined
POLICYFLD_BACKEND_PROTOCOL_ID	If defined
POLICYFLD_BACKUP_VDP_ENABLED	If defined
POLICYFLD_BACKUP_VDP_MAX_DAYS	If defined
POLICYFLD_BACKUP_VDP_MAX_USES	If defined
POLICYFLD_BACKUP_VDP_REQUEST_KEYWORD	If defined
POLICYFLD_BACKUP_VDP_REQUEST_METHOD	If defined
POLICYFLD_CHALLENGE_REQUEST_KEYWORD	If defined
POLICYFLD_CHALLENGE_REQUEST_METHOD	If defined
POLICYFLD_CHECKCHALLENGE	If defined
POLICYFLD_CHG_WIN_PWD_ENABLED	If defined
POLICYFLD_CHG_WIN_PWD_LENGTH	If defined
POLICYFLD_CHKINACTDAYS	If defined
POLICYFLD_CLIENT_GROUP_LIST	If defined
POLICYFLD_CLIENT_GROUP_MODE	If defined
POLICYFLD_CREATE_TIME	If defined
POLICYFLD_CUSTOM_REQUEST_BODY	If defined
POLICYFLD_DCR	If defined (deprecated)
POLICYFLD_DEFAULT_DOMAIN	If defined
POLICYFLD_DELAYED_ACTIVATION_PERIOD	If defined
POLICYFLD_DESCRIPTION	If defined
POLICYFLD_DIGIPASS_TYPES	If defined
POLICYFLD_DP_EXPIRATION_PERIOD	If defined
POLICYFLD_DP_TYPE_LIMIT	If defined
POLICYFLD_DUR	If defined
POLICYFLD_EVENTWINDOW	If defined
POLICYFLD_GRACE_PERIOD	If defined
POLICYFLD_GROUP_CHECK_MODE	If defined
POLICYFLD_GROUP_LIST	If defined
POLICYFLD_ITHRESHOLD	If defined
POLICYFLD_ITIMEWINDOW	If defined
POLICYFLD_LOCAL_AUTH	If defined
POLICYFLD_LOCK_DURATION_MULTIPLIER	If defined
POLICYFLD_MAX_UNLOCK_TRIES	If defined
POLICYFLD_MIN_APP_VERSION	If defined
POLICYFLD_MIN_LOCK_DURATION	If defined
POLICYFLD_MOBILE_APP_NAME	If requested
POLICYFLD_MODIFY_TIME	If defined
POLICYFLD_MULTI_DP_APPL_VALIDATION_MODE	If defined
POLICYFLD_OFFLINE_AUTH_ENABLED	If defined
POLICYFLD_OFFLINE_MAX_EVENTS	If defined
POLICYFLD_OFFLINE_TIME_INTERVAL	If defined
POLICYFLD_ONE_STEP_CHAL_CHECKDIGIT	If defined
POLICYFLD_ONE_STEP_CHAL_LENGTH	If defined
POLICYFLD_ONE_STEP_CHAL_RESP	If defined
POLICYFLD_ONLINESG	If defined
POLICYFLD_PARENT_POLICY_ID	If defined
POLICYFLD_PIN_CHANGE_ALLOWED	If defined
POLICYFLD_POLICY_ID	If defined
POLICYFLD_PRIMARY_VDP_REQUEST_KEYWORD	If defined
POLICYFLD_PRIMARY_VDP_REQUEST_METHOD	If defined
POLICYFLD_PRIVILEGED_USERS	If defined
POLICYFLD_PUSH_NOTIFICATION_MESSAGE_SUBJECT	If defined
POLICYFLD_PUSH_NOTIFICATION_MESSAGE_TITLE	If defined
POLICYFLD_PUSH_NOTIFICATION_REQUEST_KEYWORD	If defined
POLICYFLD_PUSH_NOTIFICATION_REQUEST_METHOD	If defined
POLICYFLD_RADIUS_ALLOWED_PROTOCOLS	If defined
POLICYFLD_RADIUS_REP_ATTR_ENABLED	If defined
POLICYFLD_RADIUS_REP_ATTR_GROUP_LIST	If defined
POLICYFLD_RADIUS_SESSION_LIFETIME	If defined
POLICYFLD_RADIUS_SESSION_TICKET_LIFETIME	If defined
POLICYFLD_RADIUS_SESSION_TICKET_REUSE	If defined
POLICYFLD_SECOND_OTP_SYNC_ENABLED	If defined
POLICYFLD_SECURE_CHAL_FONT_INDEX	If defined
POLICYFLD_SECURE_CHAL_REQ_PIN	If defined
POLICYFLD_SECURE_CHAL_TEMPLATE_NO	If defined
POLICYFLD_SECURE_CHANNEL	If defined
POLICYFLD_SECURE_SIGN_FONT_INDEX	If defined
POLICYFLD_SECURE_SIGN_REQ_PIN	If defined
POLICYFLD_SECURE_SIGN_SHOW_RESPONSE	If defined
POLICYFLD_SECURE_SIGN_SHOW_WARNING	If defined
POLICYFLD_SECURE_SIGN_TEMPLATE_NO	If defined
POLICYFLD_SELF_ASSIGN_SEPARATOR	If defined
POLICYFLD_STATIC_PWD_DIFF_TO_PREV	If defined
POLICYFLD_STATIC_PWD_MIN_LENGTH	If defined
POLICYFLD_STATIC_PWD_EXPIRATION_NOTIFICATION	If defined
POLICYFLD_STATIC_PWD_MAX_AGE	If defined
POLICYFLD_STATIC_PWD_MIN_AGE	If defined
POLICYFLD_STATIC_PWD_MIN_LOWER_ALPHA	If defined
POLICYFLD_STATIC_PWD_MIN_NUMBER	If defined
POLICYFLD_STATIC_PWD_MIN_SYMBOL	If defined
POLICYFLD_STATIC_PWD_MIN_UPPER_ALPHA	If defined
POLICYFLD_STATIC_PWD_NOT_USERID_BASED	If defined
POLICYFLD_STHRESHOLD	If defined
POLICYFLD_STIMEWINDOW	If defined
POLICYFLD_STORED_PASSWORD_PROXY	If defined
POLICYFLD_SYNCWINDOW	If defined
POLICYFLD_USE_GENERIC_AUTH_STATUS_CODES	If defined
POLICYFLD_USER_INACT_DAYS	If defined
POLICYFLD_USER_INFO_SYNC	If defined
POLICYFLD_USER_LOCK_THRESHOLD	If defined
POLICYFLD_VDP_DELIVERY_METHOD	If defined
POLICYFLD_VDP_MDC_PROFILE	If defined
POLICYFLD_VDP_SIGN_DELIVERY_METHOD	If defined
POLICYFLD_VDP_SIGN_ENABLED	If defined
POLICYFLD_VDP_SIGN_MDC_PROFILE	If defined

For more information about the specific attributes, refer to Table: policyExecute field attributes.

PolicyQueryOptions (Data type)

This data type determines what results should be returned.

Table: QueryOptions (Data type)
Element name	Data type	Description
count	Boolean	Flag to request OneSpan Authentication Server to return only the number of records in the result set, but not the result set itself. Default value: false
distinct	Boolean	Flag to request OneSpan Authentication Server to return only unique query results. Default value: false
rowcount	Unsigned Integer	Option to request OneSpan Authentication Server to return the specified number of result records, beginning with the record specified by rowoffset. If set to 0, all result records are returned. Default value: 0
rowoffset	Unsigned Integer	Option to request OneSpan Authentication Server to return result records starting from the specified offset. Can only be used together with rowcount. Default value: 0
sortfieldid	String	Optional. Required if you specify SortOrder. Determines the field attribute to use as sort key when sorting the result set using SortOrder. May contain any field attribute from the FieldSet parameter.
sortorder	String	Optional. Determines the sort order of the result set. By default, the result set is unsorted. Possible values: QUERYOPTIONSORTORDER_ASCENDING. Result set in ascending order. QUERYOPTIONSORTORDER_DESCENDING. Result set in descending order.

PolicyQueryResults (Data type)

Table: PolicyQueryResults (Data type)
Element name	Data type	Description
resultCodes	ResultCodes	Required. The result and status codes returned by the command. For more information, refer to the OneSpan Authentication Server SDK Programmer's Guide, Section "Error and Status Codes".
resultAttribute	PolicyAttributeList	Required. List containing the queried policy attributes. Each item of type PolicyAttributeSet.
resultCount	Integer	Required. The number of items in resultAttribute.
errorStack	ErrorStack	Required. The error stack, indicating that the command has not completed successfully.

Example

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header/>
  <SOAP-ENV:Body>
    <adm:policyQuery xmlns:adm="http://www.vasco.com/IdentikeyServer/IdentikeyTypes/Administration" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <sessionID>3JSK8cmRjw4E30wAA=0nUTL-~3fmifTO</sessionID>
      <attributeSet>
        <attributes>
          <value xsi:type="xsd:string">Base Policy</value>
          <attributeID>POLICYFLD_POLICY_ID</attributeID>
        </attributes>
      </attributeSet>
      <fieldSet>
        <attributeID>POLICYFLD_POLICY_ID</attributeID>
        <attributeID>POLICYFLD_DESCRIPTION</attributeID>
      </fieldSet>
    </adm:policyQuery>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Requirements

Required administrative privileges:

View Policy

Additional considerations

After upgrading OneSpan Authentication Server, server data is continuously migrated while the already-upgraded OneSpan Authentication Server service is running. Until data migration has been completed, the result of a query command may be incomplete and may include both migrated and non-migrated data. This means that values for new data fields may be missing or not set correctly in the query result.

Cet article vous a-t-il été utile ?

What's Next

reportExecute (Command)

Table des matières

Parameters
Example
Requirements
Additional considerations