移動

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

ユーザーの取得

get

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

必要なロール: Administrator、CommandLineOperator

ユーザーの取得

リクエスト

パス・パラメータ

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

この操作にはリクエスト本文はありません。

先頭に戻る

レスポンス

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

• application/json

200 レスポンス

ユーザー詳細が正常に取得されました。

本文()

ルート・スキーマ: UserDetails

タイプ: object

ソースの表示

• createdOn: string (date-time)
  パターン: YYYY-MM-DDTHH:mm:ss.sssZ

  例: 2024-02-03T10:15:30Z
• description: string
• emailId: string
• groups: array groups
• id: integer (int64)
  ユーザーID。
• name: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"user ID.",
            "format":"int64"
        },
        "name":{
            "type":"string"
        },
        "emailId":{
            "type":"string"
        },
        "createdOn":{
            "type":"string",
            "format":"date-time",
            "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ",
            "example":"2024-02-03T10:15:30Z"
        },
        "description":{
            "type":"string"
        },
        "groups":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ListUserGroup"
            }
        }
    },
    "example":{
        "id":0,
        "name":"User1",
        "emailId":"[e-mail]",
        "createdOn":"2024-02-03T10:15:30Z",
        "description":"user1",
        "groups":[
            {
                "id":1001,
                "name":"Admin",
                "isModifiable":"true"
            }
        ]
    }
}

例:

{
    "id":0,
    "name":"User1",
    "emailId":"[e-mail]",
    "createdOn":"2024-02-03T10:15:30Z",
    "description":"user1",
    "groups":[
        {
            "id":1001,
            "name":"Admin",
            "isModifiable":"true"
        }
    ]
}

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

タイプ: array

ソースの表示

• 配列: object ListUserGroup

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ListUserGroup"
    }
}

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

タイプ: object

ソースの表示

• id: integer
• isModifiable: string
• name: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer"
        },
        "name":{
            "type":"string"
        },
        "isModifiable":{
            "type":"string"
        }
    }
}

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"
}

先頭に戻る