機械翻訳について
  1. Oracle Fusion Cloud Applications共通機能のためのREST API
  2. タスク
  3. ユーザー

すべてのユーザーの取得

get

/hcmRestApi/scim/Users

すべてのユーザーの取得

リクエスト

問合せパラメータ
  • このパラメータは、レスポンスに含める属性値のカンマ区切りリストを指定します。
  • このパラメータは、現在の範囲内で返されるリソース・インスタンス数を指定します。
  • このパラメータは、ユーザー・リソース・インスタンスのサブセットを取得する問合せ式を指定します。 フォーマット: ?filter= 「例: filter=firstName prおよびuserType eq Employee」。
  • このパラメータは、リソース・コレクションがsorted.Format ?sortBy=である属性を指定します。ここで、簡易属性の場合は属性名の形式が、複合属性の場合は書式である必要があります。 例: sortBy=active
  • このパラメータは、リソース・コレクションの順序付けに基づく属性を指定します。 例: sortOrder=ascending
  • このパラメータは、レスポンスに含まれる最初の結果に対して1ベースの索引の使用を指定します。 ページ区切りを使用するには、この問合せパラメータを指定してください。

この操作にはリクエスト本文がありません。

トップに戻る

レスポンス

サポートされているメディア・タイプ

200 レスポンス

次の表に、このタスクのレスポンスを示します。
本文 ()
ルート・スキーマ : ユーザー
タイプ: object
Show Source
  • タイトル: Count
    現在の範囲内で返されるリソース・インスタンス数。
  • Resources
    タイトル: Resources
    コレクション内のユーザー・リソース。
  • タイトル: start index
    このパラメータは、リソース・コレクションの開始位置を定義します。 たとえば、startIndexが11でitemsPerPageが10の場合、レスポンス本文には11から20までの行が含まれます。
ネストされたスキーマ : リソース
タイプ: array
タイトル: Resources
コレクション内のユーザー・リソース。
Show Source
ネストされたスキーマ : Users-item
タイプ: object
Show Source
  • タイトル: Active
    ユーザーの管理ステータスを示します。 サービス・プロバイダは、この属性の定義値を決定します。 たとえば、trueはユーザーがログインできることを示し、falseはユーザー・アカウントが一時停止していることを示します。
  • タイトル: DisplayName
    ユーザーの表示名(通常はフルネーム)。
  • Emails
    タイトル: Emails
    ユーザーの電子メール・アドレス。 サービス・プロバイダは、bjensen@EXAMPLE.COMのかわりにbjensen@example.comなど、これらのアドレスの正規形式を使用します。 標準型の値は、work、home、およびその他の値です。
  • タイトル: Id
    読取り専用: true
    Oracle Fusion Cloud Applicationsのユーザー・リソースの一意の識別子。
  • Meta
    タイトル: Meta
    ユーザー・リソースのメタデータです。
  • Name
    タイトル: Name
    ユーザー名のコンポーネント。 この属性は、Full name as a single string Individual component attributes Both variantを返します。 書式設定されたバージョンは、両方のバリアントが同じ名前を示すように、コンポーネント属性の結合方法を示します。
  • タイトル: Password
    ユーザーのクリア・テキスト・パスワード。 この属性は、新規ユーザーの初期パスワードを指定し、既存のユーザーのパスワードをリセットするために使用されます。 問合せにレスポンスしてパスワード属性は返されません。
  • Roles
    タイトル: Roles
    Oracle Fusion Cloud Applicationsのユーザーに対するロールのリスト。
  • Schemas
    タイトル: Schemas
    ユーザー・リソースのスキーマ。
  • faUser-item
  • タイトル: UserName
    サービス・プロバイダで直接認証するユーザーの一意の識別子。 この属性は必須です。
ネストされたスキーマ : 電子メール
タイプ: array
タイトル: Emails
ユーザーの電子メール・アドレス。 サービス・プロバイダは、bjensen@EXAMPLE.COMのかわりにbjensen@example.comなど、これらのアドレスの正規形式を使用します。 標準型の値は、work、home、およびその他の値です。
Show Source
ネストされたスキーマ : メタ
タイプ: object
タイトル: Meta
ユーザー・リソースのメタデータです。
ネストされたスキーマ : 名前
タイプ: object
タイトル: Name
ユーザー名のコンポーネント。 この属性は、Full name as a single string Individual component attributes Both variantを返します。 書式設定されたバージョンは、両方のバリアントが同じ名前を示すように、コンポーネント属性の結合方法を示します。
ネストされたスキーマ : ロール
タイプ: array
タイトル: Roles
Oracle Fusion Cloud Applicationsのユーザーに対するロールのリスト。
Show Source
ネストされたスキーマ : スキーマ
タイプ: array
タイトル: Schemas
ユーザー・リソースのスキーマ。
Show Source
ネストされたスキーマ : faUser-item
タイプ: object
Show Source
  • タイトル: AccountType
    読取り専用: true
    個人またはパーティ関連を示すユーザーのアカウント・タイプ。
  • タイトル: AssignServiceAdminRoles
    サービス管理ロールがユーザーに割り当てられているかどうかを示します。 ユーザーの作成または更新時に、この属性を使用してORA_FND_DIAG_ADMINISTRATOR_JOB、ORA_ASM_APPLICATION_IMPLEMENTATION_CONSULTANT_JOBおよびORA_FND_IT_SECURITY_MANAGER_JOB管理ロールを割り当てることができます。
  • PartyInformation
    タイトル: PartyInformation
    ユーザーに関連付けられたパーティ情報。
  • タイトル: UserCategory
    ユーザーは、常に1つのカテゴリにのみ関連付けられます。 デフォルト・ユーザー・カテゴリ値はDEFAULTです。
  • WorkerInformation
    タイトル: WorkerInformation
    ユーザーに関連付けられた就業者情報。
