Atlassian · Schema

InviteUsersRequest

Request body for inviting users to the organization.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name	Type	Description
emails	array	Email addresses of users to invite.
directoryId	string	The directory to add the invited users to.
groupIds	array	Groups to assign the invited users to.
roleAssignments	array	Application roles to assign to the invited users.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/InviteUsersRequest",
  "title": "InviteUsersRequest",
  "type": "object",
  "description": "Request body for inviting users to the organization.",
  "properties": {
    "emails": {
      "type": "array",
      "description": "Email addresses of users to invite.",
      "items": {
        "type": "string",
        "format": "email"
      },
      "example": "[email protected]"
    },
    "directoryId": {
      "type": "string",
      "description": "The directory to add the invited users to.",
      "example": "500123"
    },
    "groupIds": {
      "type": "array",
      "description": "Groups to assign the invited users to.",
      "items": {
        "type": "string"
      },
      "example": []
    },
    "roleAssignments": {
      "type": "array",
      "description": "Application roles to assign to the invited users.",
      "items": {
        "type": "object",
        "properties": {
          "role": {
            "type": "string"
          },
          "resource": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "type": {
                "type": "string"
              }
            }
          }
        }
      },
      "example": []
    }
  }
}