旧バージョンのドキュメントを参照しています。 最新のドキュメントはこちらをご参照ください。
開発者の役割とコンテンツ権限
開発者のロールとコンテンツ権限を使用して Dev Portal へのアクセスを細かく調整できます。これは、Kong Manager の Dev Portal の権限ページを介して管理します。このページは、Kong Manager ナビゲーションバーの Dev Portal の下にある 権限(Permissions) リンクをクリックすると表示されます。
ロール
「役割」タブには、利用可能な開発者の役割のリストが含まれ、ロールを作成および編集する機能を提供します。
[ロールを作成] を選択すると、一意のロール名と、ロールの性質のコンテキストを示すコメントを入力できます。ロール作成ページ内から既存の開発者にロールを割り当てることができます。[作成] をクリックすると、ロールが保存され、ロールリスト ビューに戻ります。ここには、新しく作成したロールと、以前に定義したその他のロールが表示されます。
[表示] をクリックすると、割り当てられた開発者のリストを含むロールの詳細ページが表示されます。
ロールの詳細ページで、[編集] ボタンをクリックしてロールを変更します。このページには、[ロールリストを編集] ボタンからアクセスすることもできます。ここでは、ロールの名前とコメントの変更、開発者の割り当てまたは削除、ロールの削除を行うことができます。
ロールを削除すると、そのロールを割り当てられたすべての開発者からそのロールが削除され、そのロールが適用されているすべてのコンテンツファイルからロールの制限が削除されます。
コンテンツ
コンテンツタブには、Dev Portalで使用されるコンテンツファイルのリストが表示されます。コンテンツファイルにロールを適用して、特定のロールを持つ開発者のみにアクセスを制限できます。個々のコンテンツファイルを選択すると、利用可能な開発者ロールのドロップダウンが表示され、ファイルへのアクセス権を持つロールを選択できます。すべての利用可能なロールのチェックを外すと、ファイルは認証されません。
追加オプションである*
ロールが事前にリストに設定されています。この定義済みロールは
他のロールとは異なる動作をします。コンテンツファイルに*
のロールがある場合、
認証済みの開発者であれば誰でもこのページを閲覧できます。さらに、*
ロールは他のユーザ定義ロールと組み合わせて使用することはできず、*
が選択されるとそれらのロールの選択が解除されます。
重要:
dashboard.txt
およびsettings.txt
コンテンツファイルには、デフォルトで*
ロールが割り当てられています。その他のコンテンツファイルにはデフォルトのロールがありません。つまり、ロールが追加されるまで、Dev Portal認証が有効になっていてもファイルは認証されません。Dev Portal認証が無効になっている場合、コンテンツ権限は無視されます。
readable_by
属性
コンテンツタブを使用してコンテンツファイルにロールを適用すると、特別な
属性 readable_by
がファイルのヘッドマターに追加されます。
---
readable_by:
- role_name
- another_role_name
---
仕様ファイルの場合、readable_by
はキー x-headmatter
または X-headmatter
の下に適用されます。
x-headmatter:
readable_by:
- role_name
- another_role_name
readable_by
の値は、コンテンツファイル表示へのアクセス権を持つ文字列ロール名の配列です。ファイルに*
ロールが適用されている場合は
例外です。この場合、readable_by
の値はもはや配列ではありません。なぜなら
単一の文字列文字 *
が含まれているためです。
readable_by: "*"
⚠️ 重要: readable_by
属性を手動で削除または編集すると、ファイルの権限が変更されます。
存在しないロール名を含むreadable_by
配列でコンテンツファイルを保存しようとすると、エラーが発生します。
さらに、[コンテンツ]タブまたはポータルエディタで権限を変更する場合は、ローカルファイルを必ず同期して、次に変更をプッシュするときに権限が上書きされないようにします。