Retrieving Descriptor of Protected Directory Properties

Use the get-pd-location-descriptor operation to retrieve descriptor of protected directory properties. For details on descriptors, refer to the Representation of Object Descriptor section of the API RPC Reference and the Descriptors Overview Section of the API RPC Developer's Guide.

In this chapter:

Request Packet Structure

Response Packet Structure

Samples

 

Request Packet Structure

A request XML packet retrieving protected directory descriptors includes the get-pd-location-descriptor operation node:

<packet version="1.5.2.0">
<protected-dir>
<get-pd-location-descriptor>
...  
</get-pd-location-descriptor>
</protected-dir>
</packet>

 

The get-pd-location-descriptor node is presented by type ProtectedDirGetLocationDescriptor (protected_dir.xsd), and its graphical representation is as follows:

 

Response Packet Structure

The delete-user node of the output XML packet is presented by type ProtectedDirDeleteUserOutput (protected_dir.xsd) and structured as follows:

 

 

Samples

Retrieving server-level descriptor

The packet that requests for server-level properties descriptor looks as follows:

<packet>
<protected-dir>
    <get-pd-location-descriptor>
      <filter/>
    </get-pd-location-descriptor>
</protected-dir>
</packet>

Response (for Linux/Unix):

<packet>
<protected-dir>
    <get-pd-location-descriptor>
      <result>
         <status>ok</status>
         <descriptor>
            	<property>
		   <name>ssl</name>
		   <type>boolean</type>
		   <default>true</default>
	        </property>
            	<property>
		   <name>nonssl</name>
		   <type>boolean</type>
		   <default>true</default>
	        </property>
            	<property>
		   <name>cgi</name>
		   <type>boolean</type>
		   <default>false</default>
	        </property>
         </descriptor>
      </result>
    </get-pd-location-descriptor>
  </protected-dir>
</packet>

Response (for Windows):

<packet>
<protected-dir>
    <get-pd-location-descriptor>
      <result>
         <status>ok</status>
      </result>
    </get-pd-location-descriptor>
  </protected-dir>
</packet> 
Retrieving site-level descriptor

The packet that requests for site-level properties descriptor looks as follows::

<packet>
<protected-dir>
    <get-pd-location-descriptor>
      <filter>
        <site-id>100</site-id>
      </filter>
    </get-pd-location-descriptor>
  </protected-dir>
</packet>

Response (for Linux/Unix):

<packet>
<protected-dir>
    <get-pd-location-descriptor>
      <result>
         <status>ok</status>
         <filter-id>100</filter-id>
         <descriptor>
            	<property>
		   <name>ssl</name>
		   <type>boolean</type>
		   <default>true</default>
		   <writable-by>admin</writable-by>
		   <writable-by>client</writable-by>
		   <writable-by>domain-admin</writable-by>
	        </property>
            	<property>
		   <name>nonssl</name>
		   <type>boolean</type>
		   <default>true</default>
		   <writable-by>admin</writable-by>
		   <writable-by>client</writable-by>
		   <writable-by>domain-admin</writable-by>
	        </property>
            	<property>
		   <name>cgi</name>
		   <type>boolean</type>
		   <default>false</default>
		   <writable-by>admin</writable-by>
		   <writable-by>client</writable-by>
		   <writable-by>domain-admin</writable-by>
	        </property>
         </descriptor>
      </result>
    </get-pd-location-descriptor>
  </protected-dir>
</packet>

Response (for Windows):

<packet>
<protected-dir>
    <get-pd-location-descriptor>
      <result>
         <status>ok</status>
         <filter-id>100</filter-id>
      </result>
    </get-pd-location-descriptor>
  </protected-dir>
</packet>