UserProvisioningRequest | Salesforce および Force.com のオブジェクトリファレンス

UserProvisioningRequest (UPR) レコードは、各ユーザおよびそのユーザが使用できる各接続アプリケーションの各プロビジョニングアクションに対して作成されます。たとえば、ユーザが 2 つの接続アプリケーションを使用し、そのユーザのアカウントを作成する 2 つの異なるサービスにプロビジョニング要求が送信される場合、Salesforce によって 2 つの UPR オブジェクトが作成されます。プロビジョニングアクションには、ユーザアカウントの作成、更新、または削除が含まれます。

サポートされているコール

create()、delete()、describeSObjects()、getDeleted()、getUpdated()、query()、retrieve()、undelete()、update()、upsert()

項目

項目	詳細
AppName	型 string プロパティ Create、Filter、Group、Nillable、Sort、Update 説明サービスプロバイダに関連付けられた接続アプリケーションの一意の名前。
ApprovalStatus	型 picklist プロパティ Create、Filter、Group、Restricted picklist、Sort、Update 説明現在の要求の承認状況。接続アプリケーションのユーザプロビジョニング設定で承認プロセスが有効になっていない場合、状況は `Not Required` です。承認プロセスが有効な場合、サポートされている値は次のとおりです。 `Required` — 関連付けられた接続アプリケーションのユーザプロビジョニング設定で承認プロセスが有効になっていますが、要求に対する応答がまだありません。 `Not Required` — 関連付けられた接続アプリケーションのユーザプロビジョニング設定で承認プロセスが有効になっていません。 `Approved` `Denied`
ConnectedAppId	型 reference プロパティ Create、Filter、Group、Nillable、Sort、Update 説明接続アプリケーションの 18 桁のアプリケーション ID。
ExternalUserId	型 string プロパティ Create、Filter、Group、Nillable、Sort、Update 説明対象システムのユーザの一意の識別子。
ManagerId	型 reference プロパティ Create、Filter、Group、Nillable、Sort、Update 説明 SalesforceUserId 項目で指定されたユーザを管理するユーザの Salesforce ID。ユーザプロビジョニング要求に承認プロセスが設定されている場合、この値は要求の承認をマネージャに許可します。API バージョン 34.0 以降で利用できます。
Name	型 string プロパティ Autonumber、Defaulted on create、Filter、idLookup、Sort 説明このオブジェクトの一意の名前。
Operation	型 picklist プロパティ Create、Filter、Group、Restricted picklist、Sort、Update 説明プロビジョニング要求 (通常は User オブジェクトへの変更) に関連付けられたトリガによってコールされる Apex メソッド。サポートされている値は、次のとおりです。 `Create` `Read` `Update` `Deactivate` `Activate` `Freeze` `Unfreeze` `Reconcile` `Linking` たとえば、User オブジェクト項目 isActive が `false` に設定されている場合、UPR オブジェクトの Operation 項目値は `Deactivate` に設定されます。
OwnerId	型 reference プロパティ Create、Defaulted on create、Filter、Group、Sort、Update 説明このオブジェクトを所有するグループまたはユーザの Salesforce ID。
ParentID	型 reference プロパティ Create、Filter、Group、Sort、Update 説明再試行イベントが作成されると、失敗した UPR がコピーされ、再送信されます。この項目には、現在のレコードを作成するためにコピーされた、失敗した UPR へのルックアップが含まれます。
再試行回数	型 int プロパティ Create、Filter、Group、Sort、Update 説明 UPR で実行された再試行の数。Retry Count によって、「5 回再試行したら停止してシステム管理者に通知する」のようなカスタムビジネスロジックを有効化できます。
SalesforceUserId	型 reference プロパティ Create、Filter、Group、Nillable、Sort、Update 説明要求を行うユーザの Salesforce ID。
ScheduleDate	型 dateTime プロパティ Create、Filter、Nillable、Sort、Update 説明この要求をサービスプロバイダに送信する日時。スケジュール設定はまだ実装されていません。現在、プロビジョニングの変更はサービスプロバイダに送信されるキューに直ちに入れられます。メモ
State	型 picklist プロパティ Create、Filter、Group、Restricted picklist、Sort、Update 説明この要求の状況。サポートされている値は、次のとおりです。 `New` `Requested` `Completed` `Failed` `Collecting` `Collected` `Analyzing` `Analyzed` `Committing` `Retried` `Manually Completed` 調整プロセスが実行されていない限り、State は `New` から `Requested` に移行し、`Completed` または `Failed` に移行します。調整プロセス中の State 値の変更についての詳細は、「使用方法」を参照してください。 UPR の失敗のトラブルシューティングを行うと、State は `Failed` から `Retried` または `Manually Completed` に移行します。失敗の処理についての詳細は、「プロビジョニングの失敗を管理するための state 値」を参照してください。
UserProvAccountId	型 reference プロパティ Create、Filter、Group、Nillable、Sort、Update 説明関連付けられた UserProvAccount オブジェクトの ID 値。
UserProvConfigId	型 reference プロパティ Create、Filter、Group、Nillable、Sort、Update 説明関連付けられた UserProvisioningConfig オブジェクトの ID 値。API バージョン 34.0 以降で利用できます。

