移動

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

ユーザーの作成

post

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

必要なロール: Administrator、CommandLineOperator

ユーザーの作成

リクエスト

この操作にはリクエスト・パラメータはありません。

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

• application/json

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

ルート・スキーマ: schema

タイプ: object

ソースの表示

• description: string
• emailId: string
• groupIds: array groupIds
  ユーザーにマップするグループIDの配列。
• name(必須): string
• password(必須): string (password)
  少なくとも6文字(1つの数字、1つの大文字、1つの小文字を含む)を入力してください。

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "password":{
            "type":"string",
            "description":"Enter at least 6 characters including one number, one uppercase and one lowercase letter.",
            "format":"password"
        },
        "emailId":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "groupIds":{
            "type":"array",
            "description":"Array of group ID to be mapped to user.",
            "items":{
                "type":"integer",
                "description":"group Ids.",
                "format":"int64"
            }
        }
    },
    "required":[
        "name",
        "password"
    ],
    "example":{
        "name":"User1",
        "password":"Abc@123",
        "emailId":"[e-mail]",
        "description":"user1",
        "groupIds":[
            0
        ]
    }
}

例:

{
    "name":"User1",
    "password":"Abc@123",
    "emailId":"[e-mail]",
    "description":"user1",
    "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"
    }
}

先頭に戻る

レスポンス

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

• application/json

201 レスポンス

ユーザーが正常に作成されました。

本文()

ルート・スキーマ: UserDetailsPostResponse

タイプ: object

ソースの表示

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

  例: 2024-02-03T10:15:30Z
• description: string
• emailId: string
• id: integer
  ユーザーID。

  例: 1001
• name: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"user ID.",
            "example":1001
        },
        "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"
        }
    },
    "example":{
        "id":1001,
        "name":"User1",
        "emailId":"[e-mail]",
        "createdOn":"2024-02-03T10:15:30Z",
        "description":"description"
    }
}

例:

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

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

先頭に戻る