UserRoles

Modify an existing User Role

put/userroles/{id}

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/userroles/{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

Id of the User Role to modify.

Request body

Descriptionstring
GrantedSpacePermissionsstring[]
GrantedSystemPermissionsstring[]
Idstring required

Id of the User Role to modify.

Namestring

Response

Successful modify operation.

CanBeDeletedboolean
Descriptionstring
GrantedSpacePermissionsstring[]
GrantedSystemPermissionsstring[]
Idstring

Gets or sets a unique identifier for this resource.

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.

Namestring
SpacePermissionDescriptionsstring[]
SupportedRestrictionsstring[]
SystemPermissionDescriptionsstring[]

Example response

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

Changes

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