ユーザーREST API

Oracle CPQ 25Aには、新しいユーザーWebサービスREST APIコールが導入されており、エンドポイントに会社を指定する必要がなくなりました。この新しいエンドポイントにより、すべての会社のユーザーを更新するために使用できる単一の静的エンドポイントを用意すれば、サイト上のユーザー管理がシンプルになります。システム・インテグレータは、これらのユーザーを管理するために、ホスト会社と各パートナ会社に個別のコールをする必要がなくなります。

次に、新しく自動生成されたpartyNumberユーザー識別パラメータを含む、会社に依存しない新しいOracle CPQ 25AのユーザーREST APIエンドポイントをリストします。

会社全体のすべてのユーザーの取得

このエンドポイントを使用して、すべてのユーザーのリストを取得します。

• エンドポイント:  /rest/v18/users
• メソッド:  GET

1人のユーザーの取得

この新しいエンドポイントを使用して、単一のユーザーの情報を取得します。

• エンドポイント:  /rest/v18/users/{partyNumber}
• メソッド:  GET

ユーザーの作成

このエンドポイントを使用して、新しいユーザーを作成します。

• エンドポイント:  /rest/v18/users
• メソッド:  POST

ユーザーの更新

このエンドポイントを使用して、既存のユーザーを更新します。

• エンドポイント:  /rest/v18/users/{partyNumber}
• メソッド:  PATCH

ユーザーのインポート

このエンドポイントを使用して、zipファイルの指定に従ってサイトのユーザーをインポートします。

• エンドポイント:  /rest/v18/actions/import
• メソッド:  POST

1人のユーザーのすべてのユーザー・グループの取得

このエンドポイントを使用して、特定のユーザーのユーザー・グループを取得します。

• エンドポイント:  /rest/v18/users/{partyNumber}/groups
• メソッド:  GET

1人のユーザーのユーザー・グループの更新

このエンドポイントを使用して、特定のユーザーのユーザー・グループを更新します。

• エンドポイント:  /rest/v18/users/{partyNumber}/groups
• メソッド:  PUT

有効化のステップ

REST APIガイドのRESTサービス定義を確認して利用してください(Oracle Help Center > 対象となるアプリケーション・サービス領域 > APIおよびスキーマからアクセスできます)。OracleのRESTサービスを初めて利用する場合は、クイック・スタートに関する項から開始してください。

ヒントと考慮事項

• 既存の会社固有のエンドポイントおよびSCIM準拠のユーザー・エンドポイントに対するユーザーREST APIは、引き続きサポートされます。
• 会社に基づくユーザーの取得REST APIでは、ペイロード・レスポンスにpartyIdおよびpartyNumberパラメータが含まれます。