レコードのアクセス権の取得

フォローする

レコードのアクセス権の設定を取得します。

URI

URIは、運用環境の設定を取得する場合と、テスト環境の設定を取得する場合とで異なります。

運用環境の設定を取得する場合

https://(サブドメイン名).cybozu.com/k/v1/record/acl.json

ゲストスペースのアプリの場合:https://(サブドメイン名).cybozu.com/k/guest/(スペースのID)/v1/record/acl.json

テスト環境の設定を取得する場合

https://(サブドメイン名).cybozu.com/k/v1/preview/record/acl.json

ゲストスペースのアプリの場合:https://(サブドメイン名).cybozu.com/k/guest/(スペースのID)/v1/preview/record/acl.json

HTTPメソッド

GET

アクセス権

  • アプリに管理権限が必要です。
  • このAPIの実行には、APIトークンは使用できません。

リクエスト

パラメータ

パラメータ名 指定する値 必須 説明
app 数値又は文字列 必須 アプリのIDを指定します。
lang 文字列   言語を次のいずれかで指定します。
  • 日本語の場合:ja
  • 英語の場合:en
  • 中国語の場合:zh
  • ログインユーザーの言語設定で取得する場合:user*
    *ログインユーザーの言語設定が「Webブラウザの設定にしたがう」の場合、
    Accept-Languageヘッダがあればその設定が反映され、
    Accept-Languageヘッダがなければcybozu.com共通管理の「ローカライズの設定」で設定された言語で取得されます。
  • 上記以外の言語の場合:default
フィールドや選択肢の名前に「言語ごとの名称」を設定している場合、上記の指定に応じた設定が取得されます。省略すると、「default」が指定されます。

リクエストの例

送信するリクエストは、パラメータの送信方法によって異なります。パラメータ「app」と「lang」を指定したリクエストの例は、次のとおりです。

URLにパラメータを含める場合

GET /k/v1/record/acl.json?app=8&lang=ja HTTP/1.1
Host: example.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=

リクエストボディにパラメーターを含める場合
ヘッダ

GET /k/v1/record/acl.json HTTP/1.1
Host: example.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
Content-Type: application/json

ボディ

レスポンス

パラメータ

パラメータ名 値の種類 説明
rights 配列 アクセス権の設定を表す配列です。設定の優先度が高いものから順に並びます。
rights[].filterCond 文字列 レコードの条件です。クエリ形式で表されます。クエリ形式については、次のページを参照してください。
レコードの一括取得(クエリで条件を指定)
rights[].entities 配列 アクセス権の設定対象を表す配列です。設定の優先度が高いものから順に並びます。
rights[].entities[].entity オブジェクト アクセス権の設定の対象を表すオブジェクトです。
rights[].entities[].entity.type 文字列 アクセス権の設定対象の種類です。
  • USER:ユーザー
  • GROUP:グループ
  • ORGANIZATION:組織
  • FIELD_ENTITY:ユーザーフィールド
rights[].entities[].entity.code 文字列 アクセス権の設定対象のコードです。
rights[].entities[].viewable 真偽値 レコードの閲覧が可能かどうかの設定です。
  • true:レコードを閲覧できる
  • false:レコードを閲覧できない
rights[].entities[].editable 真偽値 レコードの編集が可能かどうかの設定です。
  • true:レコードを編集できる
  • false:レコードを編集できない
rights[].entities[].deletable 真偽値 レコードの削除が可能かどうかの設定です。
  • true:レコードを削除できる
  • false:レコードを削除できない
rights[].entities[].includeSubs 真偽値 設定を下位組織に継承するかどうかの設定です。
  • true:継承する
  • false:継承しない
revision 文字列 アプリの設定のリビジョン番号です。

レスポンスの例

JavaScriptサンプル

kintone REST API

XMLHttpRequest

記事に関するフィードバック

直接的に記事と関連がないご質問はcybozu developer コミュニティをご活用ください。

ログインしてコメントを残してください。
Powered by Zendesk