Users

Get a list of Users.

Lists all the Users in the System. The results will be sorted alphabetically by Username.

get/users/all

Request

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

Response

A list of all the users

CanPasswordBeEditedboolean
Createdstring date-time
DisplayNamestring required
EmailAddressstring email
Idstring

Gets or sets a unique identifier for this resource.

IsActiveboolean
IsRequestorboolean

Gets or sets a value indicating whether this user resource represents the user who requested it.

IsServiceboolean
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.

Linksobject

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

Passwordstring
ServiceAccountType'Standard' | 'Agent'
Usernamestring

Example response

[
  {
    "Links": {
      "Self": "/api/..."
    }
  }
]

Changes

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