Path parameters

• organization_id string Required

  Identifier for the Organization

Responses

• 201

  Organization invitations created successfully

  Hide response attribute Show response attribute object

  • invitations array[object] Required

    The list of organization invitations

    Hide invitations attributes Show invitations attributes object

    • token string Required

      The token used to accept the invitation

    • email string Required

      The email address to invite to the organization

    • created_at string(date-time) Required

      The date and time when the invitation was created

    • expires_at string(date-time) Required

      The date and time when the invitation expires

    • expired boolean Required

      True if the invitation is expired

    • accepted_at string(date-time)

      The date and time when the invitation was accepted

    • organization object Required

      An organization

      Additional properties are allowed.

      Hide organization attributes Show organization attributes object

      • id string Required

        The organization's identifier

      • name string Required

        The organization's friendly name

      • default_disk_usage_alerts_enabled boolean

        Whether the default disk alerts are enabled

      • notifications_allowed_email_domains array[string]

        The list of allowed domains for notification-email recipients

      • billing_contacts array[string]

        The list of contacts for billing notifications, if specified

      • operational_contacts array[string]

        The list of contacts for operational notifications, if specified

      • sso_login_identifier string

        The login identifier for initiating SSO

    • role_assignments object

      The roles that will be assigned to users once they accept the invitation. Currently unavailable in self-hosted ECE.

      Additional properties are allowed.

      Hide role_assignments attributes Show role_assignments attributes object

      • platform array[object]

        Assignments for roles with platform scope.

        Hide platform attribute Show platform attribute object

        • role_id string Required

          The ID of the role that is assigned.

      • organization array[object]

        Assignments for roles with organization scope.

        Hide organization attributes Show organization attributes object

        • role_id string Required

          The ID of the role that is assigned.

        • organization_id string Required

          The ID of the organization the role is scoped to.

      • deployment array[object]

        Assignments for roles with deployment scope.

        Hide deployment attributes Show deployment attributes object

        • role_id string Required

          The ID of the role that is assigned.

        • organization_id string Required

          The ID of the organization the role is scoped to.

        • all boolean

          When true, the role applies to all deployments in the organization, otherwise the role is scoped to the deployments specified in deployment_ids.

        • deployment_ids array[string]

          The IDs of the deployments the role is scoped to. Must be absent if all is true, and present if all is false.

        • application_roles array[string]

          If provided, the user assigned this role assignment will be granted this application role when signing in to the deployment(s) specified in the role assignment.

      • project object

        Assignments for roles with project scope.

        Additional properties are allowed.

        Hide project attributes Show project attributes object

        • elasticsearch array[object]

          The Elasticsearch project-scoped role assignments to set

          Hide elasticsearch attributes Show elasticsearch attributes object

          • role_id string Required

            The ID of the role that is assigned.

          • organization_id string Required

            The ID of the organization the role is scoped to.

          • all boolean

            When true, the role applies to all projects in the organization, otherwise the role is scoped to the projects specified in project_ids.

          • project_ids array[string]

            The IDs of the projects the role is scoped to. Must be absent if all is true, and present if all is false.

          • application_roles array[string]

            If provided, the user assigned this role assignment will be granted this application role when signing in to the project(s) specified in the role assignment.

        • observability array[object]

          The Observability project-scoped role assignments to set

          Hide observability attributes Show observability attributes object

          • role_id string Required

            The ID of the role that is assigned.

          • organization_id string Required

            The ID of the organization the role is scoped to.

          • all boolean

            When true, the role applies to all projects in the organization, otherwise the role is scoped to the projects specified in project_ids.

          • project_ids array[string]

            The IDs of the projects the role is scoped to. Must be absent if all is true, and present if all is false.

          • application_roles array[string]

            If provided, the user assigned this role assignment will be granted this application role when signing in to the project(s) specified in the role assignment.

        • security array[object]

          The Security project-scoped role assignments to set

          Hide security attributes Show security attributes object

          • role_id string Required

            The ID of the role that is assigned.

          • organization_id string Required

            The ID of the organization the role is scoped to.

          • all boolean

            When true, the role applies to all projects in the organization, otherwise the role is scoped to the projects specified in project_ids.

          • project_ids array[string]

            The IDs of the projects the role is scoped to. Must be absent if all is true, and present if all is false.

          • application_roles array[string]

            If provided, the user assigned this role assignment will be granted this application role when signing in to the project(s) specified in the role assignment.

• 400
  • Invitation email was not valid. (code: organization.invitation_invalid_email)
  • Invitation already sent. (code: organization.invitation_already_exists)
  • User already belongs to organization. (code: organization.user_organization_already_belongs)
  Hide headers attribute Show headers attribute

  • x-cloud-error-codes string

    The error codes associated with the response

    Values are organization.invitation_invalid_email, organization.invitation_already_exists, or organization.user_organization_already_belongs.

  Hide response attribute Show response attribute object

  • errors array[object] Required

    A list of errors that occurred in the failing request

    Hide errors attributes Show errors attributes object

    • code string Required

      A structured code representing the error type that occurred

    • message string Required

      A human readable message describing the error that occurred

    • fields array[string]

      If the error can be tied to a specific field or fields in the user request, this lists those fields

• 403

  The current user authentication is not valid. (code: root.invalid_authentication)

  Hide headers attribute Show headers attribute

  • x-cloud-error-codes string

    The error codes associated with the response

    Value is root.invalid_authentication.

  Hide response attribute Show response attribute object

  • errors array[object] Required

    A list of errors that occurred in the failing request

    Hide errors attributes Show errors attributes object

    • code string Required

      A structured code representing the error type that occurred

    • message string Required

      A human readable message describing the error that occurred

    • fields array[string]

      If the error can be tied to a specific field or fields in the user request, this lists those fields

• 404
  • Organization not found. (code: organization.not_found)
  • User not found. (code: user.not_found)
  • Invitation sender does not belong to organization. (code: organization.user_organization_does_not_belong)
  Hide headers attribute Show headers attribute

  • x-cloud-error-codes string

    The error codes associated with the response

    Values are organization.not_found, user.not_found, or organization.user_organization_does_not_belong.

  Hide response attribute Show response attribute object

  • errors array[object] Required

    A list of errors that occurred in the failing request

    Hide errors attributes Show errors attributes object

    • code string Required

      A structured code representing the error type that occurred

    • message string Required

      A human readable message describing the error that occurred

    • fields array[string]

      If the error can be tied to a specific field or fields in the user request, this lists those fields

• 429

  Request exceeds organization invitation creation rate limits. (code: organization.invitations_rate_limit_exceeded)

  Hide headers attribute Show headers attribute

  • x-cloud-error-codes string

    The error codes associated with the response

    Value is organization.invitations_rate_limit_exceeded.

  Hide response attribute Show response attribute object

  • errors array[object] Required

    A list of errors that occurred in the failing request

    Hide errors attributes Show errors attributes object

    • code string Required

      A structured code representing the error type that occurred

    • message string Required

      A human readable message describing the error that occurred

    • fields array[string]

      If the error can be tied to a specific field or fields in the user request, this lists those fields