移動

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

ユーザーの置換

put

http://{host}:{port}/veridata/v1/services/admin/users/{Id}

必要なロール: Administrator、CommandLineOperator

ユーザーの置換

リクエスト

パス・パラメータ

• Id(必須): integer(int64)
  ユーザーID。

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

• application/json

リクエスト本文 - application/json ()

ルート・スキーマ: schema

タイプ: object

ソースの表示

• groupIds: array groupIds
  ユーザーにマップするグループIDの配列。

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/UpdateUserBasicDetails"
        }
    ],
    "properties":{
        "groupIds":{
            "type":"array",
            "description":"Array of group ID to be mapped to user.",
            "items":{
                "type":"integer",
                "description":"group Ids.",
                "format":"int64"
            }
        }
    },
    "example":{
        "emailId":"[e-mail]",
        "description":"user",
        "groupIds":[
            0
        ]
    }
}

すべて一致

ソースの表示

• object schema

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/UpdateUserBasicDetails"
        }
    ],
    "properties":{
        "groupIds":{
            "type":"array",
            "description":"Array of group ID to be mapped to user.",
            "items":{
                "type":"integer",
                "description":"group Ids.",
                "format":"int64"
            }
        }
    },
    "example":{
        "emailId":"[e-mail]",
        "description":"user",
        "groupIds":[
            0
        ]
    }
}

例:

{
    "emailId":"[e-mail]",
    "description":"user",
    "groupIds":[
        0
    ]
}

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

タイプ: array

ユーザーにマップするグループIDの配列。

ソースの表示

• 配列: integer(int64)
  グループID。

{
    "type":"array",
    "description":"Array of group ID to be mapped to user.",
    "items":{
        "type":"integer",
        "description":"group Ids.",
        "format":"int64"
    }
}

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

タイプ: object

ソースの表示

• description: string
• emailId: string

{
    "type":"object",
    "properties":{
        "emailId":{
            "type":"string"
        },
        "description":{
            "type":"string"
        }
    },
    "example":{
        "emailId":"[e-mail]",
        "description":"current user"
    }
}

例:

{
    "emailId":"[e-mail]",
    "description":"current user"
}

先頭に戻る

レスポンス

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

• application/json

200 レスポンス

ユーザーが正常に更新されました。

400 レスポンス

不正なリクエスト。

本文()

ルート・スキーマ: Error

タイプ: object

ソースの表示

• errCode: string
  Veridataのエラー・コード。
• errMsg: string
  Veridataのエラー・メッセージ。

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

例:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

401 レスポンス

権限がありません。

本文()

ルート・スキーマ: Error

タイプ: object

ソースの表示

• errCode: string
  Veridataのエラー・コード。
• errMsg: string
  Veridataのエラー・メッセージ。

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

例:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

404 レスポンス

見つかりません。

本文()

ルート・スキーマ: Error

タイプ: object

ソースの表示

• errCode: string
  Veridataのエラー・コード。
• errMsg: string
  Veridataのエラー・メッセージ。

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

例:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

500 レスポンス

サーバー・エラー。

本文()

ルート・スキーマ: Error

タイプ: object

ソースの表示

• errCode: string
  Veridataのエラー・コード。
• errMsg: string
  Veridataのエラー・メッセージ。

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

例:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

先頭に戻る