Skip to content
/
アクセスコントロール一覧を取得

LegalOn API (1.0.0)

API documentation for LegalOn services

Languages
Servers
サーバーのURLは `{api_base_url}/rest/v1` です。 アクセストークン取得時のレスポンスに含まれる `api_base_url` の値を用いてサーバーの URL を構成してください。
https://{api_base_url_without_scheme}/rest/v1

ユーザー

ユーザーに関する操作

Operations

ユーザーグループ

ユーザーグループに関する操作

Operations

ワークスペース

ワークスペース/フォルダに関する操作

Operations

ワークスペース/フォルダを移動

Request

ワークスペース/フォルダを移動します

Security
OAuth2ClientCredentials
Path
space_idstring(uuid)required

ワークスペース/フォルダID

Bodyapplication/jsonrequired

ワークスペース/フォルダ移動リクエスト

destination_parent_space_idstring(uuid)

移動先の親ワークスペース/フォルダID。指定されたワークスペース/フォルダの直下に移動します。指定されていない場合は、トップ階層に移動します。

curl -i -X POST \
  'https://{api_base_url_without_scheme}/rest/v1/spaces/{space_id}:move' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "destination_parent_space_id": "c4d4533c-f6ad-40be-abc3-92fd8c58ceae"
  }'

Responses

正常にワークスペース/フォルダを移動

Response
No content

アクセスコントロール一覧を取得

Request

アクセスコントロール一覧を取得します

Security
OAuth2ClientCredentials
Path
space_idstring(uuid)required

ワークスペース/フォルダID

Query
search_querystringnon-empty

検索文字列。ユーザー名、ユーザーグループ名、またはメールアドレス。

curl -i -X GET \
  'https://{api_base_url_without_scheme}/rest/v1/spaces/{space_id}/acls?search_query=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

正常にアクセスコントロール一覧を取得

Bodyapplication/json
space_idstring(uuid)required

ワークスペース/フォルダID

is_inheritedbooleanrequired

アクセスコントロールが上位から継承されているかどうか

user_group_access_levelArray of objects(user_group_access_level)
user_access_levelArray of objects(user_access_level)
user_group_total_sizeinteger>= 0

検索条件に一致するユーザーグループの総数

user_total_sizeinteger>= 0

検索条件に一致するユーザーの総数

Response
application/json
{
  "space_id": "76088fa5-1ce5-3ca9-303a-8466c48581ba",
  "is_inherited": false,
  "user_group_access_level": [
    { … },
    { … }
  ],
  "user_access_level": [
    { … }
  ],
  "user_group_total_size": 2,
  "user_total_size": 1
}

アクセスコントロール一覧を更新

Request

アクセスコントロール一覧を更新します

Security
OAuth2ClientCredentials
Path
space_idstring(uuid)required

ワークスペース/フォルダID

Bodyapplication/jsonrequired

アクセスコントロール一覧更新リクエスト

access_controlsArray of objects(access_control)required
access_controls[].​principal_idstring(uuid)required

プリンシパルID

access_controls[].​principal_typestringrequired

プリンシパルタイプ USER:ユーザー USER_GROUP:ユーザーグループ

Enum"USER""USER_GROUP"
access_controls[].​access_levelstringrequired

アクセスレベル MANAGER:管理者 EDITOR:編集者 POSTER:投稿者 VIEWER:閲覧者 NONE:権限なし

Enum"MANAGER""EDITOR""POSTER""VIEWER""NONE"
is_inheritedboolean

アクセスコントロールが上位から継承されているかどうか

curl -i -X PATCH \
  'https://{api_base_url_without_scheme}/rest/v1/spaces/{space_id}/acls' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "access_controls": [
      {
        "principal_id": "b0fe3bdd-8201-445a-aab3-a018692d6aca",
        "principal_type": "USER",
        "access_level": "MANAGER"
      }
    ],
    "is_inherited": true
  }'

Responses

正常にアクセスコントロール一覧を更新

Response
No content

部署

部署に関する操作

Operations