Users

Modify an existing user.

put/users/{id}

Request

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

Path parameters

idstring required

Request body

DisplayNamestring required
EmailAddressstring
Idstring required
IsActiveboolean required
Passwordstring
Usernamestring required

Example request

{
  "Id": "Users-1"
}

Response

The updated user

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.