1. Deploy app

Authoring・マネジメントAPIまたはDeploy APIのJWTを申請してください。

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

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

Sitecore Authoringおよび管理GraphQL APIまたはDeploy APIでいかなる操作を実行するには、JSONウェブトークン(JWT)形式の認証トークンを取得し、すべてのAPI呼び出しに含めてください。

認可に関しては、Sitecore Authoringおよび管理のAPIとDeploy APIがOAuth認可フレームワークを使用します。

注記

OAuthを使ってExperience Edge XM用のJWTをリクエストすることもできます。

始める前に

JWTを要求する前に、クライアントのIDとクライアントシークレットからなる認証情報を作成する必要があります。必要な認証情報の種類は、どのAPIにアクセスしたいかによって異なります。

JWTをリクエストしてください

Deploy APIまたはAuthoring・管理APIのJWTを申請するには:

  • https://auth.sitecorecloud.io/oauth/tokenPOSTリクエストを行い、以下のプロパティを含めてください。

    名称

    価値

    audience

    https://api.sitecorecloud.io

    grant_type

    client_credentials

    client_id

    自動化クライアントのクライアントIDです。

    client_secret

    自動化クライアントの秘密です。

リクエストが成功すると、access_token、scope、expires_in、token_typeの価値が届きます。 scopeは作成した資格の種類によります。

アクセストークンの値を使ってAuthoringや管理API、またはDeploy APIへのリクエストを承認します。

大事な

応答のexpires_in特性に注意してください。JWTは通常24時間以内に有効期限が切れます。その時間を超えるとトークンは無効となり、新しいトークンをリクエストしなければなりません。

例

以下のcURLの例では、データはフォームデータとしてエンコードされています。したがって、POSTリクエストにはContent-Typeリクエストヘッダーが含まれ、その値はapplication/x-www-form-urlencoded :

curl --request POST --url "https://auth.sitecorecloud.io/oauth/token" --header "content-type: application/x-www-form-urlencoded" --data audience=https://api.sitecorecloud.io --data grant_type=client_credentials --data client_id=<your-client-id> --data client_secret=<your-client-secret>

リクエストは以下の応答を返します:

{
    "access_token": "eyJhbGciOiJSUzI1NiI...",
    "scope": "xmclouddeploy.organizations:manage xmclouddeploy.projects:manage xmclouddeploy.environments:manage...",
    "expires_in": 86400,
    "token_type": "Bearer"
}
XM Cloudは現在SitecoreAIとなっています

一部のコード例、画像、UIラベルは、エンジニアリング資産の更新中もXM Cloudを使用している場合があります。

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