ジャンプ先

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

ユーザーへのパッチ適用

patch

/iam/governance/selfservice/api/v1/users

リクエスト・ペイロードで指定されたユーザー属性のリストで1つ以上のユーザーを更新します。ユーザーは、変更ユーザー・アクションの実行に必要な権限を持っている必要があります。

リクエスト

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

• application/json

本文()

更新するユーザーの属性リスト。"id"は必須フィールドです。"id"フィールドはユーザーのusr_key属性にマップされます。

ルート・スキーマ: PatchUsersRequest

型: object

ソースを表示

• users(optional): array users

{
    "properties":{
        "users":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PatchUserRequest"
            }
        }
    }
}

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

型: array

ソースを表示

• 配列: オブジェクト PatchUserRequest

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

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

型: object

ソースを表示

• add(optional): array add
• delete(optional): array delete
• id(optional): string
• requestId(optional): string
• update(optional): array update

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

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

型: array

ソースを表示

• 配列: オブジェクト Fields

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

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

型: array

ソースを表示

• 配列: オブジェクト PatchUserRequestDelete

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

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

型: array

ソースを表示

• 配列: オブジェクト 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
  リクエストの処理にかかった時間(ミリ秒)を取得します。

本文()

ルート・スキーマ: PatchUsersResponse

型: object

ソースを表示

• id(optional): string
• links(optional): array links
• request(optional): object RequestInfo
• requestId(optional): string
• status(optional): string

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

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

型: array

ソースを表示

• 配列: オブジェクト LinkDataInstances

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

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

型: object

ソースを表示

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

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

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

型: object

ソースを表示

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

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

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

型: array

ソースを表示

• 配列: オブジェクト LinkDataInstances

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

401レスポンス

未認可

403レスポンス

禁止

404レスポンス

リソースが見つからない

500レスポンス

内部サーバー・エラー

先頭に戻る

例

この例では、1つのリクエストで複数のユーザーにパッチを適用する機能を示します。ここで表示された情報は疑似システムに対するものであり、プロトタイプとして使用します。

cURLの例

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

PATCHリクエスト本文の例

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

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

PATCHレスポンス本文の例

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

{
  "users": [
    {
      "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/10073"
          }
        ],
        "requestId": "10073"
      }
    },
    {
      "links": [
        {
          "rel": "self",
          "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/18009"
        }
      ],
      "id": "18009",
      "status": " SUCCESS",
      "request": {
        "links": [
          {
            "rel": "self",
            "href": "http://pseudo.com/iam/governance/selfservice/api/v1/requests/10074"
          }
        ],
        "requestId": "10074"
      }
    }
  ]
}

先頭に戻る