TeamMemberships

Preview Users that would belong to the specified Team

Lists all the Users that would belong to the specified Team, including information about whether they are directly assigned and/or indirectly assigned via external security groups.

post/teammembership/previewteam

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/teammembership/previewteam
  • 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
Idstring
MemberUserIdsstring[] required

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

The requested Preview of Team Membership

IsDirectlyAssignedboolean
SpaceIdstring
TeamIdstring
TeamNamestring
UserIdstring

Example response

[
  {
    "SpaceId": "Spaces-1",
    "TeamId": "Teams-1",
    "UserId": "Users-1"
  }
]

Changes

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