Login
    Contenu x
    backEndServerGroupQuery (Command)
    • 18 Dec 2024
    • 3 Minutes à lire
    • Sombre
      Lumière
    • PDF
    Contenu

    backEndServerGroupQuery (Command)

    • Mis à jour le 18 Dec 2024
    • 3 Minutes à lire
    • Sombre
      Lumière
    • PDF
    The content is currently unavailable in French. You are viewing the default English version.
    Résumé de l’article

    The backEndServerGroupQuery command allows to query back-end server groups that match specified search criteria.

    Parameters

      Table:  backEndServerGroupQuery input parameters
    Parameter nameData typeDescription
    sessionIDString

    Required. The session identifier of the current administrative session. The logon command returns this identifier after a successful logon (see  logon (Command)).

    attributeSetBackEndServerGroupAttributeSetRequired. A set containing zero or more attribute fields that specify the query search criteria. See  BackEndServerGroupAttributeSet (Data type).
    fieldSetBackEndServerGroupFieldSet

    Optional. Specifies the attribute fields to be returned for all the records matching the search criteria. See  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.

    queryOptionsBackEndServerGroupQueryOptionsOptional. Options to determine what results should be returned. See  BackEndServerGroupQueryOptions (Data type).
      Table:  backEndServerGroupQuery output parameters
    Parameter nameData typeDescription

    results

    BackEndServerGroupQueryResults

    Required. Result structure containing return and status codes and a list of zero or more result attribute fields. See  BackEndServerGroupQueryResults (Data type).

    The following field attributes are available for the operations of this command:

      Table:  backEndServerGroupQuery field attributes
    Attribute nameData typeDescription
    BACKENDSERVERGROUPFLD_QUALIFIED_NAMEString

    The qualified name of the back-end server group.

    Up to 255 characters.

    BACKENDSERVERGROUPFLD_BACK_END_PROTOL_IDString

    Possible values:

    • Microsoft AD
    • Windows

    BackEndServerGroupAttributeSet (Data type)

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

      Table:  BackEndServerGroupAttributeSet (Data type)
    Element nameData typeDescription
    attributesBackEndServerGroupAttribute

    Attributes specifying the query search criteria (see Table: BackEndServerGroupAttribute (Data type)).

      Table:  BackEndServerGroupAttribute (Data type)
    Element nameData typeDescription
    attributeOptionsAttributeOptions

    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.
    valueAnyThe attribute value. The data type has to be specified by setting the xsi:type XML attribute.
    attributeIDBackEndServerGroupAttributeIDEnumThe attribute identifier (see Table: backEndServerGroupQuery (Supported input attributes)).
      Table:  backEndServerGroupQuery (Supported input attributes)
    Attribute nameOptionality
    BACKENDSERVERGROUPFLD_QUALIFIED_NAMEOptional
    BACKENDSERVERGROUPFLD_BACK_END_PROTOL_IDOptional

    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.

      Table:  BackEndServerGroupFieldSet (Data type)
    Element nameData typeDescription
    attributeIDBackEndServerGroupAttributeIDEnum

    The identifier of an attribute to return (see Table: backEndServerGroupQuery (Supported output attributes) ).

      Table:  backEndServerGroupQuery (Supported output attributes)
    Attribute nameReturned?
    BACKENDSERVERGROUPFLD_BACK_END_PROTOL_IDIf defined
    BACKENDSERVERGROUPFLD_QUALIFIED_NAMEIf defined

    BackEndServerGroupQueryOptions (Data type)

    This data type determines what results should be returned.

      Table: QueryOptions (Data type)
    Element nameData typeDescription

    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

    sortfieldidString

    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.

    sortorderString

    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)

      Table:  BackEndServerGroupQueryResults (Data type)
    Element nameData typeDescription

    resultCodes

    ResultCodes

    Required. The result and status codes returned by the command.

    resultAttributeBackEndServerGroupAttributeSetRequired. List containing the queried attributes. Each item of type BackEndServerGroupAttribute.
    resultCountIntegerRequired. The number of items in resultAttribute.
    errorStackErrorStackRequired. 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.

    Cet article vous a-t-il été utile ?
    What's Next
    Change password!
    Changing your password will log you out immediately. Use the new password to log back in.
    Change profile
    Success!
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.
    Logout
    ESC

    Ozzy, facilitant la découverte de connaissances grâce à l’intelligence conversationnelle