アプリケーションメタデータを構成する
アプリケーションメタデータは任意で、カスタマイズ可能なキーと値(それぞれ最大255文字)から成り、それぞれのアプリケーションに設定することができます。メタデータは、Client
オブジェクトではclient_metadata
、ルールではcontext.clientMetadata
として公開されます。たとえば、アプリケーションのホームページのURL(Auth0がアプリケーション設定にデフォルトで指定しないフィールド)を保管することができます。
クライアントメタデータはアプリケーション(クライアント)プロパティの部分として保管されます。データの種類、フィールド名と保管制限については、「メタデータのフィールド名とデータタイプ」をお読みください。
クライアントシークレットの保管場所
クライアントシークレットの保管場所は、スコープによって異なります。
アプリケーションごとにシークレットが1つの場合は、
client_metadata
が最適です。システム全体(すべて、あるいは多数のアプリケーション)でシークレットが1つの場合は、ルールの構成値を使うのが適切です。
各ユーザーに異なるシークレットがある場合は、
app_metadata
への保管が適しています。
既存のアプリケーションには、このプロパティの値はありません。
アプリケーションメタデータにアクセスするには、アクションを使用します。
exports.onExecutePostLogin = async (event, api) => {
if (event.client.metadata.SKIP_VERIFICATION === "yes"){
return;
}
// ... continue this Action
}
Was this helpful?
または、ルールを使用します。
function applicationMetadataExample (user, context, callback){
context.clientMetadata = context.clientMetadata || {};
if (context.clientMetadata.SKIP_VERIFICATION === "yes"){
return callback();
}
// ... continue this Rule
}
Was this helpful?
アプリケーションメタデータの読み出しや追加には、Auth0 DashboardまたはManagement APIを使用することができます。Management APIでクライアントメタデータを管理する方法については、「Management APIでメタデータを管理する」をお読みください。
アプリケーションメタデータのキーと値のペアを追加する
[Dashboard]>[Applications(アプリケーション)]>[Applications(アプリケーション)]に移動して、アプリケーションを選択します。
下にスクロールして、[Advanced Settings(詳細設定)]をクリックします。
[Application Metadata(アプリケーションメタデータ)]タブでキーの名前と値を入力してから、[Add(追加)]をクリックします。
[Save Changes(変更を保存)]をクリックします。
アプリケーションメタデータの値を更新する
[Dashboard]>[Applications(アプリケーション)]>[Applications(アプリケーション)]に移動して、アプリケーションを選択します。
下にスクロールして、[Advanced Settings(詳細設定)]をクリックします。
[Application Metadata(アプリケーションメタデータ)]タブで、変更したいキーの名前と新しい値を入力してから、[Add(追加)]をクリックします。
[Save Changes(変更を保存)]をクリックします
アプリケーションメタデータを削除する
[Dashboard]>[Applications(アプリケーション)]>[Applications(アプリケーション)]に移動して、アプリケーションを選択します。
下にスクロールして、[Advanced Settings(詳細設定)]をクリックします。
[Application Metadata(アプリケーションメタデータ)]タブで、削除したいキーと値のペアを見つけて、ゴミ箱アイコンをクリックします。
削除を確定します。
[Save Changes(変更を保存)]をクリックします。