Summary:
Retrieves user information from the specified realm.
Request specification:
Name |
Min/Max |
Type |
Description |
|
|
|
|
|
|
|
|
|
|
|
Denotes a choice between the |
|
|
The user to retrieve the information for. The user is specified by supplying the user name, domain, and realm information. Omit the |
|
|
|
|
This parameter can be used to search for a user or multiple users having a particular attribute set to a particular value. This applies only to the users stored in an LDAP directory. |
|
|
|
|
|
|
|
The name of the attribute to search for. |
|
|
|
Attribute value. |
|
|
The ID of the realm to conduct the search in. |
|
|
|
|
|
|
|
|
|
|
|
|
The user attributes to include in the result set. Omit this element to retrieve just the names of a user (or users) without any attributes. Omit the |
|
|
|
|
|
|
|
The list of attributes to include in the result set. If a user doesn't have a particular attribute value set, the attribute will not be listed for that user. |
|
|
|
|
} |
|
|
|
Returns:
Name |
Min/Max |
Type |
Description |
|
|
User information. |
Description:
The call retrieves the user information from the specified realm. The following actions are possible depending on the options selected:
user
element and specifying the realm ID.user
element and specifying the user name and the realm ID.attr
element and specify the attribute name and value, and the realm ID to conduct the search in.Note: If you are using an external LDAP directory, you have to make sure that the users are stored as objects of class User
(objectClass=User)
. If the user objects in your directory use a different class, the get_user
call will not find them.
Example:
Retrieving the list of all users from the specified realm. Requesting to include the value of the description
attribute for every user in the result set.
Input
<packet version="4.0.0">
<target>authm</target>
<data>
<authm>
<get_user>
<user>
<realm>3e761571-6607-1344-a064-a42679da8ed9</realm>
</user>
<attrs>
<name>description</name>
</attrs>
</get_user>
</authm>
</data>
</packet>
Output
<?xml version="1.0" encoding="UTF-8"?><packet xmlns:ns3="http://www.swsoft.com/webservices/vzl/4.0.0/types" xmlns:ns1="http://www.swsoft.com/webservices/vzl/4.0.0/protocol" xmlns:ns2="http://www.swsoft.com/webservices/vzl/4.0.0/authm" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" id="24c469e07f4t1547r4b4" time="2007-07-18T08:59:11+0000" priority="0" version="4.0.0">
<ns1:origin>authm</ns1:origin>
<ns1:target>vzclient4-2cbbe469-8f57-7f46-97fb-fd987231d957</ns1:target>
<ns1:dst>
<ns1:director>gend</ns1:director>
</ns1:dst>
<ns1:data>
<ns2:authm>
<ns2:user>
<ns2:data>
<ns2:attr>
<ns2:name>description</ns2:name>
<ns2:value>VGhpcyBpcyBhIHRlc3QgdXNlcg==</ns2:value>
</ns2:attr>
</ns2:data>
<ns3:name>VGVzdF9Vc2Vy</ns3:name>
<ns3:realm>3e761571-6607-1344-a064-a42679da8ed9</ns3:realm>
</ns2:user>
</ns2:authm>
</ns1:data>
<ns1:src>
<ns1:director>gend</ns1:director>
</ns1:src>
</packet>