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

• 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