getRoleById
Gets the specified role.
Applies to Clouds and Integration Appliances.
Parameter:
- id
- The specified ID for the role that you want returned.
- Returns:
- The role for the specified ID.
Examples:
The following example is a SOAP
request to get a role by the ID of the role.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:sec="http://www.approuter.com/
schemas/2008/1/security">
<soapenv:Header>
<sec:sessionId>A85C21BB99E816D48800C90B2C5547D4</sec:sessionId>
</soapenv:Header>
<soapenv:Body>
<sec:getRoleById>
<sec:id>8F52644BBA2491693D440F2FA12A4B3D</sec:id>
</sec:getRoleById>
</soapenv:Body>
</soapenv:Envelope>
The following example is
a SOAP response to the request.
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getRoleByIdResponse xmlns:ns2="http://www.approuter.com/
schemas/2008/1/security"
xmlns:ns3="http://www.approuter.com/schema/
router/1000/security/03">
<ns2:group>
<ns3:id>8F52644BBA2491693D440F2FA12A4B3D</ns3:id>
<ns3:name>securitymonitor</ns3:name>
<ns3:displayName>monitor</ns3:displayName>
<ns3:isActive>true</ns3:isActive>
<ns3:isMutable>true</ns3:isMutable>
<ns3:isVisible>true</ns3:isVisible>
<ns3:email>security@mycompany.com</ns3:email>
<ns3:createdTime>2010-03-23T19:14:30.066Z</ns3:createdTime>
<ns3:scopeId>A6EFAF24DB7168A4206F605CA6E14B1D</ns3:scopeId>
<ns3:scopeType>Tenant</ns3:scopeType>
<ns3:groupType>Custom</ns3:groupType>
</ns2:group>
</ns2:getRoleByIdResponse>
</S:Body>
</S:Envelope>
For each role the following information
is returned:
- id
- The ID for the role.
- name
- The name of the role.
- displayName
- The 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.