カテゴリー内の他の記事

フィールドのアクセス権の変更

フォローする

フィールドのアクセス権の設定を変更します。

URI

URIは、運用環境のアプリを更新する場合と、テスト環境のアプリを更新する場合とで異なります。

運用環境のアプリを更新する場合

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

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

このAPIを実行すると、アプリのアクセス権だけでなく、テスト環境のアプリのすべての設定が運用環境のアプリに反映されます。

テスト環境のアプリを更新する場合

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

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

HTTPメソッド

PUT

アクセス権

アプリに管理権限が必要です。

リクエスト

パラメータ

指定するパラメータの一覧です。

パラメータ名 指定する値 必須 説明
app 数値又は文字列 必須

アプリのIDを指定します。「app」、「id」のいずれかのパラメータを使用します。両方のパラメータを指定すると、「id」の指定が優先されます。

id
rights 配列 必須 アクセス権の設定を表す配列です。優先度が高い設定から順に並べます。ただし、ここで指定した順に関わらず、「Everyone」(すべてのユーザー)に対して指定した設定は、常に優先度が最低です。
rights[].code 文字列 必須 アクセス権を設定するフィールドのコードを指定します。
rights[].entities 配列 必須 アクセス権の設定対象を表す配列です。設定の優先度が高いものから順に並べます。
rights[].entities[].accessibility 文字列 必須 フィールドに対して可能な操作を指定します。
  • 閲覧だけ可能な場合:READ
  • 閲覧も編集も可能な場合:WRITE
  • 閲覧も編集も不可の場合:NONE
rights[].entities[].entity オブジェクト 必須 アクセス権の設定の対象を表すオブジェクトです。
rights[].entities[].entity.type 文字列 必須 アクセス権の設定対象の種類を指定します。
  • ユーザーの場合:USER
  • グループの場合:GROUP
  • 組織の場合:ORGANIZATION
  • ユーザーフィールドの場合:FIELD_ENTITY
rights[].entities[].entity.code 文字列 必須 アクセス権の設定対象のコードを指定します。
アクセス権の設定対象に「Everyone」(すべてのユーザー)を指定しない場合、「Everyone」はすべての操作が許可されません。
ゲストユーザーを指定する場合、ログイン名の前に「guest/」を付けます。
rights[].entities[].includeSubs 真偽値又は文字列   設定を下位組織に継承するかどうかを指定します。
  • 継承する場合:true
  • 継承しない場合(初期設定):false

省略した場合はfalseとなります。

revision 数値又は文字列   アプリの設定を変更する前のリビジョン番号を指定します。previewの場合のみ、指定されたリビジョン番号を検証します。
指定したリビジョンが最新ではない場合、リクエストはエラーになります。
指定を省略、または「-1」を指定すると、リビジョンはチェックされません。
 
このAPIの実行には、APIトークンは使用できません。

リクエストの例

ヘッダ

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

ボディ

レスポンス

パラメータ

パラメータ名 値の種類 説明
revision 文字列 アプリの設定を変更したあとのリビジョン番号です。

レスポンスの例

JavaScriptサンプル

kintone REST API

XMLHttpRequest

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

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

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