Kaiten API

KaitenDevelopers

rest external webhooks webhooks scim user metadata imports addons

Change user role and notification settings

PATCH

https://example.kaiten.ru/api/latest/spaces/{space_id}/users/{id}

Path parameters

Name	Type	Reference
space_idrequired	integer	Space ID
idrequired	integer	User ID

Headers

Name	Value
Content-Type	application/json

Attributes

schema

{
 "$schema": "http://json-schema.org/draft-06/schema",
 "type": "object",
 "properties": {
  "role_id": {
   "type": "string",
   "description": "Role id. Preset roles :\n reader - '06ccb31f-426b-4fa3-b7e5-861daee95696',\n writer - 'a431ed00-1b32-4cc7-92b6-85e4bc7de40e',\n admin - '07ea3efc-a004-4d31-8683-4bb2084e209b'"
  },
  "notifications_enabled": {
   "type": "boolean",
   "description": "Enabled or disable notifications for space events"
  },
  "space_group_id": {
   "oneOf": [
    {
     "type": "number"
    },
    {
     "type": "null"
    }
   ],
   "description": "Space group id"
  },
  "settings": {
   "type": "object",
   "description": "Space user settings"
  }
 },
 "anyOf": [
  {
   "required": [
    "role_id"
   ]
  },
  {
   "required": [
    "space_group_id"
   ]
  }
 ]
}

Name	Type	Description
role_id	string	Role id. Preset roles : reader - '06ccb31f-426b-4fa3-b7e5-861daee95696', writer - 'a431ed00-1b32-4cc7-92b6-85e4bc7de40e', admin - '07ea3efc-a004-4d31-8683-4bb2084e209b'
notifications_enabled	boolean	Enabled or disable notifications for space events
space_group_id	number \| null	Space group id
settings	object	Space user settings

Responses

200

Description	Response type	Example
Success	Object	Open

Response Attributes

Name	Type	Description
entity_uid	string	Entity uid
access_mod	string	Access modifier with inheritable access modifiers
own_access_mod	string	Own access modifier
own_role_ids	array	User role ids
id	integer	User id
user_id	integer	User id

400

Description	Response type	Example
Validation error	Object	Open

Response Attributes

Name	Type	Description
message	string	Error message

401

Description	Response type	Example
Invalid token	String	Open

A schema has not been defined for this response code.

403

Description	Response type	Example
Forbidden		Response body does not exist

A schema has not been defined for this response code.

404

Description	Response type	Example
Not found		Response body does not exist

A schema has not been defined for this response code.

Kaiten

Addons terms of use Personal data processing policy

If you have any questions or need help with integration feel free to write us at support@kaiten.io

Company domain

Path Parameters

space_id

Raw Body(json format)

  1  curl --request PATCH \
  2       --url 'https://example.kaiten.ru/api/latest/spaces/{space_id}/users/{id}' \
  3       --header 'Accept: application/json' \
  4       --header 'Content-Type: application/json'
  5

Response

ClickTry It!to start a request and see the response here!