PUT api/reportserver/v3/roles/{userRoleId}

Updates the role with the specified ID.

Request Information

URI Parameters

Name	Description	Type	Additional information
userRoleId	The role ID.	string	Required

Body Parameters

UpdateUserRole

Name	Description	Type	Additional information
Name	Specifies the user role name.	string	Required
Description	Specifies the description of the user role.	string	None.
IsSystemRole	Indicates whether the user role is a system role or not.	boolean	None.
UserIds	Returns a list of IDs of users that are assigned to the role.	Collection of string	None.

Request body formats

application/json, text/json, application/*+json

json

{
  "Name": "HR Reports",
  "Description": "A short, descriptive summary shown to users in the Report Server UI.",
  "IsSystemRole": true,
  "UserIds": [
    "0f608f6d44c34964bb0572888a899ae3",
    "d13a2919eab04225905d4d9e5cf213b0"
  ]
}

Response Information

Resource Description

UserRole

Name	Description	Type	Additional information
Id	Specifies the role identifier.	string	Required
Name	Specifies the user role name.	string	Required
Description	Specifies the description of the user role.	string	None.
IsSystemRole	Indicates whether the user role is a system role or not.	boolean	None.
UserIds	Returns a list of IDs of users that are assigned to the role.	Collection of string	None.

Response Formats

application/json

json

{
  "Id": "765b88a28cf",
  "Name": "HR Reports",
  "Description": "A short, descriptive summary shown to users in the Report Server UI.",
  "IsSystemRole": true,
  "UserIds": [
    "0f608f6d44c34964bb0572888a899ae3",
    "d13a2919eab04225905d4d9e5cf213b0"
  ]
}