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

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/users
  • Auth
    • API key in header X-Octopus-ApiKey
    • or API key in query parameter ApiKey
    • or API key in header X-NuGet-ApiKey

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

Gets or sets a unique identifier for this resource.

ItemsPerPageinteger
ItemTypestring

The type of item in this list

LastModifiedBystring

Gets or sets the username of the user who last modified this resource.

LastModifiedOnstring date-time

Gets or sets the date/time that this resource was last modified.

LastPageNumberinteger
Linksobject

Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.

NumberOfPagesinteger
TotalResultsinteger

Example response

{
  "Items": [
    {
      "Links": {
        "Self": "/api/..."
      }
    }
  ],
  "ItemsPerPage": 30,
  "ItemType": "User",
  "LastPageNumber": 1,
  "Links": {
    "Self": "/api/..."
  },
  "NumberOfPages": 2,
  "TotalResults": 42
}

Changes

No recorded changes to this operation across all 13 revisions of this API.