Accept an organization invitation

POST /organizations/invitations/{invitation_token}/_accept

Accepts an organization invitation. Currently unavailable in self-hosted ECE.

Path parameters

Responses

  • 200

    Organization invitation accepted successfully

    Additional properties are allowed.
  • 400

    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

      Value is 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 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

      Values are organization.not_found, user.not_found, or 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
POST /organizations/invitations/{invitation_token}/_accept 
curl \
 -X POST https://{{hostname}}/api/v1/organizations/invitations/{invitation_token}/_accept
Response examples (200) 
{}
Response examples (400) 
# Headers
x-cloud-error-codes: organization.user_organization_already_belongs

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}
Response examples (403) 
# Headers
x-cloud-error-codes: root.invalid_authentication

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}
Response examples (404) 
# Headers
x-cloud-error-codes: organization.not_found

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}