ネストされたスキーマ : email-item
タイプ: object
Show Source
  • タイトル: Primary
    このEメールIDがプライマリ・アドレスであることを示します。 この値はtrueにハードコードされています。
  • タイトル: Type
    動作するようにハードコードされたEメールIDのタイプ。
  • タイトル: Value
    ユーザーの電子メール・アドレス。 サービス・プロバイダは、bjensen@EXAMPLE.COMのかわりにbjensen@example.comなど、これらのアドレスの正規形式を使用します。 標準型の値は、work、home、およびその他の値です。
ネストされたスキーマ : role-item
タイプ: object
Show Source
  • タイトル: Description
    読取り専用: true
    ロールの説明。
  • タイトル: DisplayName
    読取り専用: true
    ロールの表示名です。
  • タイトル: Id
    読取り専用: true
    ユーザーが直接メンバーシップを介して属することができるロールのIDのリスト。
  • タイトル: Value
    読取り専用: true
    ロールの値リスト。
ネストされたスキーマ : PartyInformation
タイプ: array
タイトル: PartyInformation
ユーザーに関連付けられたパーティ情報。
Show Source
ネストされたスキーマ : WorkerInformation
タイプ: array
タイトル: WorkerInformation
ユーザーに関連付けられた就業者情報。
Show Source
ネストされたスキーマ : partyInformation-item
タイプ: object
Show Source
  • タイトル: PartyNumber
    読取り専用: true
    ユーザーに関連付けられたパーティ番号。
  • タイトル: Party Usage
    読取り専用: true
    ユーザーに関連付けられたパーティ使用目的(サプライヤ担当者、パートナ担当者、顧客担当者など)。
ネストされたスキーマ : workerInformation-item
タイプ: object
Show Source
  • タイトル: BusinessUnit
    読取り専用: true
    ユーザーが属するビジネス・ユニット。
  • タイトル: Department
    読取り専用: true
    ユーザーが属する部門。
  • タイトル: Job
    読取り専用: true
    ユーザーの肩書。
  • タイトル: Manager
    読取り専用: true
    ユーザーのマネージャ名。
  • タイトル: PersonNumber
    読取り専用: true
    ユーザーに関連付けられている個人番号。
トップに戻る

例

次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行して、すべてのユーザーを取得する方法を示しています。

curl -i -u "<username>:<password>" -X GET https://servername.fa.us2.oraclecloud.com/hcmRestApi/scim/Users

レスポンス・ヘッダーの例

次に、レスポンス・ヘッダーの例を示します。

Status: HTTP/1.1 200 OK
Content-Type : application/json

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています:

{
  "itemsPerPage": 10000,
  "startIndex": 1,
  "Resources": [
    {
   "id": "C2A28F8ED9FA377A20C8E3D614936E88",
   "meta": {
  "created": "2015-12-09 21:02:44.000",
  "lastModified": "2016-10-20 10:54:56.029",
  "location": "http://<host>:<port>/hcmRestApi/scim/Users/C2A28F8ED9FA377A20C8E3D614936E88"
   },
   "schemas": [
  "urn:scim:schemas:core:2.0:User"
   ],
   "userName": "ZFRCE0543_John",
   "name": {
  "familyName": "Kyle",
  "givenName": "John"
   },
   "displayName": "John Kyle",
   "emails": [
  {
    "value": "John.K@oracle.com",
    "type": "W",
    "primary": true
  }
   ],
   "roles": [
  {
    "id": "40C4AE052EC2582286A6A0FB1514656C",
    "value": "ORA_PER_EMPLOYEE_ABSTRACT",
    "displayName": "Employee",
    "description": "Identifies the person as an employee."
  },
  {
    "id": "05E9F3576995F83E74EB3818FDCA8639",
    "value": "ORA_PER_LINE_MANAGER_ABSTRACT",
    "displayName": "Line Manager",
    "description": "Identifies the person as a line manager."
  }
   ],
   "active": true
 },
 ......
 ......
 ......
  ]
}
「トップに戻る」