Previous page

Next page

Locate page in Contents

Print this page

get_group

Summary:

Retrieves group information from the specified realm.

Request specification:

Name

Min/Max

Type

Description

get_group

 

 

 

{

 

 

 

[

1..1

 

Denotes a choice between the group and the attr elements. You have to include one of them, you cannot execute the call without any parameters.

group

1..1

auth_nameType

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

attr

1..1

none

This parameter can be used to search for a group or multiple groups having a particular attribute set to a particular value. This applies only to the groups stored in an LDAP directory.

{

 

 

 

name

1..1

string

Attribute name.

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 group attributes to include in the result set. Omit this element to retrieve just the names of a group (or groups) 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 group doesn't have a particular attribute value set, the attribute will not be listed for that group.

}

 

 

 

}

 

 

 

Returns:

Name

Min/Max

Type

Description

group

1..[]

security_principalType

Group information.

Description:

The call retrieves the group 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 groups are stored as objects of class Group (objectClass=Group). If the group objects in your directory use a different class, the get_group call will not find them.

Example:

Retrieving the list of all groups from the specified realm. Requesting to include the value of the description attribute for every group in the result set.

Input

<packet version="4.0.0">

<target>authm</target>

<data>

<authm>

<get_group>

<group>

<realm>3e761571-6607-1344-a064-a42679da8ed9</realm>

</group>

<attrs>

<name>description</name>

</attrs>

</get_group>

</authm>

</data>

</packet>

Output

<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="14c469df342t26e9r4b4" time="2007-07-18T08:01:55+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:group>

<ns2:data>

<ns2:attr>

<ns2:name>description</ns2:name>

<ns2:value>VGhpcyBpcyBhIHRlc3QgZ3JvdXA=</ns2:value>

</ns2:attr>

</ns2:data>

<ns3:name>VGVzdF9Hcm91cA==</ns3:name>

<ns3:realm>3e761571-6607-1344-a064-a42679da8ed9</ns3:realm>

</ns2:group>

<ns2:group xsi:type="ns3:auth_nameType">

<ns3:name>VmlydHVvenpvIENvbnRyb2wgQ2VudGVyIFVzZXJz</ns3:name>

<ns3:realm>3e761571-6607-1344-a064-a42679da8ed9</ns3:realm>

</ns2:group>

<ns2:group>

<ns2:data>

<ns2:attr>

<ns2:name>description</ns2:name>

<ns2:value>VlpBZ2VudCBhZG1pbmlzdHJhdG9ycyBncm91cA==</ns2:value>

</ns2:attr>

</ns2:data>

<ns3:name>Y249dnphZG1pbmlzdHJhdG9ycyxjbj1CdWlsdGluLGRjPVZaTA==</ns3:name>

<ns3:realm>3e761571-6607-1344-a064-a42679da8ed9</ns3:realm>

</ns2:group>

</ns2:authm>

</ns1:data>

<ns1:src>

<ns1:director>gend</ns1:director>

</ns1:src>

</packet>

The next example demonstrates how to search for a group based on the value of a group attribute. Here, we are searching for a group with the description attribute set to "Agent administrators group".

Input

<packet version="4.0.0">

<target>authm</target>

<data>

<authm>

<get_group>

<attr>

<name>description</name>

<value>VlpBZ2VudCBhZG1pbmlzdHJhdG9ycyBncm91cA==</value>

<realm>3e761571-6607-1344-a064-a42679da8ed9</realm>

</attr>

</get_group>

</authm>

</data>

</packet>

Output

<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="14c469df342t26e9r4b4" time="2007-07-18T08:01:55+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:group>

<ns3:name>Y249dnphZG1pbmlzdHJhdG9ycyxjbj1CdWlsdGluLGRjPVZaTA==</ns3:name>

<ns3:realm>3e761571-6607-1344-a064-a42679da8ed9</ns3:realm>

</ns2:group>

</ns2:authm>

</ns1:data>

<ns1:src>

<ns1:director>gend</ns1:director>

</ns1:src>

</packet>

Please send us your feedback on this help page