Path parameters

• invitation_token string Required

  Organization invitation token

Responses

• 200

  Organization invitation fetched successfully

  Hide response attributes Show response attributes object

  An invitation to an organization

  • 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

    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

  • role_assignments object

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

    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

      Assignment for a role with platform scope.

      • 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

      Assignment for a role with organization scope.

      • 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

      Assignment for a role with deployment scope.

      • 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.

      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

        Assignment for a role with project scope.

        • 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

        Assignment for a role with project scope.

        • 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

        Assignment for a role with project scope.

        • 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.

• 404

  Invitation not found. (code: organization.invitation_not_found)

  Hide headers attribute Show headers attribute

  • x-cloud-error-codes string

    The error codes associated with the response

    Value is organization.invitation_not_found.

  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