v1

latestSwagger 2.02026-08-061,9128853.7 MB
Users

Get a list of Users.

Lists all of the Users in the current Octopus Deploy instance, from all Teams. The results will be sorted alphabetically by username.

get/users

Query parameters

filterstring

Filters the Users by Username/DisplayName/EmailAddress/IdentificationToken using the specified filter fragment

isActiveboolean

A filter to return only active (true) or disabled (false) users. Omit to return both.

isServiceAccountboolean

A filter to return only service account users

serviceAccountType'Standard' | 'Agent'

A filter to return only service accounts of the specified type

skipinteger

Number of items to skip. Defaults to zero

takeinteger

Number of items to take. Defaults to 30

Response

Users that meet the filter conditions

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