Skip to main content
POST
/
organizations
/
{organization_id}
/
invitations
Create organization invitations
curl --request POST \
  --url https://api.elastic-cloud.com/api/v1/organizations/{organization_id}/invitations \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "emails": [
    "<string>",
    "<string>"
  ],
  "expires_in": "<string>",
  "role_assignments": {
    "deployment": [
      {
        "all": "<boolean>",
        "application_roles": [
          "<string>",
          "<string>"
        ],
        "deployment_ids": [
          "<string>",
          "<string>"
        ],
        "organization_id": "<string>",
        "role_id": "<string>"
      },
      {
        "all": "<boolean>",
        "application_roles": [
          "<string>",
          "<string>"
        ],
        "deployment_ids": [
          "<string>",
          "<string>"
        ],
        "organization_id": "<string>",
        "role_id": "<string>"
      }
    ],
    "organization": [
      {
        "organization_id": "<string>",
        "role_id": "<string>"
      },
      {
        "organization_id": "<string>",
        "role_id": "<string>"
      }
    ],
    "platform": [
      {
        "role_id": "<string>"
      },
      {
        "role_id": "<string>"
      }
    ],
    "project": {
      "elasticsearch": [
        {
          "all": "<boolean>",
          "application_roles": [
            "<string>",
            "<string>"
          ],
          "organization_id": "<string>",
          "project_ids": [
            "<string>",
            "<string>"
          ],
          "role_id": "<string>"
        },
        {
          "all": "<boolean>",
          "application_roles": [
            "<string>",
            "<string>"
          ],
          "organization_id": "<string>",
          "project_ids": [
            "<string>",
            "<string>"
          ],
          "role_id": "<string>"
        }
      ],
      "observability": [
        {
          "all": "<boolean>",
          "application_roles": [
            "<string>",
            "<string>"
          ],
          "organization_id": "<string>",
          "project_ids": [
            "<string>",
            "<string>"
          ],
          "role_id": "<string>"
        },
        {
          "all": "<boolean>",
          "application_roles": [
            "<string>",
            "<string>"
          ],
          "organization_id": "<string>",
          "project_ids": [
            "<string>",
            "<string>"
          ],
          "role_id": "<string>"
        }
      ],
      "security": [
        {
          "all": "<boolean>",
          "application_roles": [
            "<string>",
            "<string>"
          ],
          "organization_id": "<string>",
          "project_ids": [
            "<string>",
            "<string>"
          ],
          "role_id": "<string>"
        },
        {
          "all": "<boolean>",
          "application_roles": [
            "<string>",
            "<string>"
          ],
          "organization_id": "<string>",
          "project_ids": [
            "<string>",
            "<string>"
          ],
          "role_id": "<string>"
        }
      ]
    }
  }
}'
{
  "invitations": [
    {
      "accepted_at": "<dateTime>",
      "created_at": "<dateTime>",
      "email": "<string>",
      "expired": "<boolean>",
      "expires_at": "<dateTime>",
      "organization": {
        "billing_contacts": [
          "<string>",
          "<string>"
        ],
        "default_disk_usage_alerts_enabled": "<boolean>",
        "id": "<string>",
        "name": "<string>",
        "notifications_allowed_email_domains": [
          "<string>",
          "<string>"
        ],
        "operational_contacts": [
          "<string>",
          "<string>"
        ]
      },
      "role_assignments": {
        "deployment": [
          {
            "all": "<boolean>",
            "application_roles": [
              "<string>",
              "<string>"
            ],
            "deployment_ids": [
              "<string>",
              "<string>"
            ],
            "organization_id": "<string>",
            "role_id": "<string>"
          },
          {
            "all": "<boolean>",
            "application_roles": [
              "<string>",
              "<string>"
            ],
            "deployment_ids": [
              "<string>",
              "<string>"
            ],
            "organization_id": "<string>",
            "role_id": "<string>"
          }
        ],
        "organization": [
          {
            "organization_id": "<string>",
            "role_id": "<string>"
          },
          {
            "organization_id": "<string>",
            "role_id": "<string>"
          }
        ],
        "platform": [
          {
            "role_id": "<string>"
          },
          {
            "role_id": "<string>"
          }
        ],
        "project": {
          "elasticsearch": [
            {
              "all": "<boolean>",
              "application_roles": [
                "<string>",
                "<string>"
              ],
              "organization_id": "<string>",
              "project_ids": [
                "<string>",
                "<string>"
              ],
              "role_id": "<string>"
            },
            {
              "all": "<boolean>",
              "application_roles": [
                "<string>",
                "<string>"
              ],
              "organization_id": "<string>",
              "project_ids": [
                "<string>",
                "<string>"
              ],
              "role_id": "<string>"
            }
          ],
          "observability": [
            {
              "all": "<boolean>",
              "application_roles": [
                "<string>",
                "<string>"
              ],
              "organization_id": "<string>",
              "project_ids": [
                "<string>",
                "<string>"
              ],
              "role_id": "<string>"
            },
            {
              "all": "<boolean>",
              "application_roles": [
                "<string>",
                "<string>"
              ],
              "organization_id": "<string>",
              "project_ids": [
                "<string>",
                "<string>"
              ],
              "role_id": "<string>"
            }
          ],
          "security": [
            {
              "all": "<boolean>",
              "application_roles": [
                "<string>",
                "<string>"
              ],
              "organization_id": "<string>",
              "project_ids": [
                "<string>",
                "<string>"
              ],
              "role_id": "<string>"
            },
            {
              "all": "<boolean>",
              "application_roles": [
                "<string>",
                "<string>"
              ],
              "organization_id": "<string>",
              "project_ids": [
                "<string>",
                "<string>"
              ],
              "role_id": "<string>"
            }
          ]
        }
      },
      "token": "<string>"
    },
    {
      "accepted_at": "<dateTime>",
      "created_at": "<dateTime>",
      "email": "<string>",
      "expired": "<boolean>",
      "expires_at": "<dateTime>",
      "organization": {
        "billing_contacts": [
          "<string>",
          "<string>"
        ],
        "default_disk_usage_alerts_enabled": "<boolean>",
        "id": "<string>",
        "name": "<string>",
        "notifications_allowed_email_domains": [
          "<string>",
          "<string>"
        ],
        "operational_contacts": [
          "<string>",
          "<string>"
        ]
      },
      "role_assignments": {
        "deployment": [
          {
            "all": "<boolean>",
            "application_roles": [
              "<string>",
              "<string>"
            ],
            "deployment_ids": [
              "<string>",
              "<string>"
            ],
            "organization_id": "<string>",
            "role_id": "<string>"
          },
          {
            "all": "<boolean>",
            "application_roles": [
              "<string>",
              "<string>"
            ],
            "deployment_ids": [
              "<string>",
              "<string>"
            ],
            "organization_id": "<string>",
            "role_id": "<string>"
          }
        ],
        "organization": [
          {
            "organization_id": "<string>",
            "role_id": "<string>"
          },
          {
            "organization_id": "<string>",
            "role_id": "<string>"
          }
        ],
        "platform": [
          {
            "role_id": "<string>"
          },
          {
            "role_id": "<string>"
          }
        ],
        "project": {
          "elasticsearch": [
            {
              "all": "<boolean>",
              "application_roles": [
                "<string>",
                "<string>"
              ],
              "organization_id": "<string>",
              "project_ids": [
                "<string>",
                "<string>"
              ],
              "role_id": "<string>"
            },
            {
              "all": "<boolean>",
              "application_roles": [
                "<string>",
                "<string>"
              ],
              "organization_id": "<string>",
              "project_ids": [
                "<string>",
                "<string>"
              ],
              "role_id": "<string>"
            }
          ],
          "observability": [
            {
              "all": "<boolean>",
              "application_roles": [
                "<string>",
                "<string>"
              ],
              "organization_id": "<string>",
              "project_ids": [
                "<string>",
                "<string>"
              ],
              "role_id": "<string>"
            },
            {
              "all": "<boolean>",
              "application_roles": [
                "<string>",
                "<string>"
              ],
              "organization_id": "<string>",
              "project_ids": [
                "<string>",
                "<string>"
              ],
              "role_id": "<string>"
            }
          ],
          "security": [
            {
              "all": "<boolean>",
              "application_roles": [
                "<string>",
                "<string>"
              ],
              "organization_id": "<string>",
              "project_ids": [
                "<string>",
                "<string>"
              ],
              "role_id": "<string>"
            },
            {
              "all": "<boolean>",
              "application_roles": [
                "<string>",
                "<string>"
              ],
              "organization_id": "<string>",
              "project_ids": [
                "<string>",
                "<string>"
              ],
              "role_id": "<string>"
            }
          ]
        }
      },
      "token": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
organization_id
string
required

(Required) Identifier for the Organization

Example:

"<string>"

Body

application/json
​
emails
string[]
Example:
["<string>", "<string>"]
​
expires_in
string
Example:

"<string>"

​
role_assignments
object

Response

Organization invitations created successfully

​
invitations
object[]
Example:
[
  {
    "accepted_at": "<dateTime>",
    "created_at": "<dateTime>",
    "email": "<string>",
    "expired": "<boolean>",
    "expires_at": "<dateTime>",
    "organization": {
      "billing_contacts": ["<string>", "<string>"],
      "default_disk_usage_alerts_enabled": "<boolean>",
      "id": "<string>",
      "name": "<string>",
      "notifications_allowed_email_domains": ["<string>", "<string>"],
      "operational_contacts": ["<string>", "<string>"]
    },
    "role_assignments": {
      "deployment": [
        {
          "all": "<boolean>",
          "application_roles": ["<string>", "<string>"],
          "deployment_ids": ["<string>", "<string>"],
          "organization_id": "<string>",
          "role_id": "<string>"
        },
        {
          "all": "<boolean>",
          "application_roles": ["<string>", "<string>"],
          "deployment_ids": ["<string>", "<string>"],
          "organization_id": "<string>",
          "role_id": "<string>"
        }
      ],
      "organization": [
        {
          "organization_id": "<string>",
          "role_id": "<string>"
        },
        {
          "organization_id": "<string>",
          "role_id": "<string>"
        }
      ],
      "platform": [
        { "role_id": "<string>" },
        { "role_id": "<string>" }
      ],
      "project": {
        "elasticsearch": [
          {
            "all": "<boolean>",
            "application_roles": ["<string>", "<string>"],
            "organization_id": "<string>",
            "project_ids": ["<string>", "<string>"],
            "role_id": "<string>"
          },
          {
            "all": "<boolean>",
            "application_roles": ["<string>", "<string>"],
            "organization_id": "<string>",
            "project_ids": ["<string>", "<string>"],
            "role_id": "<string>"
          }
        ],
        "observability": [
          {
            "all": "<boolean>",
            "application_roles": ["<string>", "<string>"],
            "organization_id": "<string>",
            "project_ids": ["<string>", "<string>"],
            "role_id": "<string>"
          },
          {
            "all": "<boolean>",
            "application_roles": ["<string>", "<string>"],
            "organization_id": "<string>",
            "project_ids": ["<string>", "<string>"],
            "role_id": "<string>"
          }
        ],
        "security": [
          {
            "all": "<boolean>",
            "application_roles": ["<string>", "<string>"],
            "organization_id": "<string>",
            "project_ids": ["<string>", "<string>"],
            "role_id": "<string>"
          },
          {
            "all": "<boolean>",
            "application_roles": ["<string>", "<string>"],
            "organization_id": "<string>",
            "project_ids": ["<string>", "<string>"],
            "role_id": "<string>"
          }
        ]
      }
    },
    "token": "<string>"
  },
  {
    "accepted_at": "<dateTime>",
    "created_at": "<dateTime>",
    "email": "<string>",
    "expired": "<boolean>",
    "expires_at": "<dateTime>",
    "organization": {
      "billing_contacts": ["<string>", "<string>"],
      "default_disk_usage_alerts_enabled": "<boolean>",
      "id": "<string>",
      "name": "<string>",
      "notifications_allowed_email_domains": ["<string>", "<string>"],
      "operational_contacts": ["<string>", "<string>"]
    },
    "role_assignments": {
      "deployment": [
        {
          "all": "<boolean>",
          "application_roles": ["<string>", "<string>"],
          "deployment_ids": ["<string>", "<string>"],
          "organization_id": "<string>",
          "role_id": "<string>"
        },
        {
          "all": "<boolean>",
          "application_roles": ["<string>", "<string>"],
          "deployment_ids": ["<string>", "<string>"],
          "organization_id": "<string>",
          "role_id": "<string>"
        }
      ],
      "organization": [
        {
          "organization_id": "<string>",
          "role_id": "<string>"
        },
        {
          "organization_id": "<string>",
          "role_id": "<string>"
        }
      ],
      "platform": [
        { "role_id": "<string>" },
        { "role_id": "<string>" }
      ],
      "project": {
        "elasticsearch": [
          {
            "all": "<boolean>",
            "application_roles": ["<string>", "<string>"],
            "organization_id": "<string>",
            "project_ids": ["<string>", "<string>"],
            "role_id": "<string>"
          },
          {
            "all": "<boolean>",
            "application_roles": ["<string>", "<string>"],
            "organization_id": "<string>",
            "project_ids": ["<string>", "<string>"],
            "role_id": "<string>"
          }
        ],
        "observability": [
          {
            "all": "<boolean>",
            "application_roles": ["<string>", "<string>"],
            "organization_id": "<string>",
            "project_ids": ["<string>", "<string>"],
            "role_id": "<string>"
          },
          {
            "all": "<boolean>",
            "application_roles": ["<string>", "<string>"],
            "organization_id": "<string>",
            "project_ids": ["<string>", "<string>"],
            "role_id": "<string>"
          }
        ],
        "security": [
          {
            "all": "<boolean>",
            "application_roles": ["<string>", "<string>"],
            "organization_id": "<string>",
            "project_ids": ["<string>", "<string>"],
            "role_id": "<string>"
          },
          {
            "all": "<boolean>",
            "application_roles": ["<string>", "<string>"],
            "organization_id": "<string>",
            "project_ids": ["<string>", "<string>"],
            "role_id": "<string>"
          }
        ]
      }
    },
    "token": "<string>"
  }
]
⌘I