ReportingService2010.ListRoles Method

Returns the names and descriptions of roles on a report server or a given SharePoint site.

Namespace:  ReportService2010
Assembly:  ReportService2010 (in ReportService2010.dll)

Syntax

'Declaration
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/ListRoles", RequestNamespace := "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer",  _
    ResponseNamespace := "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer",  _
    Use := SoapBindingUse.Literal, ParameterStyle := SoapParameterStyle.Wrapped)> _
<SoapHeaderAttribute("ServerInfoHeaderValue", Direction := SoapHeaderDirection.Out)> _
<SoapHeaderAttribute("TrustedUserHeaderValue")> _
Public Function ListRoles ( _
    SecurityScope As String, _
    SiteUrl As String _
) As Role()
'Usage
Dim instance As ReportingService2010 
Dim SecurityScope As String 
Dim SiteUrl As String 
Dim returnValue As Role()

returnValue = instance.ListRoles(SecurityScope, _
    SiteUrl)

[SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/ListRoles", RequestNamespace = "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    ResponseNamespace = "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)]
[SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)]
[SoapHeaderAttribute("TrustedUserHeaderValue")]
public Role[] ListRoles(
    string SecurityScope,
    string SiteUrl
)

[SoapDocumentMethodAttribute(L"https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/ListRoles", RequestNamespace = L"https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    ResponseNamespace = L"https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    Use = SoapBindingUse::Literal, ParameterStyle = SoapParameterStyle::Wrapped)]
[SoapHeaderAttribute(L"ServerInfoHeaderValue", Direction = SoapHeaderDirection::Out)]
[SoapHeaderAttribute(L"TrustedUserHeaderValue")]
public:
array<Role^>^ ListRoles(
    String^ SecurityScope, 
    String^ SiteUrl
)

[<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/ListRoles", RequestNamespace = "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    ResponseNamespace = "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)>]
[<SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)>]
[<SoapHeaderAttribute("TrustedUserHeaderValue")>]
member ListRoles : 
        SecurityScope:string * 
        SiteUrl:string -> Role[] 

public function ListRoles(
    SecurityScope : String, 
    SiteUrl : String
) : Role[]

Parameters

• SecurityScope
  Type: System.String
  The security scope for the items to return. For valid security scopes, see ListSecurityScopes.

• SiteUrl
  Type: System.String
  The fully qualified URL for the SharePoint site. Set this parameter to nulla null reference (Nothing in Visual Basic) (Nothing in Visual Basic) when invoking this method in Native mode.

Return Value

Type: array<ReportService2010.Role[]
An array of Role objects that contain information about roles for the given site, filtered by the supplied SecurityScope parameter.

Remarks

The table below shows header and permissions information on this operation.

SOAP Header Usage	(In) TrustedUserHeaderValue (Out) ServerInfoHeaderValue
Native Mode Required Permissions	None
SharePoint Mode Required Permissions	None

This method throws an rsUnsupportedParameterForModeException exception if a non-null value is specified for the SiteUrl parameter in Native mode.

See Also

Reference

ReportingService2010 Class

ReportService2010 Namespace