この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

OauthCustomScope

Salesforce が OAuth 認証プロバイダである場合、接続アプリケーションが外部エンティティからアクセスできる保護されたデータを定義する権限を表します。Metadata メタデータ型を拡張し、その fullName 項目を継承します。

ファイルのサフィックスおよびディレクトリの場所

OauthCustomScope コンポーネントのサフィックスは .oauthcustomscope で、oauthcustomscopes ディレクトリに保存されます。

バージョン

OAuth カスタム範囲は、API バージョン 46.0 以降で使用できます。

特別なアクセスルール

このオブジェクトにアクセスするには、「接続アプリケーションを管理する」権限が必要です。

項目

項目名	項目の型	説明
assignedTo	OauthCustomScopeApp (string 型の列挙)	カスタム範囲を割り当てる接続アプリケーションの名前を表します。API バージョン 49.0 以降で利用できます。接続アプリケーションがパッケージの一部である場合、接続アプリケーションの名前にパッケージの名前空間のプレフィックスを含めます。`<namespace_prefix>__<connected_app>` の形式を使用します。名前空間プレフィックスと接続アプリケーション名の間にアンダースコア (_) を 2 つ挿入します。
description	string	必須。範囲によって接続アプリケーションに提供される権限の説明。カスタム範囲の説明は一意である必要があり、英数字しか使用できず、60 文字まで入力できます。説明の代わりにカスタム表示ラベルを入力できます。カスタム表示ラベルを使用するメリットは、再利用可能なテキストを 1 つの場所で管理して、複数の言語に翻訳できることです。「カスタム表示ラベル」を参照してください。カスタム範囲に適用される説明の形式の要件は、カスタムラベルにも適用されます。メモ
developerName	string	必須。プログラムから OAuth カスタム範囲を参照するときに使用します。
isProtected	boolean	必須。このコンポーネントが保護されるか ()、否か (`false`) を示します。保護コンポーネントは、インストールする組織で作成されたコンポーネントによってリンク設定したり参照したりすることはできません。
isPublic	boolean	オブジェクトが接続アプリケーションの OpenID Connect 検出エンドポイントに含まれているかどうかを示します。デフォルト設定は `false` です。詳細は、「OpenID Connect 検出エンドポイント」を参照してください。
masterLabel	string	必須。カスタム範囲レコードのマスタ表示ラベル。この表示ラベルは一意で、文字で始まる必要があります。英数字文字とアンダースコアのみを使用できます。スペースを含めることはできません。

宣言的なメタデータの定義のサンプル

OAuthCustomScope コンポーネントの例を次に示します。この例では、basicScope が取得されるカスタム範囲エンティティの名前です。

1<?xml version="1.0" encoding="UTF-8"?>
2<OauthCustomScope xmlns="http://soap.sforce.com/2006/04/metadata">
3    <assignedTo>
4        <connectedApp>MyOrgNamespace__TestApp</connectedApp>
5    </assignedTo>
6    <description>Example of a basic custom scope</description>
7    <developerName>basicScope</developerName>
8    <masterLabel>basicScope</masterLabel>
9    <isProtected>false</isProtected>
10    <isPublic>true</isPublic>
11</OauthCustomScope>

前の定義を参照する package.xml の例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3<types>
4<members>basicScope</members>
5<name>OauthCustomScope</name>
6</types>
7<version>49.0</version>
8</Package>

使用方法

OAuth カスタム範囲により、保護データにアクセスするための接続アプリケーションに関する外部エンティティを判断できます。Salesforce 組織で作成する OAuth カスタム範囲は、外部エンティティで定義されてリソースに割り当てられる同じカスタム範囲に対応しています。

たとえば、外部エンティティで注文システムの API の顧客の注文状況データへのアクセスを許可する「注文状況」カスタム範囲を定義するとします。Salesforce で OAuth カスタム範囲を作成し、やはり「注文状況」と名前を付けます。このカスタム範囲を、注文状況 API へのアクセスを要求する接続アプリケーションに割り当てます。外部エンティティが顧客の注文状況にアクセスするための接続アプリケーションの要求を受け取ると、接続アプリケーションのアクセストークンと「注文状況」範囲を検証します。検証に成功すると、アプリケーションは注文システムの API で顧客の注文状況情報にアクセスできます。

マニフェストファイル内のワイルドカードのサポート

このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。

メタデータ API 開発者ガイド