getRole
Gets the specified role.
Applies to Clouds and Integration Appliances.
Parameter:
- role
- The specified role to return.
- Returns:
- The specified role
Examples:
The following example is a SOAP
request to get a 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>BC77BA76E338CFA6B0063218A0AE4656</sec:sessionId>
</soapenv:Header>
<soapenv:Body>
<sec:getRole>
<sec:name>publisher@A347B0C49C8CFA462D4F28A4C05B47C2</sec:name>
</sec:getRole>
</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:getRoleResponse 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>903273B869AC8CA9D99F4C8448694680</ns3:id>
<ns3:name>publisher@A347B0C49C8CFA462D4F28A4C05B47C2</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-10T00:08:23Z</ns3:createdTime>
<ns3:scopeId>A347B0C49C8CFA462D4F28A4C05B47C2</ns3:scopeId>
<ns3:scopeType>Environment</ns3:scopeType>
<ns3:groupType>Publisher</ns3:groupType>
</ns2:group>
</ns2:getRoleResponse>
</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. If you create your own group, it is a custom group. For information about the built-in groups, see .