ユーザーの置換
put
/hcmRestApi/scim/Users/{id}
ユーザーの置換
リクエスト
パス・パラメータ
- id(required): string
ユーザーの一意の識別子。
サポートされているメディア・タイプ
- */*
ルート・スキーマ : schema
タイプ:
Show Source
object
-
active: boolean
タイトル:
Active
ユーザーの管理ステータスを示します。 サービス・プロバイダは、この属性の定義値を決定します。 たとえば、trueはユーザーがログインできることを示し、falseはユーザー・アカウントが一時停止していることを示します。 -
displayName: string
タイトル:
DisplayName
ユーザーの表示名(通常はフルネーム)。 -
emails: array Emails
タイトル:
Emails
ユーザーの電子メール・アドレス。 サービス・プロバイダは、bjensen@EXAMPLE.COMのかわりにbjensen@example.comなど、これらのアドレスの正規形式を使用します。 標準型の値は、work、home、およびその他の値です。 -
id: string
タイトル:
Id
読取り専用:true
Oracle Fusion Cloud Applicationsのユーザー・リソースの一意の識別子。 -
meta: object Meta
タイトル:
Meta
ユーザー・リソースのメタデータです。 -
name: object Name
タイトル:
Name
ユーザー名のコンポーネント。 この属性は、Full name as a single string Individual component attributes Both variantを返します。 書式設定されたバージョンは、両方のバリアントが同じ名前を示すように、コンポーネント属性の結合方法を示します。 -
password: string
タイトル:
Password
ユーザーのクリア・テキスト・パスワード。 この属性は、新規ユーザーの初期パスワードを指定し、既存のユーザーのパスワードをリセットするために使用されます。 問合せにレスポンスしてパスワード属性は返されません。 -
roles: array Roles
タイトル:
Roles
Oracle Fusion Cloud Applicationsのユーザーに対するロールのリスト。 -
schemas(required): array Schemas
タイトル:
Schemas
ユーザー・リソースのスキーマ。 -
urn:scim:schemas:extension:fa:2.0:faUser: object faUser-item
-
userName(required): string
タイトル:
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
ネストされたスキーマ : faUser-item
タイプ:
Show Source
object
-
accountType: string
タイトル:
AccountType
読取り専用:true
個人またはパーティ関連を示すユーザーのアカウント・タイプ。 -
assignServiceAdminRoles: boolean
タイトル:
AssignServiceAdminRoles
サービス管理ロールがユーザーに割り当てられているかどうかを示します。 ユーザーの作成または更新時に、この属性を使用してORA_FND_DIAG_ADMINISTRATOR_JOB、ORA_ASM_APPLICATION_IMPLEMENTATION_CONSULTANT_JOBおよびORA_FND_IT_SECURITY_MANAGER_JOB管理ロールを割り当てることができます。 -
partyInformation: array PartyInformation
タイトル:
PartyInformation
ユーザーに関連付けられたパーティ情報。 -
userCategory: string
タイトル:
UserCategory
ユーザーは、常に1つのカテゴリにのみ関連付けられます。 デフォルト・ユーザー・カテゴリ値はDEFAULTです。 -
workerInformation: array WorkerInformation
タイトル:
WorkerInformation
ユーザーに関連付けられた就業者情報。
ネストされたスキーマ : email-item
タイプ:
Show Source
object
-
primary: boolean
タイトル:
Primary
このEメールIDがプライマリ・アドレスであることを示します。 この値はtrueにハードコードされています。 -
type: string
タイトル:
Type
動作するようにハードコードされたEメールIDのタイプ。 -
value: string
タイトル:
Value
ユーザーの電子メール・アドレス。 サービス・プロバイダは、bjensen@EXAMPLE.COMのかわりにbjensen@example.comなど、これらのアドレスの正規形式を使用します。 標準型の値は、work、home、およびその他の値です。
ネストされたスキーマ : role-item
タイプ:
Show Source
object
-
description: string
タイトル:
Description
読取り専用:true
ロールの説明。 -
displayName: string
タイトル:
DisplayName
読取り専用:true
ロールの表示名です。 -
id: string
タイトル:
Id
読取り専用:true
ユーザーが直接メンバーシップを介して属することができるロールのIDのリスト。 -
value: string
タイトル:
Value
読取り専用:true
ロールの値リスト。
ネストされたスキーマ : partyInformation-item
タイプ:
Show Source
object
-
partyNumber: string
タイトル:
PartyNumber
読取り専用:true
ユーザーに関連付けられたパーティ番号。 -
PartyUsage: string
タイトル:
Party Usage
読取り専用:true
ユーザーに関連付けられたパーティ使用目的(サプライヤ担当者、パートナ担当者、顧客担当者など)。
ネストされたスキーマ : workerInformation-item
タイプ:
Show Source
object
-
businessUnit: string
タイトル:
BusinessUnit
読取り専用:true
ユーザーが属するビジネス・ユニット。 -
department: string
タイトル:
Department
読取り専用:true
ユーザーが属する部門。 -
job: string
タイトル:
Job
読取り専用:true
ユーザーの肩書。 -
manager: string
タイトル:
Manager
読取り専用:true
ユーザーのマネージャ名。 -
personNumber: string
タイトル:
PersonNumber
読取り専用:true
ユーザーに関連付けられている個人番号。
レスポンス
サポートされているメディア・タイプ
- application/json
200 レスポンス
次の表に、このタスクのレスポンスを示します。
ルート・スキーマ : schema
タイプ:
Show Source
object
-
active: boolean
タイトル:
Active
ユーザーの管理ステータスを示します。 サービス・プロバイダは、この属性の定義値を決定します。 たとえば、trueはユーザーがログインできることを示し、falseはユーザー・アカウントが一時停止していることを示します。 -
displayName: string
タイトル:
DisplayName
ユーザーの表示名(通常はフルネーム)。 -
emails: array Emails
タイトル:
Emails
ユーザーの電子メール・アドレス。 サービス・プロバイダは、bjensen@EXAMPLE.COMのかわりにbjensen@example.comなど、これらのアドレスの正規形式を使用します。 標準型の値は、work、home、およびその他の値です。 -
id: string
タイトル:
Id
読取り専用:true
Oracle Fusion Cloud Applicationsのユーザー・リソースの一意の識別子。 -
meta: object Meta
タイトル:
Meta
ユーザー・リソースのメタデータです。 -
name: object Name
タイトル:
Name
ユーザー名のコンポーネント。 この属性は、Full name as a single string Individual component attributes Both variantを返します。 書式設定されたバージョンは、両方のバリアントが同じ名前を示すように、コンポーネント属性の結合方法を示します。 -
password: string
タイトル:
Password
ユーザーのクリア・テキスト・パスワード。 この属性は、新規ユーザーの初期パスワードを指定し、既存のユーザーのパスワードをリセットするために使用されます。 問合せにレスポンスしてパスワード属性は返されません。 -
roles: array Roles
タイトル:
Roles
Oracle Fusion Cloud Applicationsのユーザーに対するロールのリスト。 -
schemas(required): array Schemas
タイトル:
Schemas
ユーザー・リソースのスキーマ。 -
urn:scim:schemas:extension:fa:2.0:faUser: object faUser-item
-
userName(required): string
タイトル:
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
ネストされたスキーマ : faUser-item
タイプ:
Show Source
object
-
accountType: string
タイトル:
AccountType
読取り専用:true
個人またはパーティ関連を示すユーザーのアカウント・タイプ。 -
assignServiceAdminRoles: boolean
タイトル:
AssignServiceAdminRoles
サービス管理ロールがユーザーに割り当てられているかどうかを示します。 ユーザーの作成または更新時に、この属性を使用してORA_FND_DIAG_ADMINISTRATOR_JOB、ORA_ASM_APPLICATION_IMPLEMENTATION_CONSULTANT_JOBおよびORA_FND_IT_SECURITY_MANAGER_JOB管理ロールを割り当てることができます。 -
partyInformation: array PartyInformation
タイトル:
PartyInformation
ユーザーに関連付けられたパーティ情報。 -
userCategory: string
タイトル:
UserCategory
ユーザーは、常に1つのカテゴリにのみ関連付けられます。 デフォルト・ユーザー・カテゴリ値はDEFAULTです。 -
workerInformation: array WorkerInformation
タイトル:
WorkerInformation
ユーザーに関連付けられた就業者情報。
ネストされたスキーマ : email-item
タイプ:
Show Source
object
-
primary: boolean
タイトル:
Primary
このEメールIDがプライマリ・アドレスであることを示します。 この値はtrueにハードコードされています。 -
type: string
タイトル:
Type
動作するようにハードコードされたEメールIDのタイプ。 -
value: string
タイトル:
Value
ユーザーの電子メール・アドレス。 サービス・プロバイダは、bjensen@EXAMPLE.COMのかわりにbjensen@example.comなど、これらのアドレスの正規形式を使用します。 標準型の値は、work、home、およびその他の値です。
ネストされたスキーマ : role-item
タイプ:
Show Source
object
-
description: string
タイトル:
Description
読取り専用:true
ロールの説明。 -
displayName: string
タイトル:
DisplayName
読取り専用:true
ロールの表示名です。 -
id: string
タイトル:
Id
読取り専用:true
ユーザーが直接メンバーシップを介して属することができるロールのIDのリスト。 -
value: string
タイトル:
Value
読取り専用:true
ロールの値リスト。
ネストされたスキーマ : partyInformation-item
タイプ:
Show Source
object
-
partyNumber: string
タイトル:
PartyNumber
読取り専用:true
ユーザーに関連付けられたパーティ番号。 -
PartyUsage: string
タイトル:
Party Usage
読取り専用:true
ユーザーに関連付けられたパーティ使用目的(サプライヤ担当者、パートナ担当者、顧客担当者など)。
ネストされたスキーマ : workerInformation-item
タイプ:
Show Source
object
-
businessUnit: string
タイトル:
BusinessUnit
読取り専用:true
ユーザーが属するビジネス・ユニット。 -
department: string
タイトル:
Department
読取り専用:true
ユーザーが属する部門。 -
job: string
タイトル:
Job
読取り専用:true
ユーザーの肩書。 -
manager: string
タイトル:
Manager
読取り専用:true
ユーザーのマネージャ名。 -
personNumber: string
タイトル:
PersonNumber
読取り専用:true
ユーザーに関連付けられている個人番号。
例
次の例は、cURLを使用してRESTリソースに対してPUTリクエストを発行して、ユーザーを置換する方法を示しています。
curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X PUT -d <payload> https://servername.fa.us2.oraclecloud.com/hcmRestApi/scim/Users/3DEC63ED61FD0863E050F00A081B15FF
リクエスト・ペイロードの例
次の例は、JSON形式のリクエスト本文のコンテンツを示しています:
{ "schemas":[ "urn:scim:schemas:core:2.0:User" ], "name":{ "familyName":"Jones", "givenName":"Kerry" }, "active":true, "userName":"JONESK_OPERATIONS_UPDATED", "emails":[ { "primary":true, "value":"J.K@oracle.com", "type":"W" } ], "displayName":"Kerry Jones", "externalId":"externalId12345_Updated_by_PUT:" }
レスポンス・ヘッダーの例
次に、レスポンス・ヘッダーの例を示します。
Status: HTTP/1.1 200 OK Content-Type : application/json
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています:
{ "id": "3DEC63ED61FD0863E050F00A081B15FF", "meta": { "created": "2016-10-20 12:36:21.000", "lastModified": "2016-10-20 12:55:51.000", "location": "http://<host>:<port>/hcmRestApi/scim/Users/3DEC63ED61FD0863E050F00A081B15FF" }, "schemas": [ "urn:scim:schemas:core:2.0:User" ], "externalId": "externalId12345_Updated_by_PUT:", "userName": "JONESK_OPERATIONS_UPDATED", "name": { "familyName": "Jones", "givenName": "Kerry" }, "displayName": "Kerry Jones", "emails": [ { "value": "J.K@oracle.com", "type": "W", "primary": true } ], "active": true }