v1

latestSwagger 2.02026-08-061,9128853.7 MB
UserRoles

Get a list of User Roles.

Lists all of the User Roles in the current Octopus Deploy instance. The results will be sorted alphabetically by name.

get/userroles

Query parameters

idsstring[]

A list of User Role IDs, to limit the result to those with a particular ID. Example: ["UserRoles-1", "UserRoles-2"]

partialNamestring

A partial name, to limit the result to those with a name that includes the partial name

skipinteger

Number of items to skip. Defaults to zero

takeinteger

Number of items to take. Defaults to 30

Response

Request list of user roles.

Idstring
ItemsPerPageinteger
ItemTypestring
LastModifiedBystring
LastModifiedOnstring date-time
LastPageNumberinteger
Linksobject
NumberOfPagesinteger
TotalResultsinteger