Teams

Create a new team

post/teams

Request

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

Request body

Descriptionstring

The description for the team.

MemberUserIdsstring[] required

The users who will belong to the team.

Namestring required

The name of the team.

Slugstring

The slug of the team.

SpaceIdstring

The space in which to create the team.

Example request

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

Response

Created

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.