LegalStack

Контроль доступа

Контроль доступа: правила, проверки, матрицы.

Список правил доступа

GET
/api/v1/security/access-rules
АвторизацияBearer <токен>

В: header

Тело ответа

application/json

curl -X GET "https://loading/api/v1/security/access-rules"
[
  {
    "id": "string",
    "permissions": [
      "read"
    ],
    "resourceId": "string",
    "resourceType": "registry",
    "subjectId": "string",
    "subjectType": "user",
    "teamId": "string",
    "property1": null,
    "property2": null
  }
]

Создать правило доступа

POST
/api/v1/security/access-rules
АвторизацияBearer <токен>

В: header

Тело запроса

application/json

TypeScript-определения

Используйте тип request body в TypeScript.

Тело ответа

application/json

curl -X POST "https://loading/api/v1/security/access-rules" \  -H "Content-Type: application/json" \  -d '{    "permissions": [      "read"    ],    "resourceId": "string",    "resourceType": "registry",    "subjectId": "string",    "subjectType": "user"  }'
{
  "id": "string",
  "permissions": [
    "read"
  ],
  "resourceId": "string",
  "resourceType": "registry",
  "subjectId": "string",
  "subjectType": "user",
  "teamId": "string",
  "property1": null,
  "property2": null
}

Проверка доступа текущего пользователя

GET
/api/v1/security/access-rules/check
АвторизацияBearer <токен>

В: header

Параметры запроса

resourceType*string

Тип ресурса, на который выдаётся доступ

Значение в"registry" | "task" | "calendar" | "automation" | "interface" | "document" | "approval" | "signature"
resourceId*string

Идентификатор ресурса

relation*string

Проверяемое отношение, например can_view или can_edit

Длина1 <= length

Тело ответа

application/json

curl -X GET "https://loading/api/v1/security/access-rules/check?resourceType=registry&resourceId=string&relation=string"
{
  "allowed": true,
  "reason": "string",
  "property1": null,
  "property2": null
}

Правила для конкретного ресурса

GET
/api/v1/security/access-rules/resource/{resourceType}/{resourceId}
АвторизацияBearer <токен>

В: header

Параметры пути

resourceType*string

Тип ресурса, на который выдаётся доступ

Значение в"registry" | "task" | "calendar" | "automation" | "interface" | "document" | "approval" | "signature"
resourceId*string

Идентификатор ресурса

Тело ответа

application/json

curl -X GET "https://loading/api/v1/security/access-rules/resource/registry/string"
[
  {
    "id": "string",
    "permissions": [
      "read"
    ],
    "resourceId": "string",
    "resourceType": "registry",
    "subjectId": "string",
    "subjectType": "user",
    "teamId": "string",
    "property1": null,
    "property2": null
  }
]

Обновить правило доступа

PATCH
/api/v1/security/access-rules/{id}
АвторизацияBearer <токен>

В: header

Параметры пути

id*string

Идентификатор правила

Тело запроса

application/json

TypeScript-определения

Используйте тип request body в TypeScript.

Тело ответа

application/json

curl -X PATCH "https://loading/api/v1/security/access-rules/string" \  -H "Content-Type: application/json" \  -d '{    "permissions": [      "read"    ]  }'
{
  "id": "string",
  "permissions": [
    "read"
  ],
  "resourceId": "string",
  "resourceType": "registry",
  "subjectId": "string",
  "subjectType": "user",
  "teamId": "string",
  "property1": null,
  "property2": null
}

Удалить правило доступа

DELETE
/api/v1/security/access-rules/{id}
АвторизацияBearer <токен>

В: header

Параметры пути

id*string

Идентификатор правила

Тело ответа

curl -X DELETE "https://loading/api/v1/security/access-rules/string"
Пусто

Пакетная проверка доступа к модулям

POST
/api/v1/security/access/check-modules
АвторизацияBearer <токен>

В: header

Тело запроса

application/json

TypeScript-определения

Используйте тип request body в TypeScript.

Тело ответа

application/json

curl -X POST "https://loading/api/v1/security/access/check-modules" \  -H "Content-Type: application/json" \  -d '{    "modules": [      "string"    ]  }'
{
  "property1": true,
  "property2": true
}