使用方法

State 値は、サードパーティシステムのユーザと Salesforce ユーザを収集して比較するため、調整プロセス中 (Operation = Reconcile) に変更されます。通常、UPR エントリが最初に作成されたときに、State 値は New になります。収集プロセスがトリガされると、State は Collecting に移行し、そのプロセスが完了すると State は Collected になります。分析プロセスがトリガされると、State は Analyzing に移行し、そのプロセスが完了すると State は Analyzed になります。プロセスで要求がコミットされると、State は Committing に移行し、プロパティが UserProvAccountStaging オブジェクトから UserProvAccount オブジェクトに移動します。プロパティが UserProvAccount オブジェクトに保存されると、State は Completed に移行します。

ただし、State は New で開始するとは限りません。たとえば、プログラムで UserProvAccountStaging エントリを挿入できます。サードパーティサービスのアカウントに対してこれらの行のリンクをトリガするプロセスが開始された場合、UPR エントリは Analyzing State で開始する可能性があります。

また、State は現在有効なタスクから逆戻りすることはできません。たとえば、Analyzing State の成功時には Analyzed に進む必要があります。このプロセスが失敗した場合、State は Failed に変更される必要があります。特定の State の移行はプログラムでは実行できず、Salesforce によってトリガされる必要があります。

次の表に、各 State 値で発生することがある State の移行を示します。各行は現在の State 値に対応し、各列は発生しうる移行後の新しい State に対応します。

— この値への移行は許可されません。
— この値への移行は許可されます。
— Salesforce のみが State をこの値に移行できます。

	`New`	`Requested`	`Collecting`	`Collected`	`Analyzing`	`Analyzed`	`Committing`	`完了`	`Failed`	`Retried`	`Manually Completed`
`New`
`Requested`
`Collecting`
`Collected`
`Analyzing`
`Analyzed`
`Committing`
`完了`
`Failed`
`Retried`
`Manually Completed`

プロビジョニングの失敗を管理するための state 値

state 値は、ネットワークの停止、セッションタイムアウト、権限の問題、レコードのロックなど、さまざまな理由で Failed に変わります。Failed 状態は、失敗に対応するために行われたアクションを示す Retried または Manually Completed に移行する可能性があります。失敗の根本原因を修正し、プロビジョニングエンジンに UPR の再試行を要求するアクションを実行できます。または、対象に対するアクションを手動で完了できます。各 UPR は独立したトランザクションであるため、再試行が別の根本原因で失敗する可能性があります。失敗したイベントに対処しても、そのイベントとさらにアクションが必要なイベントを区別するのが困難です。

失敗の原因を修正しようとして、プロビジョニングエンジンに UPR の再試行を要求する場合、失敗した UPR に Retried とマークできます。対象に対するアクションが手動で完了された場合は、Manually Completed とマークできます。

再試行イベントが作成されると、失敗した UPR がコピーされ、再送信されます。ParentID 項目には、新しい UPR のコピーに使用するための失敗した UPR へのルックアップが含まれます。Retry Count 項目には、UPR で実行された再試行の数が含まれます。Retry Count 項目で、「5 回再試行したら停止してシステム管理者に通知する」のようなカスタムビジネスロジックを追加できます。