--- sourceDocument: Xanadu API リファレンス sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/xanadu/api-reference Release : - xanadu ft:locale : - ja-JP ft:publication_title : - Xanadu API リファレンス ft:clusterId : - crapiref bundleId : - crapiref workflow : - Creator --- # サードパーティ OAuth プロバイダーの使用 # サードパーティ OAuth プロバイダーの使用 {#ariaid-title1} * リリースバージョン: Xanadu * * 更新日 2024年08月01日 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：4分 OAuth 認証に参加するには、各クライアントアプリケーションをインスタンスに登録する必要があります。 ## 始める前に 必要なロール：admin ## このタスクについて 注: ServiceNow は、ServiceNow からサードパーティ API への要求を承認するサードパーティ OAuth プロバイダーのみをサポートしています。 たとえば、ユーザーのスケジュール済みイベントを読み取ってイベントを作成するために OAuth 2.0 アクセストークンが必要なサードパーティのカレンダーサービスと統合する場合があります。カレンダーサービスをサードパーティ OAuth プロバイダーとして構成します。この構成では、カレンダーサービスからアクセストークンを取得し、そのトークンを使用して ServiceNow からサービスに対して要求を行うことができます。 ## 手順 1. 移動先 すべてシステム OAuthアプリケーションレジストリ をクリックし、\[ 新規\] をクリックします。 2. インターセプターページで、\[サードパーティ OAuth プロバイダーに接続します\] をクリックし、フォームに入力します。 {#t_UseAThirdPartyOAuthProvider__table_sgc_qqv_yq__entry__2} | フィールド | 説明 | |-|-| | 名前 | アクセスが必要なアプリケーションを識別する一意の名前。 | | クライアント ID | アプリケーションの一意の ID。インスタンスは、アクセストークンを要求するときにクライアント ID を使用します。認証サーバーからクライアント ID を取得する必要があります。 | | クライアントシークレット | \[必須\] インスタンスとアプリケーションが相互の通信を許可するために使用する共有シークレット文字列。正しいクライアントシークレットを入力しないと、トークンは発行されません。 | | OAuth API スクリプト | このオプションを使用すると、修正済み OAuthUtil スクリプトインクルードを参照できます。デフォルトの OAuthUtil スクリプトインクルードファイルをコピーして名前を変更し、特定の要求と応答がサードパーティの OAuth プロバイダーと一致するようにこのバージョンを修正します。修正済みスクリプト名には、プリフィックス OAuth が必要です。適切なメソッドで必要な本文パラメーターを追加するには、「 [OAuthUtil](https://servicenow-prod.fluidtopics.net/16bi_3AmoSm7YjXe3xhq3Q#c_OAuthUtilScriptInclude "OAuthUtil スクリプトインクルードは、実行時に要求パラメーターを変更し、トークン応答を解析します。") 」を参照してください。 | | ロゴ URL | アプリケーションロゴとして使用するイメージを含む URL。 | | デフォルトの権限許可タイプ | 権限許可のタイプ： * 認証コード：アクセストークンを取得するためにクライアントに付与され、リソースへのアクセス権を取得するために使用されるコード。このオプションを選択する場合は、認証 URL (認証サーバーの URL) が必要です。 * リソース所有者のパスワード認証情報：リソースへのアクセス権の取得を試行するユーザーのユーザー名とパスワード。 * クライアント認証情報：どちらもアクセストークンを取得するために使用されるクライアント ID とクライアントシークレット。このメソッドはリフレッシュトークンを提供しません。 * JWT ベアラー：認証サーバーは、ID とセキュリティ情報をセキュリティドメイン間で共有できるようにする JWT トークンを検証します。 * SAML2 ベアラー：SAML2 アサーションを生成し、プロバイダーとアクセストークンのアサーションを交換します。 注: SuccessFactors への送信要求では、\[SAML2 ベアラー\] をデフォルトの権限許可タイプとして使用します。 {#t_UseAThirdPartyOAuthProvider__ul_ln4_4pg_nwb} | | リフレッシュ トークンの有効期間 | リフレッシュトークンの有効期間 (秒)。 | | アクセス可能 | このレジストリにアクセスできるアプリケーションスコープ。 | | アクティブ | アプリケーションレジストリがアクティブであることを示すチェックボックス。 | | 認証 URL | 認証コード権限許可タイプ (ユーザーを許可するエンドポイントの URL) を使用している場合。別の ServiceNow インスタンスにアクセスする場合は、URL に `/oauth_auth.do` を追加します。 | | トークン URL | トークンを取得および更新するためにインスタンスが使用するトークンエンドポイントの場所。別の ServiceNow インスタンスにアクセスする場合は、URL に `/oauth_token.do` を追加します。 | | リダイレクト URL | 認証コードを受信するアプリケーションエンドポイント。インスタンスで URL を自動生成するには、このフィールドを空白のままにします。別の ServiceNow インスタンスにアクセスする場合は、URL に `/oauth_redirect.do` を追加します。 | | トークン失効 URL | トークンを取り消すためにインスタンスが使用するエンドポイントの場所。別のインスタンスにアクセスする場合は、URL に `/oauth_revoke.do` を追加します。 | | コメント | アプリケーションに関連付ける追加情報。 | | 埋め込みリスト || | OAuth エンティティプロファイル | OAuth プロバイダーに関連付けられているプロファイル。プロファイルには権限許可タイプが含まれています。プロファイル名をクリックして、[\[OAuth エンティティプロファイル\] フォーム](kFcJYJM0iI8UFmhfUhdpcw "OAuth プロファイルには、サードパーティ OAuth プロバイダーが制限付きリソースへのアクセスを取得するために必要な権限許可タイプが含まれています。")に移動します。 | | OAuth エンティティスコープ | OAuth プロバイダーに関連付けられているエンティティスコープ。スコープは、アプリケーションがアクセスできるサービスを識別します。スコープ名をクリックして、[\[OAuth エンティティプロファイル\] フォーム](mC31t7Sq0oEyt4mnl4h5ww "プロバイダーから取得する OAuth スコープを指定します。スコープは、プロバイダーによって指定された任意のレベルのアクセス権 (読み取り、書き込み、または URL を含む任意の文字列) にすることができます。")に移動します。 | [ ] {#t_UseAThirdPartyOAuthProvider__table_sgc_qqv_yq} 3. \[送信\] をクリックします。レコードは、アプリケーションレジストリー \[oauth_entity\] テーブルに保存されます。 システムにより、タイプが OAuth プロバイダーのレコードがアプリケーションレジストリ \[oauth_entity\] テーブルに作成されます。また、インスタンスは指定された権限許可タイプを使用してデフォルトプロファイルを自動生成しますが、スコープは作成しません。 ## 次のタスク スコープのある[追加のプロファイルを作成](https://servicenow-prod.fluidtopics.net/kFcJYJM0iI8UFmhfUhdpcw "OAuth プロファイルには、サードパーティ OAuth プロバイダーが制限付きリソースへのアクセスを取得するために必要な権限許可タイプが含まれています。")できます。 * **[OAuth プロファイルおよびスコープ](https://servicenow-prod.fluidtopics.net/fD5~4xNbq6g9e6mZY3x60Q)** OAuth プロバイダーのシナリオでは、プロファイルとスコープによって権限許可タイプ、認証タイプ、およびアクセスのレベルが指定されます。