Share feedback
Answers are generated based on the documentation.

Schema

bulk_invite

Type: object

invitees

Type: array

A list of invitees
Array item

Type: object

invite

Schema: invite

Invite data if successfully invited
All schema constraints and annotations
{
  "$ref": "#/components/schemas/invite",
  "description": "Invite data if successfully invited"
}
invitee

Type: string

invitee email or Docker ID
All schema constraints and annotations
{
  "description": "invitee email or Docker ID",
  "type": "string"
}
status

Type: string

status of the invite or validation error
All schema constraints and annotations
{
  "description": "status of the invite or validation error",
  "type": "string"
}
All schema constraints and annotations
{
  "properties": {
    "invite": {
      "$ref": "#/components/schemas/invite",
      "description": "Invite data if successfully invited"
    },
    "invitee": {
      "description": "invitee email or Docker ID",
      "type": "string"
    },
    "status": {
      "description": "status of the invite or validation error",
      "type": "string"
    }
  },
  "type": "object"
}
All schema constraints and annotations
{
  "description": "A list of invitees",
  "items": {
    "properties": {
      "invite": {
        "$ref": "#/components/schemas/invite",
        "description": "Invite data if successfully invited"
      },
      "invitee": {
        "description": "invitee email or Docker ID",
        "type": "string"
      },
      "status": {
        "description": "status of the invite or validation error",
        "type": "string"
      }
    },
    "type": "object"
  },
  "type": "array"
}
All schema constraints and annotations
{
  "example": {
    "invitees": [
      {
        "invite": {
          "created_at": "2021-10-28T18:30:19.520861Z",
          "id": "e36eca69-4cc8-4f17-9845-ae8c2b832691",
          "invitee": "invitee@docker.com",
          "inviter_username": "moby",
          "org": "docker",
          "team": "owners"
        },
        "invitee": "invitee@docker.com",
        "status": "invited"
      },
      {
        "invitee": "invitee2@docker.com",
        "status": "existing_org_member"
      },
      {
        "invitee": "invitee3@docker.com",
        "status": "invalid_email_or_docker_id"
      }
    ]
  },
  "properties": {
    "invitees": {
      "description": "A list of invitees",
      "items": {
        "properties": {
          "invite": {
            "$ref": "#/components/schemas/invite",
            "description": "Invite data if successfully invited"
          },
          "invitee": {
            "description": "invitee email or Docker ID",
            "type": "string"
          },
          "status": {
            "description": "status of the invite or validation error",
            "type": "string"
          }
        },
        "type": "object"
      },
      "type": "array"
    }
  },
  "type": "object"
}