Organization Users Update user role in organization
PATCH
/control-plane/api/v1/v1/organization/{organization_id}/user/{user_id}/role

Authentication

API Key (BearerAuth)

  • Header: Authorization

Path Parameters

organization_idstringrequired

Organization ID


user_idstringrequired

User ID


Request Body

Update role input

Required

rolestringrequired

Example:

{
  "role": "string"
}

Responses

200
OK

Response Fields:

  • created_at (string)

  • documentation_ids (string[])

  • email (string)

  • id (string)

  • invited_at (string)

  • invited_by (string)

  • joined_at (string)

  • name (string)

  • organization_id (string)

  • profile_picture_url (string)

  • role (string)

  • status (string)

  • updated_at (string)

  • user_id (string)

Example:

{
  "created_at": "string",
  "documentation_ids": [
    "string"
  ],
  "email": "string",
  "id": "string",
  "invited_at": "string",
  "invited_by": "string",
  "joined_at": "string",
  "name": "string",
  "organization_id": "string",
  "profile_picture_url": "string",
  "role": "admin",
  "status": "pending",
  "updated_at": "string",
  "user_id": "string"
}
400
Bad Request

Example:

{
  "key": "value"
}
403
Forbidden

Example:

{
  "key": "value"
}
500
Internal Server Error

Example:

{
  "key": "value"
}