orgunitQuery (Command)

Mis à jour le 18 Dec 2024
3 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 orgunitQuery command queries organizational units that match specified search criteria.

Parameters

Table: orgunitQuery input 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)).
attributeSet	OrgunitAttributeSet	Optional. A set containing zero or more attribute fields that specify the query search criteria. See OrgunitAttributeSet (Data type).
fieldSet	OrgunitFieldSet	Optional. Specifies the attribute fields to be returned for all the records matching the search criteria. See OrgunitFieldSet (Data type). If fieldSet is omitted, all possible output parameters are returned. If a domain attribute field is not set in the database, it is not returned for that specific domain record.
queryOptions	OrgunitQueryOptions	Optional. Options to determine what results should be returned. See OrgunitQueryOptions (Data type).

Table: orgunitQuery output parameters
Parameter name	Data type	Description
results	OrgunitQueryResults	Result structure containing return and status codes and a list of zero or more result attribute fields.

OrgunitAttributeSet (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: OrgunitAttributeSet (Data type)
Element name	Data type	Description
attributes	OrgunitAttribute	Attributes specifying the domain query search criteria (see Table: OrgunitAttribute (Data type)).

Table: OrgunitAttribute (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 elements: 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. wildcard. Indicates that the specified attribute contains wildcard characters ('*') and should be treated as such. If absent, the search value will be used literally.
value	Any	The attribute value. The data type has to be specified by setting the xsi:type XML attribute.
attributeID	OrgunitAttributeIDEnum	The attribute identifier (see Table: orgunitQuery (Supported input attributes)).

Table: orgunitQuery (Supported input attributes)
Attribute name	Optionality
ORGUNITFLD_CREATE_TIME	Optional
ORGUNITFLD_DESCRIPTION	Optional
ORGUNITFLD_DOMAIN	Optional
ORGUNITFLD_MODIFY_TIME	Optional
ORGUNITFLD_ORGANIZATIONAL_UNIT	Optional
ORGUNITFLD_PARENT_ORGANIZATIONAL_UNIT	Optional
ORGUNITFLD_SEARCH_DOWN_OU_PATH	Optional

For more information about the specific attributes, see Table: orgunitExecute field attributes.

OrgunitFieldSet (Data type)

The attributes specified in the fieldSet attribute specify the organizational unit fields that should be returned by OneSpan Authentication Server for the organizational units 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: OrgunitFieldSet (Data type)
Element name	Data type	Description
attributeID	OrgunitAttributeIDEnum	The identifier of an attribute to return (see Table: orgunitQuery (Supported output attributes)).

Table: orgunitQuery (Supported output attributes)
Attribute name	Returned
ORGUNITFLD_CREATE_TIME	Always
ORGUNITFLD_DESCRIPTION	If defined
ORGUNITFLD_DOMAIN	Always
ORGUNITFLD_MODIFY_TIME	Always
ORGUNITFLD_ORGANIZATIONAL_UNIT	Always
ORGUNITFLD_PARENT_ORGANIZATIONAL_UNIT	If defined

For more information about the specific attributes, see Table: orgunitExecute field attributes.

OrgunitQueryOptions (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.

OrgunitQueryResults (Data type)

Table: OrgunitQueryResults (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	OrgunitAttributeList	Required. List containing the queried domain attributes. Each item is of type OrgunitAttributeSet (see Table: OrgunitAttributeSet (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

<?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:orgunitQuery 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>Z]9__csvUoTHaO4#E1_gn1S[+FI+vw~x</sessionID>
      <attributeSet>
        <attributes>
          <value xsi:type="xsd:string">master</value>
          <attributeID>ORGUNITFLD_DOMAIN</attributeID>
        </attributes>
        <attributes>
          <value xsi:type="xsd:string">ParentOU</value>
          <attributeID>ORGUNITFLD_ORGANIZATIONAL_UNIT</attributeID>
        </attributes>
      </attributeSet>
      <queryOptions>
        <rowcount>1</rowcount>
        <rowoffset>0</rowoffset>
      </queryOptions>
    </adm:orgunitQuery>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Requirements

Required administrative privileges:

View Organizational Unit

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

componentExecute (Command)

Table des matières

Parameters
Example
Requirements
Additional considerations