ジャンプ先

• リクエスト
• レスポンス
• 例

ユーザーIDに基づいたユーザーの更新

patch

/iam/governance/selfservice/api/v1/users/{uuid}

指定されたユーザーのリクエスト・ペイロードで指定されたユーザー属性を更新します。リクエストは、Oracle Identity Managerで変更ユーザー操作に対して発生します。リクエストの詳細は、レスポンス・ペイロードで取得されます。

リクエスト

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

• application/json

パス・パラメータ

• uuid: string
  一意のユーザーID。一意のユーザーIDはユーザーの"usr_key"属性にマップされます。

本文()

更新するユーザーの属性。属性名を正しく指定する必要があります。属性名のエラーの場合、Oracle Identity Managerでは例外をスローします。

ルート・スキーマ: PatchUsersByUserIdRequest

型: object

ソースを表示

• add(optional): array add
• delete(optional): array delete
• update(optional): array update

{
    "properties":{
        "add":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Fields"
            }
        },
        "delete":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PatchUserRequestDelete"
            }
        },
        "update":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Fields"
            }
        }
    }
}

ネストされたスキーマ: add

型: array

ソースを表示

• [0]: object Fields

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Fields"
    }
}

ネストされたスキーマ: delete

型: array

ソースを表示

• [0]: object PatchUserRequestDelete

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PatchUserRequestDelete"
    }
}

ネストされたスキーマ: update

型: array

ソースを表示

• [0]: object Fields

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Fields"
    }
}

ネストされたスキーマ: Fields

型: object

ソースを表示

• name(optional): string
• value(optional): string

{
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    }
}

ネストされたスキーマ: PatchUserRequestDelete

型: object

ソースを表示

• name(optional): string

{
    "properties":{
        "name":{
            "type":"string"
        }
    }
}

先頭に戻る

レスポンス

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

• application/json

200レスポンス

成功

ヘッダー

• ResponseTime: string
  リクエストの処理にかかった時間(ミリ秒)を取得します。

本文()

ルート・スキーマ: PatchUserByUserIdResponse

型: object

ソースを表示

• id(optional): string
• links(optional): array links
• status(optional): string

{
    "properties":{
        "id":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkDataInstances"
            }
        }
    }
}

ネストされたスキーマ: links

型: array

ソースを表示

• [0]: object LinkDataInstances

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LinkDataInstances"
    }
}

ネストされたスキーマ: LinkDataInstances

型: object

ソースを表示

• href(optional): string
• rel(optional): string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

401レスポンス

未認可

404レスポンス

リクエスト・エンティティが見つからない

500レスポンス

内部サーバー・エラー

先頭に戻る

例

この例では、単一ユーザーにパッチを適用する機能を示します。ここに示す情報は、擬似システムを使用した場合のものであり、プロトタイプとして提供しています。

cURLの例

curl  -H "Content-Type: application/json"  -X PATCH  -u username:password  -d @patch.json https://pseudo.com/iam/governance/selfservice/api/v1/users/18008

PATCHリクエスト本文の例

次の例に、JSON形式のリクエスト本文のコンテンツを示します。

{
  "add": [
    {
      "name": "Last Name",
      "value": "updateed12345"
    }
  ],
  "delete": [
    {
      "name": "First Name"
    }
  ],
  "update": [
    {
      "name": "Display Name",
      "value": "supriya12345"
    }
  ]
}

PATCHレスポンス本文の例

JSON形式のレスポンス本文のコンテンツの例を次に示します。

{
  "links": [
    {
      "rel": "self",
      "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/18008"
    }
  ],
  "id": "18008",
  "status": "SUCCESS",
  "request": {
    "links": [
      {
        "rel": "self",
        "href": "http://pseudo.com/iam/governance/selfservice/api/v1/requests/10072"
      }
    ],
    "id": "10072"
  }
}

先頭に戻る