Kaiten API

KaitenDevelopers

rest external webhooks webhooks scim user metadata imports addons

Update group entity

PATCH

https://example.kaiten.ru/api/latest/company/groups/{group_uid}/entities/{uid}

This endpoint is currently under active development. Parameters, attributes, and response formats are subject to change.

Path parameters

Name	Type	Reference
group_uidrequired	string	Group Uid
uidrequired	string	Entity Uid

Headers

Name	Value
Content-Type	application/json

Attributes

schema

{
 "$schema": "http://json-schema.org/draft-06/schema",
 "type": "object",
 "properties": {
  "role_ids": {
   "type": "array",
   "minItems": 1,
   "items": {
    "type": "string",
    "format": "uuid"
   },
   "description": "Entity roles for this group "
  }
 },
 "anyOf": [
  {
   "required": [
    "role_ids"
   ]
  }
 ]
}

Name	Type	Constraints	Description
role_ids	array of strings		Entity roles for this group

Responses

200

Description	Response type	Example
Success	Object	Open

Response Attributes

Name	Type	Description
group_id	integer	Group id
entity_uid	string	Entity uid
access_mod	string \| null	Access modifier with inheritable access modifiers
own_access_mod	string\| null	Own access modifier
role_ids	array of strings	Entity roles ids with inherited roles
own_role_ids	array of strings	Entity roles ids
role_permissions	object Schema	Group entity permissions

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.

402

Description	Response type	Example
Feature is not supported by tariff	Object	Open

Response Attributes

Name	Type	Description
message	string	Error message

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

group_uid

uid

Raw Body(json format)

  1  curl --request PATCH \
  2       --url 'https://example.kaiten.ru/api/latest/company/groups/{group_uid}/entities/{uid}' \
  3       --header 'Accept: application/json' \
  4       --header 'Content-Type: application/json'
  5

Response

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