SCIM および REST API リファレンスシート
SCIM を使用して Salesforce ユーザーオブジェクトを管理するには、REST API の CRUD (作成、参照、更新、無効化) 操作を SCIM エンドポイントに送信できます。これらの操作を実行するには、OAuth 2.0 アクセストークンを提供する必要があります。
必要なエディション
| 使用可能なインターフェース: Salesforce Classic および Lightning Experience |
| 使用可能なエディション: すべてのエディション |
REST API 操作の設定方法についての詳細は、次のセクションを参照してください。
SCIM エンドポイントおよび CRUD 操作
次の表に、SCIM エンドポイントおよびサポートされる操作を示します。
| SCIM エンドポイント | 説明 | サポートされる演算 |
|---|---|---|
| https://MyDomainName.my.salesforce.com/services/scim/v2/ServiceProviderConfigs | Salesforce SCIM 実装の機能を要求します。 | 参照: GET |
| https://MyDomainName.my.salesforce.com/services/scim/v2/Schemas | リソースおよび属性の拡張機能を調査します。 | 参照: GET |
| https://MyDomainName.my.salesforce.com/services/scim/v2/ResourceTypes | 使用可能なリソースの種別 (ユーザー、エンタイトルメントなど) を検出します。 | 参照: GET |
| https://MyDomainName.my.salesforce.com/services/scim/v2/Entitlements | ユーザーに割り当てられたサポートエンタイトルメント (プロファイル、権限セットなど) を表示します。 組織のすべてのエンタイトルメントを照会する場合、このエンドポイントは最大 200 件のレコードを返します。200 件を超えるレコードを表示するには、特定のエンタイトルメントを照会します。 |
参照: GET |
| https://MyDomainName.my.salesforce.com/services/scim/v2/Roles | ユーザーに割り当てられたロールを表示します。 | 参照: GET |
https://MyDomainName.my.salesforce.com /services/scim/v2/Users https://MyDomainName.my.salesforce.com/services/scim/v2/Users/<user_Id> |
ユーザーオブジェクトをプロビジョニングおよび管理します。 | 作成: 参照: 更新: 無効化: |
| https://MyDomainName.my.salesforce.com/services/scim/v2/Groups | ユーザーが属している公開グループを表示および管理します。 | 参照: 更新: |
操作ルール
SCIM 操作を記述するときは、次のルールを考慮します。
- 句の
ANDは、ORよりも優先されません。句にANDとORの両方が含まれている場合、句に明示的に括弧を追加します。 - 句の属性名と演算子は大文字と小文字を区別します。
- 次の項目を単独で絞り込みます。
- ユーザー: entitlements、groups
- グループ: members
- エンタイトルメント: members
サポートされる SCIM 拡張機能
Salesforce では次の Salesforce ユーザー拡張機能がサポートされます。これらは、URN urn:salesforce:schemas:extension:2.0 の下に表示されます。
-
alias -
callCenterId -
extension
メモ この URN のコンテキストでは、extension項目は SCIM スキーマ拡張機能ではなくユーザーの電話内線番号を表します。
Salesforce では次の Enterpurise ユーザー拡張機能もサポートされます。これらは、URN urn:scim:schemas:extension:enterprise:2.0 の下に表示されます。
-
organization -
employeeNumber -
department manager(managerIdおよびdisplayName)delegatedApprover(delegatedApproverIdおよびdisplayName)-
division
Salesforce ではカスタム項目もサポートされます。カスタム項目は、URN urn:salesforce:schemas:extension:18CHARORGID の下に表示されます。
Experience Cloud ユーザーと Salesforce Customer Identity ユーザーに対してサポートされるこれらの拡張機能は、URN urn:salesforce:schemas:extension:external:2.0 の下に表示されます。Customer Identity ユーザーには、external identity 種別のエンタイトルメント profileId があります。同様に、Experience Cloud ユーザーには、community 種別のエンタイトルメント profileId があります。
-
accountId -
contactId -
community
accountId または contactId の値が提供されない場合は、取引先責任者レコードと取引先レコードがユーザーに対して作成されます。新しい取引先名の形式は usernameJITUserAccount です。例: user@corpname.orgJITUserAccount。
次の拡張機能は、URN urn:salesforce:schemas:extension:communities の下に表示されます。
-
networkID -
networkName
REST API と SCIM 属性の対応付け
次の表に、REST API オブジェクト項目と SCIM スキーマ属性のサポートされる対応付けを示します。このシートをクイックリファレンスとして使用します。各スキーマでサポートされる属性 (特性を含む) のより詳しい情報を表示するには、https://MyDomainName.my.salesforce.com/services/scim/v2/Schemas エンドポイントに GET 要求を送信します。「SCIM 実装について」を参照してください。
| REST API オブジェクト項目 | SCIM スキーマ属性 |
|---|---|
City
|
address.[type eq "work"].locality
|
CommunityNickname
|
nickName
|
CompanyName
|
互換性はありません |
Country
|
address.[type eq "work"].country
|
CreatedDate
|
created
|
Department
|
department
|
Division
|
division
|
Email
|
emails
|
EmailEncodingKey
|
emailEncodingKey
|
EmployeeNumber
|
employeeNumber
|
FederationIdentifier
|
ExternalID
|
FirstName
|
name.givenName
|
Id
|
Id
|
IsActive
|
active
|
LanguageLocaleKey
|
preferredLanguage
|
LastModifiedDate
|
lastModified
|
LastName
|
name.familyName
|
LocaleSidKey
|
locale
|
ManagerId
|
manager
|
MobilePhone
|
phoneNumbers.[type eq "mobile"].value
|
PermisisonSets
|
Entitlement
|
Phone
|
phoneNumbers.[type eq "work"].value
|
PostalCode
|
address.[type eq "work"].postalCode
|
ProfileId
|
Entitlement
|
ProfileName
|
Entitlement
|
State
|
address.[type eq "work"].region
|
TimeZoneSidKey
|
timezone
|
Title
|
title
|
Username
|
userName
|
UserPermissionsCallCenterAutoLogin
|
互換性はありません |
UserPermissionsMarketingUser
|
互換性はありません |
UserPermissionsOfflineUser
|
互換性はありません |
UserRoleId
|
Role
|

