| Authorization token required | true |
| Admin Authorization token required | true |
<SearchAutoProvDirectoryRequest keyAttr="{key-attr}" [query="..."] [name="..."]
[maxResults="{max-results} (Integer)"] [limit="{limit} (Integer)"]
[offset="{offset} (Integer)"] [refresh="(0|1)"] [attrs="{request-attrs}"]> ## SearchAutoProvDirectoryRequest
<domain [by="{domain-selector-by} (id | name | virtualHostname | krb5Realm | foreignName)"]>{key}</domain> ## DomainSelector
</SearchAutoProvDirectoryRequest>
elements and attributes you can define within a
<SearchAutoProvDirectoryRequest> element:
| XPath | Required / Optional | Description |
| @keyAttr | Required (only 1) | Type: String Name of attribute for the key. Value of the key attribute will appear in the <key> element in the response. It is recommended to pick a key attribute that is single-valued and can unique identify an entry in the external auto provision directory. If the key attribute contains multiple values then multiple <key> elements will appear in the response. Entries are returned in ascending key order. |
| @query | Optional (0 or 1) | Type: String Query string - should be an LDAP-style filter string (RFC 2254) |
| @name | Optional (0 or 1) | Type: String Name to fill the auto provisioning search template configured on the domain |
| @maxResults | Optional (0 or 1) | Type: Integer Maximum results that the backend will attempt to fetch from the directory before returning an account.TOO_MANY_SEARCH_RESULTS error. |
| @limit | Optional (0 or 1) | Type: Integer The number of accounts to return per page (0 is default and means all) |
| @offset | Optional (0 or 1) | Type: Integer The starting offset (0, 25, etc) |
| @refresh | Optional (0 or 1) | Type: 0|1 Refresh - whether to always re-search in LDAP even when cached entries are available. 0 (false) is the default. |
| @attrs | Optional (0 or 1) | Type: String Comma separated list of attributes |
| /domain | Required (only 1) | Type: {key} Domain selector for the domain name to limit the search to (do not use if searching for domains) Description for element text content:The key used to identify the domain. Meaning determined by {domain-selector-by} |
| /domain@by | Optional (0 or 1) | Type: id | name | virtualHostname | krb5Realm | foreignName Select the meaning of {domain-selector-key} |
<SearchAutoProvDirectoryResponse more="{more-flag} (0|1)" searchTotal="{search-total} (int)"> ## SearchAutoProvDirectoryResponse
(<entry dn="{dn}"> ## AutoProvDirectoryEntry
(<key>{keys} (String)</key>)*
(<a n="{key}">{value}</a> ## KeyValuePair)*
</entry>)*
</SearchAutoProvDirectoryResponse>
elements and attributes you can define within a
<SearchAutoProvDirectoryResponse> element:
| XPath | Required / Optional | Description |
| @more | Required (only 1) | Type: 0|1 1 (true) if more entries to return |
| @searchTotal | Required (only 1) | Type: int Total number of accounts that matched search (not affected by limit/offset) |
| /entry | Optional (0 or more) | Entries |
| /entry@dn | Required (only 1) | Type: String DN |
| /entry/key | Optional (0 or more) | Type: {keys} (String) Keys |
| /entry/a | Optional (0 or more) | Type: {value} Key Value pairs Description for element text content:Value |
| /entry/a@n | Required (only 1) | Type: String Key |