---
title: "digipassQuery (Command)"
slug: "oas-fullsdk-soapref-digipassquery-command-3-28"
updated: 2025-11-14T10:11:02Z
published: 2025-11-14T10:11:02Z
canonical: "docs.onespan.com/oas-fullsdk-soapref-digipassquery-command-3-28"
---
> ## Documentation Index
> Fetch the complete documentation index at: https://docs.onespan.com/llms.txt
> Use this file to discover all available pages before exploring further.
# digipassQuery (Command)
> Availability: All versions
>
> Scenario: Administration
>
> Support: full-sdk
The digipassQuery command allows to query authenticators that match specified search criteria.
## Parameters
| 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)](/sec/docs/oas-fullsdk-soapref-logon-command-3-28)). |
| attributeSet | DigipassAttributeSet | Required. A set containing zero or more attribute fields that specify the query search criteria. See [DigipassAttributeSet (Data type)](/sec/docs/oas-fullsdk-soapref-digipassquery-command-3-28#digipassattributeset-data-type). |
| fieldSet | DigipassFieldSet | Optional. Specifies the attribute fields to be returned for all the records matching the search criteria. See [DigipassFieldSet (Data type)](/sec/docs/oas-fullsdk-soapref-digipassquery-command-3-28#digipassfieldset-data-type). If fieldSet is omitted, all possible output parameters are returned. If an authenticator attribute field is not set in the database, it is not returned for that specific authenticator record. |
| queryOptions | DigipassQueryOptions | Optional. Options to determine what results should be returned. See [DigipassQueryOptions (Data type)](/sec/docs/oas-fullsdk-soapref-digipassquery-command-3-28#digipassqueryoptions-data-type). |
| Parameter name | Data type | Description |
| --- | --- | --- |
| results | DigipassQueryResults | Required. Result structure containing return and status codes and a list of zero or more result attribute fields. See [DigipassQueryResults (Data type)](/sec/docs/oas-fullsdk-soapref-digipassquery-command-3-28#digipassqueryresults-data-type). |
### DigipassAttributeSet (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. In this case, they will be interpreted as the SQL LIKE statement.
- A list of comma-separated values can be specified for the DIGIPASSFLD_DOMAIN and DIGIPASSFLD_DPTYPE attributes. In this case it will be interpreted as the logical OR of the given values. Note that you cannot use wildcard characters in comma-separated values!
- Otherwise, the search will be done using the exact match of the given value.
| Element name | Data type | Description |
| --- | --- | --- |
| attributes | DigipassAttribute | Attributes specifying the authenticator query search criteria (see [Table: DigipassAttribute (Data type)](/sec/docs/oas-fullsdk-soapref-digipassquery-command-3-28#Tab_DigipassAttributeDataType)). |
| 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.: true 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 | DigipassAttributeIDEnum | The attribute identifier (see [Table: digipassQuery (Supported input attributes)](/sec/docs/oas-fullsdk-soapref-digipassquery-command-3-28#Tab_digipassQuerySupportedInputAttributes)). |
| Attribute name | Optionality |
| --- | --- |
| DIGIPASSFLD_ACTIVE_APPL_NAMES | Optional |
| DIGIPASSFLD_ACTIVE_APPL_TYPES | Optional |
| DIGIPASSFLD_ASSIGN_STATUS | Optional |
| DIGIPASSFLD_ASSIGNED_USER_ORG_UNIT | Optional |
| DIGIPASSFLD_ASSIGNED_USERID | Optional |
| DIGIPASSFLD_DEVICE_ID | Optional |
| DIGIPASSFLD_DEVICE_PNID | Optional |
| DIGIPASSFLD_DIRECT_ASSIGN_ONLY | Optional |
| DIGIPASSFLD_DOMAIN | Optional |
| DIGIPASSFLD_DPTYPE | Optional |
| DIGIPASSFLD_EXPIRATION_TIME | Optional |
| DIGIPASSFLD_EXPIRED | Optional |
| DIGIPASSFLD_FROM_LAST_AUTH_TIME | Optional |
| DIGIPASSFLD_GRACE_PERIOD_EXPIRED | Optional |
| DIGIPASSFLD_GRACE_PERIOD_EXPIRES | Optional |
| DIGIPASSFLD_LAST_AUTH_TIME | Optional |
| DIGIPASSFLD_LICENSE_SERNO | Optional |
| DIGIPASSFLD_ORGANIZATIONAL_UNIT | Optional |
| DIGIPASSFLD_NOT_AUTHENTICATED | Optional |
| DIGIPASSFLD_PENDING_OPERATION_ID | Optional |
| DIGIPASSFLD_PROV_ACTIV_COUNT | Optional |
| DIGIPASSFLD_SEARCH_DOWN_OU_PATH | Optional |
| DIGIPASSFLD_SEARCH_UP_OU_PATH | Optional |
| DIGIPASSFLD_SERNO | Optional |
| DIGIPASSFLD_START_TIME | Optional |
| DIGIPASSFLD_TO_EXPIRATION_TIME | Optional |
| DIGIPASSFLD_TO_LAST_AUTH_TIME | Optional |
| DIGIPASSFLD_TO_SERNO | Optional |
| DIGIPASSFLD_TO_START_TIME | Optional |
| DIGIPASSFLD_TOP_ORGANIZATIONAL_UNIT | Optional |
The query will only return results for exact matches of DIGIPASSFLD_LAST_AUTH_TIME, null or empty values are not allowed.
Only either DIGIPASSFLD_LAST_AUTH_TIME, DIGIPASSFLD_NOT_AUTHENTICATED, or a combination of DIGIPASSFLD_FROM_LAST_AUTH_TIME/DIGIPASSFLD_TO_LAST_AUTH_TIME may be specified.
For more information about the specific attributes, see [Table: digipassExecute field attributes](/sec/docs/oas-fullsdk-soapref-digipassexecute-command-3-28#Tab_digipassExecuteFieldAttributes).
### DigipassFieldSet (Data type)
The attributes specified in the fieldSet parameter specify the authenticator attribute fields that should be returned by OneSpan Authentication Server for the authenticator records 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.
| Element name | Data type | Description |
| --- | --- | --- |
| attributeID | DigipassAttributeIDEnum | The identifier of an attribute to return (see [Table: digipassQuery (Supported output attributes)](/sec/docs/oas-fullsdk-soapref-digipassquery-command-3-28#Tab_digipassQuerySupportedOutputAttributes)). |
| Attribute name | Returned? |
| --- | --- |
| DIGIPASSFLD_ACTIV_COUNT | If defined |
| DIGIPASSFLD_ACTIV_LOCATIONS | If defined |
| DIGIPASSFLD_ACTIVE_APPL_NAMES | If defined |
| DIGIPASSFLD_ACTIVE_APPL_TYPES | If defined |
| DIGIPASSFLD_ASSIGN_STATUS | If defined |
| DIGIPASSFLD_ASSIGNED_DATE | If defined |
| DIGIPASSFLD_ASSIGNED_USER_ORG_UNIT | If defined |
| DIGIPASSFLD_ASSIGNED_USERID | If defined |
| DIGIPASSFLD_BACKUP_VDP_ENABLED | If defined |
| DIGIPASSFLD_BACKUP_VDP_EXPIRES | If defined |
| DIGIPASSFLD_BACKUP_VDP_USES_LEFT | If defined |
| DIGIPASSFLD_DEVICE_ID | If defined |
| DIGIPASSFLD_DEVICE_PNID | If defined |
| DIGIPASSFLD_DIRECT_ASSIGN_ONLY | If defined |
| DIGIPASSFLD_DOMAIN | If defined |
| DIGIPASSFLD_DPSOFT_PARAMS_ID | If defined |
| DIGIPASSFLD_DPTYPE | If defined |
| DIGIPASSFLD_EXPIRATION_TIME | If defined |
| DIGIPASSFLD_EXPIRED | Always |
| DIGIPASSFLD_GRACE_PERIOD_EXPIRED | Always |
| DIGIPASSFLD_GRACE_PERIOD_EXPIRES | If defined |
| DIGIPASSFLD_LAST_ACTIV_TIME | If defined |
| DIGIPASSFLD_LAST_AUTH_TIME | If defined |
| DIGIPASSFLD_LICENSE_SERNO | If defined |
| DIGIPASSFLD_ORGANIZATIONAL_UNIT | If defined |
| DIGIPASSFLD_PENDING_OPERATION_ID | If defined |
| DIGIPASSFLD_PROV_ACTIV_COUNT | If defined |
| DIGIPASSFLD_SERNO | If defined |
| DIGIPASSFLD_START_TIME | If defined |
For more information about the specific attributes, see [Table: digipassExecute field attributes](/sec/docs/oas-fullsdk-soapref-digipassexecute-command-3-28#Tab_digipassExecuteFieldAttributes).
### DigipassQueryOptions (Data type)
This data type determines what results should be returned.
| 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. |
### DigipassQueryResults (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 | DigipassAttributeList | Required. A list containing the queried authenticator attributes. Each item is of type DigipassAttributeSet (see [DigipassAttributeSet (Data type)](/sec/docs/oas-fullsdk-soapref-digipassquery-command-3-28#digipassattributeset-data-type)). |
| resultCount | Integer | Required. The number of items in resultAttribute. |
| errorStack | ErrorStack | Required. The error stack, indicating that the command has not completed successfully. |
## Example
> ```markup
>
>
>
>
>
> 3JSK8cmRjw4E30wAA=0nUTL-~3fmifTO
>
>
> VDS0000001
> DIGIPASSFLD_SERNO
>
>
>
>
>
>
> ```
## Requirements
Required administrative privileges:
- View DIGIPASS
## 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.