getRoles
Gets a list of all roles.
Applies to Clouds and Integration Appliances.
- Returns:
- The roles.
Examples:
The following example is a SOAP
request to get roles.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:sec="http://www.approuter.com/schemas/2008/1/
security">
<soapenv:Header>
<sec:sessionId>84076B5B810064272043B5106EEE46C3</sec:sessionId>
</soapenv:Header>
<soapenv:Body>
<sec:getRoles/>
</soapenv:Body>
</soapenv:Envelope>
The following example is
the SOAP response to the request.
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getRolesResponse xmlns:ns2="http://www.approuter.com/
schemas/2008/1/security"
xmlns:ns3="http://www.approuter.com/schema/
router/1000/security/03">
<ns2:roles>
<ns3:id>9A8B9ED954A3781D47C6BA88E6B048BA</ns3:id>
<ns3:name>user@B74A0FF293331AB2A7E4F21E15D143F3</ns3:name>
<ns3:displayName>User Group</ns3:displayName>
<ns3:isActive>true</ns3:isActive>
<ns3:isMutable>false</ns3:isMutable>
<ns3:isVisible>true</ns3:isVisible>
<ns3:createdTime>2010-04-02T22:44:31Z</ns3:createdTime>
<ns3:scopeId>B74A0FF293331AB2A7E4F21E15D143F3</ns3:scopeId>
<ns3:scopeType>Environment</ns3:scopeType>
<ns3:groupType>User</ns3:groupType>
</ns2:roles>
<ns2:roles>
<ns3:id>A15F37B1499136A2151868DE1E47400F</ns3:id>
<ns3:name>publisher@B74A0FF293331AB2A7E4F21E15D143F3</ns3:name>
<ns3:displayName>Publisher Group</ns3:displayName>
<ns3:isActive>true</ns3:isActive>
<ns3:isMutable>false</ns3:isMutable>
<ns3:isVisible>true</ns3:isVisible>
<ns3:createdTime>2010-04-02T22:44:31Z</ns3:createdTime>
<ns3:scopeId>B74A0FF293331AB2A7E4F21E15D143F3</ns3:scopeId>
<ns3:scopeType>Environment</ns3:scopeType>
<ns3:groupType>Publisher</ns3:groupType>
</ns2:roles>
<ns2:roles>
<ns3:id>B3BED651CA6AC0259BE3B5CBB14D4BF8</ns3:id>
<ns3:name>admin@B74A0FF293331AB2A7E4F21E15D143F3</ns3:name>
<ns3:displayName>Administrator Group</ns3:displayName>
<ns3:isActive>true</ns3:isActive>
<ns3:isMutable>false</ns3:isMutable>
<ns3:isVisible>true</ns3:isVisible>
<ns3:createdTime>2010-04-02T22:44:31Z</ns3:createdTime>
<ns3:scopeId>B74A0FF293331AB2A7E4F21E15D143F3</ns3:scopeId>
<ns3:scopeType>Environment</ns3:scopeType>
<ns3:groupType>Admin</ns3:groupType>
</ns2:roles>
<ns2:roles>
<ns3:id>B7DD994177067F9B6238B08AE6114F2A</ns3:id>
<ns3:name>monitor</ns3:name>
<ns3:displayName>Job Monitor</ns3:displayName>
<ns3:isActive>true</ns3:isActive>
<ns3:isMutable>true</ns3:isMutable>
<ns3:isVisible>true</ns3:isVisible>
<ns3:email>monitor@mycompany.com</ns3:email>
<ns3:createdTime>2010-04-08T16:57:20.765Z</ns3:createdTime>
<ns3:scopeId>B74A0FF293331AB2A7E4F21E15D143F3</ns3:scopeId>
<ns3:scopeType>Environment</ns3:scopeType>
<ns3:groupType>Custom</ns3:groupType>
</ns2:roles>
</ns2:getRolesResponse>
</S:Body>
</S:Envelope>
For each role the following is
returned:
- id
- The ID for the role.
- name
- The name of the role.
- displayName
- tThe name displayed in the WMC for the role.
- isActive
- True or false depending on whether the role is active.
- isMutable
- True or false. True means that the object can be updated.
- isVisible
- True or false. True means that the object is visible in the WMC.
- The email address for the role.
- createdTime
- The date and time the role was created. The time is compliant with ISO 8601.
- scopeId
- The ID of the scope where the role is found. (Cloud only.)
- scopeType
- The type of scope, either tenant or environment. (Cloud only.)
- groupType
- The type of group to which the role belongs.