Previous page

Next page

Locate page in Contents

Print this page

get_user

Summary:

Retrieves user information from the specified realm.

Request specification:

Name

Min/Max

Type

Description

get_user

1..1

 

 

{

 

 

 

[

1..1

 

Denotes a choice between the user and the attr elements.

user

1..1

auth_nameType

The user to retrieve the information for. The user is specified by supplying the user name, domain, and realm information. Omit the name parameter to retrieve all users from the specified realm. If the name is included, only the information for the specified user will be retrieved.

attr

1..1

 

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.

{

 

 

 

name

1..1

string

The name of the attribute to search for.

value

1..1

base64Binary

Attribute value.

realm

1..1

guid_type

The ID of the realm to conduct the search in.

}

 

 

 

]

 

 

 

attrs

0..1

none

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 name element (below) to retrieve all available attributes.

{

 

 

 

name

0..[]

string

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

1..[]

security_principalType

User information.

Description:

The call retrieves the user information from the specified realm. The following actions are possible depending on the options selected:

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>

Please send us your feedback on this help page