Teams

Modify an existing Team

The Everyone Team is treated as a special case and its members and external groups may not be changed.

put/spaces/{spaceIdentifier}/teams/{id}

Request

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

spaceIdentifierstring required

Identifier (ID or slug) of the space

idstring required

Gets or sets a unique identifier for this resource.

Request body

Descriptionstring
Idstring required

Gets or sets a unique identifier for this resource.

MemberUserIdsstring[]

The users who belong to the team.

Namestring required

Gets or sets the name of this team.

Slugstring
SpaceIdstring

Example request

{
  "Id": "Teams-1",
  "MemberUserIds": [
    "Users-1",
    "..."
  ],
  "SpaceId": "Spaces-1"
}

Response

Indicates the team was modified, containing the updated Team

CanBeDeletedboolean

Gets or sets a flag indicating whether the team can be deleted. The built-in teams provided by Octopus generally cannot be deleted.

CanBeRenamedboolean

Gets or sets a flag indicating whether the team can be renamed. The built-in teams provided by Octopus generally cannot be renamed.

CanChangeMembersboolean

Gets or sets a flag indicating whether the members of this team can be changed. The built-in Everyone team provided by Octopus cannot have its members changed, as it will always contain all users.

CanChangeRolesboolean

Gets or sets a flag indicating whether the team's roles can be changed. The built-in Octopus Administrators team provided by Octopus cannot have its roles modified; all other teams can.

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

MemberUserIdsstring[]

The users who belong to the team.

Namestring

Gets or sets the name of this team.

Slugstring
SpaceIdstring

Example response

{
  "Links": {
    "Self": "/api/..."
  },
  "MemberUserIds": [
    "Users-1",
    "..."
  ],
  "SpaceId": "Spaces-1"
}

Changes

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