Invitations

Create an invitation to allow a new person to join this Octopus instance

post/users/invitations

Request

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

AddToTeamIdsstring[] required

The teams the user will be invited to join

SpaceIdstring

The ID of the space to create the invitation in.

Example request

{
  "AddToTeamIds": [
    "Teams-1",
    "..."
  ],
  "SpaceId": "Spaces-1"
}

Response

Created

AddToTeamIdsstring[] required
Expiresstring date-time required
Idstring

Gets or sets a unique identifier for this resource.

InvitationCodestring required
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.

SpaceIdstring

Example response

{
  "Id": "Invitations-1",
  "Links": {
    "Self": "/api/..."
  },
  "SpaceId": "Spaces-1"
}

Changes

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