Auth

Redeem an organization invitation token to join an organization

post/api/v1/auth/organization-invitation/redeem

Request

  • Base URL: https://api-sandbox.koywe.com
  • URL: https://api-sandbox.koywe.com/api/v1/auth/organization-invitation/redeem
  • Auth: none declared

Request body

tokenstring required

The unique invitation token received by the user

Example request

{
  "token": "7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b"
}

Response

Organization invitation redeemed successfully. Roles assigned.

successboolean
messagestring
grantedRolesstring[]

Example response

{
  "success": true,
  "message": "Successfully joined organization My Organization",
  "organization": {
    "id": "org3_xxxxxxxxxxxxxx",
    "name": "My Organization"
  },
  "grantedRoles": [
    "k3r_user_org_inviter",
    "k3r_user_org_viewer",
    "k3r_user_org_manager"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.