--- title: "backEndServerGroupQuery (Command)" slug: "oas-fullsdk-soapref-backendservergroupquery-command-3-28" updated: 2025-07-04T10:05:19Z published: 2025-07-07T15:34:07Z canonical: "docs.onespan.com/oas-fullsdk-soapref-backendservergroupquery-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. # backEndServerGroupQuery (Command) The backEndServerGroupQuery command allows to query back-end server groups 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 | BackEndServerGroupAttributeSet | Required. A set containing zero or more attribute fields that specify the query search criteria. See [BackEndServerGroupAttributeSet (Data type)](/sec/docs/oas-fullsdk-soapref-backendservergroupquery-command-3-28#backendservergroupattributeset-data-type). | | fieldSet | BackEndServerGroupFieldSet | Optional. Specifies the attribute fields to be returned for all the records matching the search criteria. See [BackEndServerGroupFieldSet (Data type)](/sec/docs/oas-fullsdk-soapref-backendservergroupquery-command-3-28#backendservergroupfieldset-data-type). 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 operation. | | queryOptions | BackEndServerGroupQueryOptions | Optional. Options to determine what results should be returned. See [BackEndServerGroupQueryOptions (Data type)](/sec/docs/oas-fullsdk-soapref-backendservergroupquery-command-3-28#backendservergroupqueryoptions-data-type). | | Parameter name | Data type | Description | | --- | --- | --- | | results | BackEndServerGroupQueryResults | Required. Result structure containing return and status codes and a list of zero or more result attribute fields. See [BackEndServerGroupQueryResults (Data type)](/sec/docs/oas-fullsdk-soapref-backendservergroupquery-command-3-28#backendservergroupqueryresults-data-type). | The following field attributes are available for the operations of this command: | Attribute name | Data type | Description | | --- | --- | --- | | BACKENDSERVERGROUPFLD_QUALIFIED_NAME | String | The qualified name of the back-end server group. Up to 255 characters. | | BACKENDSERVERGROUPFLD_BACK_END_PROTOL_ID | String | Possible values: - Microsoft AD - Windows | ### BackEndServerGroupAttributeSet (Data type) The attributes specified in this attribute set define the search criteria. | Element name | Data type | Description | | --- | --- | --- | | attributes | BackEndServerGroupAttribute | Attributes specifying the query search criteria (see [Table: BackEndServerGroupAttribute (Data type)](/sec/docs/oas-fullsdk-soapref-backendservergroupquery-command-3-28#Tab_BackEndServerGroupAttributeDataType)). | | 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 | BackEndServerGroupAttributeIDEnum | The attribute identifier (see [Table: backEndServerGroupQuery (Supported input attributes)](/sec/docs/oas-fullsdk-soapref-backendservergroupquery-command-3-28#Tab_backEndServerGroupQuerySupportedInputAttributes)). | | Attribute name | Optionality | | --- | --- | | BACKENDSERVERGROUPFLD_QUALIFIED_NAME | Optional | | BACKENDSERVERGROUPFLD_BACK_END_PROTOL_ID | Optional | ### BackEndServerGroupFieldSet (Data type) The attributes included in the fieldSet parameter specify the attribute fields that should be returned by OneSpan Authentication Server for the items 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 | BackEndServerGroupAttributeIDEnum | The identifier of an attribute to return (see [Table: backEndServerGroupQuery (Supported output attributes)](/sec/docs/oas-fullsdk-soapref-backendservergroupquery-command-3-28#Tab_backEndServerGroupQuerySupportedOutputAttributes) ). | | Attribute name | Returned? | | --- | --- | | BACKENDSERVERGROUPFLD_BACK_END_PROTOL_ID | If defined | | BACKENDSERVERGROUPFLD_QUALIFIED_NAME | If defined | ### BackEndServerGroupQueryOptions (Data type) This data type determines what results should be returned. | Element name | Data type | Description | | --- | --- | --- | | 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 not sorted. Possible values: - QUERYOPTIONSORTORDER_ASCENDING. Result set in ascending order. - QUERYOPTIONSORTORDER_DESCENDING. Result set in descending order. | ### BackEndServerGroupQueryResults (Data type) | Element name | Data type | Description | | --- | --- | --- | | resultCodes | ResultCodes | Required. The result and status codes returned by the command. | | resultAttribute | BackEndServerGroupAttributeSet | Required. List containing the queried attributes. Each item of type BackEndServerGroupAttribute. | | resultCount | Integer | Required. The number of items in resultAttribute. | | errorStack | ErrorStack | Required. The error stack, indicating that the command has not completed successfully. | ## 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.