SelectRoles
Searches roles for specified information.
To search a single role, specify Name or Id. To search a list of roles, specify NameList or IdList. To search roles matching the specified conditions, specify Search.
Request elements
ResultDef
ArrayOfString. The properties to retrieve.
Search
RoleSearch. The search conditions. If conditions apply to multiple fields, use ConditionArray. When using RSSE external registration, SelectRoles allows only one search condition within the Search element.
In the following example, <Condition> and <AssignedToUserName> are search conditions:
<Search>
<Condition>
<Field>Name</Field>
<Match>roleA</Match>
</Condition>
<ConditionArray xsi:nil="true"/>
<ParentRoleName xsi:nil="true"/>
<ChildRoleName xsi:nil="true"/>
<WithRightsToChannelName xsi:nil="true"/>
<AssignedToUserName>Administrator</AssignedToUserName>
<ParentRoleId xsi:nil="true"/>
<ChildRoleId xsi:nil="true"/>
<WithRightsToChannelId xsi:nil="true"/>
<AssignedToUserId xsi:nil="true"/>
</Search>
When using RSSE external registration, the previous search pattern is invalid, generating the following response:
<Description>
<Message>The search pattern is too long or is incorrect.
</Message>
<Parameter1>More than one search condition is invalid under
External Registration</Parameter1>
</Description>
IdList
ArrayOfString. The list of role IDs to search. Specify either IdList or NameList.
NameList
ArrayOfString. The list of role names to search. Specify either NameList or IdList.
Id
String. The ID of the single role to search. Specify either Id or Name.
Name
String. The name of the single role to search. Specify either Name or Id.
Response elements
Roles
ArrayOfRole. The selected roles.
FetchHandle
String. Indicates that the number of items in the result set exceeds the FetchSize limit.
TotalCount
Long. The number of entries in the search result set.