Previous page

Next page

Locate page in Contents

Print this page

add_realm

Summary:

Adds a Realm definition to the Agent configuration.

Request specification:

Name

Min/Max

Type

Description

add_realm

 

 

 

{

 

 

 

realm

1..1

realmType

Realm information. Depending on the realm type, use the appropriate subtype of the realmType type.

password

0..1

base64Binary

The password for the user account specified in the login portion of the realm structure above.

}

 

 

 

Returns:

Name

Min/Max

Type

Description

id

1..1

guid_type

The new realm ID (automatically generated by Agent). The ID is universally unique.

Description:

When adding an LDAP directory realm, the call does not verify whether the values that you supply are valid or not. It verifies the basic syntax, but it doesn't actually try to connect to the directory. After you execute the call, you should check that you can connect to the directory and retrieve the data from it. For example, you can try getting a user information from with the get_user call.

Note: When adding an LDAP directory Realm please make sure that the users in your directory are stored as objects of type User (objectClass=User) and that the groups are stored as objects of type Group (objectClass=Group). If the user and group objects use different classes, you will not be able to see or authenticate them in Agent.

Example:

The following example shows how to create a typical LDAP directory realm. The following table describes the parameters and their values used in the example.

Parameter

Value

Description

type

1

LDAP directory realm.

name

myrealm

Realm name.

address

192.168.0.117

The IP address of the server hosting the LDAP directory.

port

398

TCP port number on which the directory instance is listening for requests.

base_dn

dc=vzl

Base DN (the top level of the directory tree).

default_dn

cn=users,dc=vzl

Default DN (the default container in the directory where the user information is stored).

login/name

cn=vzagent,dc=VZL

The DN of the user that will be used to connect to the directory instance to perform authentications.

password

bXlwYXNz

The password for the user specified in the login/name parameter above.

Input

<packet xmlns:ns4="http://www.swsoft.com/webservices/vzl/4.0.0/authm" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="4.0.0">

<target>authm</target>

<data>

<authm>

<add_realm>

<realm xsi:type="ns4:dir_realmType">

<type>1</type>

<name>myrealm</name>

<address>192.168.0.117</address>

<port>398</port>

<base_dn>dc=vzl</base_dn>

<default_dn>cn=users,dc=vzl</default_dn>

<login>

<name>Y249dnphZ2VudCxkYz1WWkw=</name>

</login>

</realm>

<password>bXlwYXNz</password>

</add_realm>

</authm>

</data>

</packet>

Output

<?xml version="1.0" encoding="UTF-8"?><ns1:packet 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="8c460a8b7ft6952r350" time="2007-03-21T12:21:57+0000" priority="0" version="4.0.0">

<ns1:origin>authm</ns1:origin>

<ns1:target>vzclient8</ns1:target>

<ns1:dst>

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

</ns1:dst>

<ns1:data>

<ns2:authm>

<ns2:id>18e8c5f0-e656-4144-864c-0520275a4bd1</ns2:id>

</ns2:authm>

</ns1:data>

<ns1:src>

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

</ns1:src>

</ns1:packet>

Please send us your feedback on this help page