ジャンプ先

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

ユーザーIDに基づいたユーザーのプロキシへのパッチ適用

patch

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

プロキシは、追加、更新および削除できます。同じプロキシIDを更新および削除セクションに追加することはできません。同じユーザーを異なる時間間隔でプロキシとして追加できます。

リクエスト

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

• application/json

パス・パラメータ

• uuid: string
  プロキシを追加、更新または削除するユーザーの一意識別子。

本文()

ルート・スキーマ: UserProxiesPatchRequest

型: object

ソースを表示

• user(optional): object PatchUsersProxiesRequestInner

{
    "properties":{
        "user":{
            "$ref":"#/definitions/PatchUsersProxiesRequestInner"
        }
    }
}

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

型: object

ソースを表示

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

{
    "properties":{
        "add":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AddUserProxyRequest"
            }
        },
        "update":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UpdateUserProxyRequest"
            }
        },
        "delete":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DeleteUserProxyRequest"
            }
        }
    }
}

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

型: array

ソースを表示

• 配列: オブジェクト AddUserProxyRequest

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

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

型: array

ソースを表示

• 配列: オブジェクト DeleteUserProxyRequest

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

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

型: array

ソースを表示

• 配列: オブジェクト UpdateUserProxyRequest

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

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

型: object

ソースを表示

• endDate(optional): string
• requestId(optional): string
• startDate(optional): string
• userid(optional): string

{
    "properties":{
        "requestId":{
            "type":"string"
        },
        "userid":{
            "type":"string"
        },
        "startDate":{
            "type":"string"
        },
        "endDate":{
            "type":"string"
        }
    }
}

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

型: object

ソースを表示

• id(optional): string
• requestId(optional): string

{
    "properties":{
        "requestId":{
            "type":"string"
        },
        "id":{
            "type":"string"
        }
    }
}

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

型: object

ソースを表示

• endDate(optional): string
• id(optional): string
• parentUserId(optional): string
• requestId(optional): string
• startDate(optional): string
• userid(optional): string
• userkey(optional): string

{
    "properties":{
        "requestId":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "userid":{
            "type":"string"
        },
        "userkey":{
            "type":"string"
        },
        "parentUserId":{
            "type":"string"
        },
        "startDate":{
            "type":"string"
        },
        "endDate":{
            "type":"string"
        }
    }
}

先頭に戻る

レスポンス

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

• application/json

200レスポンス

成功

ヘッダー

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

本文()

ルート・スキーマ: PatchUsersProxiesResponse

型: object

ソースを表示

• user(optional): object PatchUsersProxiesResponseInner

{
    "properties":{
        "user":{
            "$ref":"#/definitions/PatchUsersProxiesResponseInner"
        }
    }
}

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

型: object

ソースを表示

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

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

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

型: array

ソースを表示

• 配列: オブジェクト AddUpdateUserProxyResponse

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

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

型: array

ソースを表示

• 配列: オブジェクト DeleteUserProxyResponse

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

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

型: array

ソースを表示

• 配列: オブジェクト AddUpdateUserProxyResponse

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

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

型: object

ソースを表示

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

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

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

型: array

ソースを表示

• 配列: オブジェクト LinkDataInstances

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

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

型: object

ソースを表示

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

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

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

型: object

ソースを表示

• requestId(optional): string
• status(optional): string
• userid(optional): string

{
    "properties":{
        "requestId":{
            "type":"string"
        },
        "userid":{
            "type":"string"
        },
        "status":{
            "type":"string"
        }
    }
}

401レスポンス

未認可

404レスポンス

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

500レスポンス

内部サーバー・エラー

先頭に戻る

例

この例では、ユーザーのプロキシ・リストを追加/更新/削除する機能を示します。ここに示す情報は、擬似システムを使用した場合のものであり、プロトタイプとして提供しています。

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/24/proxies

PATCHリクエスト本文の例

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

{
  "user": {
    "add": [
      {
        "userid": "17",
        "startDate": "2019-03-19T08:00:00Z",
        "endDate": "2019-03-19T12:00:00Z"
      },
      {
        "userid": "17",
        "startDate": "2019-03-22T08:00:00Z",
        "endDate": "2019-03-25T12:00:00Z"
      }
    ]
  }
}

PATCHレスポンス本文の例

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

{
    "user": {
        "links": [
            {
                "rel": "self",
                "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/24/proxies"
            }
        ],
        "add": [
            {
                "links": [
                    {
                        "rel": "self",
                        "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/17"
                    }
                ],
                "requestId": 0,
                "id": "3",
                "userid": "17",
                "status": "SUCCESS",
                "description": "NOT_STARTED",
                "relationship": "MANAGER"
            },
            {
                "links": [
                    {
                        "rel": "self",
                        "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/17"
                    }
                ],
                "requestId": 0,
                "id": "4",
                "userid": "17",
                "status": "SUCCESS",
                "description": "NOT_STARTED",
                "relationship": "MANAGER"
            }
        ]
    }
}

先頭に戻る