開発者向けのドキュメント

SitecoreAI組織や環境のクライアント認証情報を管理する

日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

Deployアプリから、組織およびその環境のクライアント認証情報を作成・管理できます。

アプリケーションがSitecoreAI APIにアクセスしたい場合は、クライアント認証情報を発行しなければなりません。

アクセスしたい内容に応じて、さまざまなタイプのクライアントを作成できます:

組織内のすべての環境のDeploy APIおよびCMインスタンスAPIにアクセスするには、組織用の自動化クライアントを作成します。
特定の環境やSitecore XM Apps REST APIのCMインスタンスAPIにアクセスするには、その環境用の自動化クライアントを作成します。

XM Cloudは現在SitecoreAIとなっています

一部のコード例、画像、UIラベルは、エンジニアリング資産の更新中もXM Cloudを使用している場合があります。
特定の環境のExperience Edge APIにアクセスするには、その環境用のEdge管理クライアントを作成します。
外部編集ホストを使用する際にDesign Studioでコード抽出を有効にするには、該当環境用の外部編集ホストクライアントを作成します。

認証情報を作成すると、DeployアプリはクライアントIDとクライアントシークレットを作成します。クライアントIDとクライアントシークレットは、基本的にユーザー名とパスワードに相当します。

認証情報を使ってCMインスタンスのJSON Web Tokenをリクエストしたり、Experience Edge XMのJWTをリクエストしたりできます。

SitecoreAI組織向けの自動化クライアントを作成する

もしアプリが組織内のすべての環境のDeploy APIやCMインスタンスAPIにアクセスする必要があるなら、組織用の自動化クライアントを作成しましょう。

組織向けの自動化クライアントを作成するには:

DeployアプリのナビゲーションペインでCredentialsをクリックします。
CredentialsページでOrganizationタブをクリックし、次にCreate credentialsをクリックします。
Automation clientダイアログのLabel欄でクライアントのラベルを入力します。

注記

LabelおよびDescriptionフィールドには以下の文字は使用できません。# @ " + & >
オプションで、Description欄にクライアントの説明を入力してください。
クリックCreate。
クライアントIDとクライアントシークレットを保存してください。

注記

クライアントシークレットは一度だけ生成され、システムから取得または再生成することはできません。クライアントの秘密を失うと、新しい認証クライアントを生成しなければなりません。

環境用の自動化クライアントを作成する

もしアプリが特定の環境やXM Apps REST APIのCMインスタンスAPIにアクセスする必要があるなら、その環境用の自動化クライアントを作成しましょう。

環境用の自動化クライアントを作成するには:

DeployアプリのナビゲーションペインでCredentialsをクリックします。
CredentialsページでEnvironmentタブをクリックし、次にCreate credentials > Automation clientをクリックしてください。
Automation clientダイアログのLabel欄で、自動化クライアントのラベルを入力します。

注記

LabelおよびDescriptionフィールドには以下の文字は使用できません。# @ " + & >
オプションでDescription欄に自動化クライアントの説明を入力します。
Projectのドロップダウンメニューで、自動化クライアントを作成したい環境を含むプロジェクトをクリックまたは入力してください。
Environmentドロップダウンメニューで、希望する環境をクリックまたは入力してください。
クリックCreate。
クライアントIDとクライアントシークレットを保存してください。

注記

クライアントシークレットは一度だけ生成され、システムから取得または再生成することはできません。クライアントの秘密を失うと、新しい認証クライアントを生成しなければなりません。

環境用のEdge管理クライアントを作成する

もしアプリが環境のExperience Edge設定を管理する必要があるなら、Edge管理クライアントを作成しましょう。

環境用のEdge管理クライアントを作成するには:

DeployアプリのナビゲーションペインでCredentialsをクリックします。
CredentialsページでEnvironmentタブをクリックし、次にCreate credentials > Edge administration clientをクリックしてください。
Edge administration clientダイアログのLabel欄で、Edge管理クライアントのラベルを入力します。

注記

LabelおよびDescriptionフィールドには以下の文字は使用できません。# @ " + & >
オプションで、Description欄にEdge管理クライアントの説明を入力します。
Projectのドロップダウンメニューで、Edge管理クライアントを作成したい環境を含むプロジェクトをクリックまたは入力してください。
Environmentドロップダウンメニューで、希望する環境をクリックまたは入力してください。
クリックCreate。
クライアントIDとクライアントシークレットを保存してください。

注記

クライアントシークレットは一度だけ生成され、システムから取得または再生成することはできません。クライアントの秘密を失うと、新しい認証クライアントを生成しなければなりません。

環境用の外部編集ホストクライアントを作成する

外部編集ホストを使ってDesign Studioでコード抽出を有効にしたい場合は、外部編集ホストの認証情報を作成し、デプロイ時に追加する必要があります。

環境用の外部編集ホストクライアントを作成するには:

DeployアプリのナビゲーションペインでCredentialsをクリックします。
CredentialsページでEnvironmentタブをクリックし、次にCreate credentials > External editing hostをクリックしてください。
External editing hostダイアログのLabel欄で、外部編集ホストクライアントのラベルを入力します。

注記

LabelおよびDescriptionフィールドには以下の文字は使用できません。# @ " + & >
オプションで、Description欄で外部編集ホストクライアントの説明を入力します。
Projectのドロップダウンメニューで、外部編集ホストで使用している環境を含むプロジェクトをクリックまたは入力してください。
Environmentドロップダウンメニューで、希望する環境をクリックまたは入力してください。
クリックCreate。
クライアントIDとクライアントシークレットを保存してください。

注記

クライアントシークレットは一度だけ生成され、システムから取得または再生成することはできません。クライアントの秘密を失うと、新しい認証クライアントを生成しなければなりません。

クライアントを取り消す

クライアント認証を取り消すことで、組織や環境へのアプリケーションアクセスを解除できます。この操作によりクライアントが削除され、関連するアクセストークンが取り消されます。クライアントを取り消すと、それは回復できません。

クライアントを取り消すには:

DeployアプリのナビゲーションペインでCredentialsをクリックします。
Credentialsページで、取り消したいクライアントのタブをクリックしてください。
取り消したいクライアントを見つけ、そのActionsメニューをクリックし、Revoke clientをクリックします。
Revoke clientダイアログでRevokeをクリックします。

この記事を改善するための提案がある場合は、お知らせください!