Getting Information About a Role

Use the get operation to get information about a role.

In this chapter:

Request Packet Structure

Response Packet Structure

Samples

 

Request Packet Structure

A request XML packet getting information about specified roles includes the get operation node:

<packet>
<role>
   <get>
   ...
   </get>
</role>
</packet>

 

The get node is nested within the RoleGetInput type (role.xsd). This node has the following graphics representation:

role-get-rps.gif

 

Important: When creating request packets, put nodes and elements in the order they follow in the packet structure.

 

Response Packet Structure

The get node of the response packet is structured as follows:

role-get-reps.gif

The data node of the response get packet is structured as follows:

role-get-reps.gif

 

 

Samples

A request packet to get the information about the role with ID 1 looks as follows:

<packet version="1.6.3.0">
<role>
   <get>
      <filter>
        <id>1</id>
      </filter>
   </get>
</role>
</packet>

A response packet that includes the information about the role with ID 57 (reduced) can look as follows:

<packet version="1.6.3.0">
  <role>
    <get>
      <result>
        <status>ok</status>
        <filter-id>1</filter-id>
        <id>1</id>
        <data>
          <name>Admin</name>
          <owner-guid>58bb9092-4c8b-4110-ba3d-c40bdad3b178</owner-guid>
          <is-build-in>true</is-build-in>
          <permissions>
            <permission>
              <name>userManagement</name>
              <value>true</value>
            </permission>
...
          </permissions>
        </data>
      </result>
    </get>
  </role>
</packet>