移動

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

Veridataへのログイン

get

http://{host}:{port}/veridata/v1/auth/login

必要なロール: Administrator、SuperUser、DetailMonitoringOperator、MonitoringOperator、CommandLineOperator

ユーザー認可トークンを取得します。ダイジェスト認可の一環としてVeridataユーザー資格証明を渡します。

リクエスト

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

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

セキュリティ

• DigestAuth: http
  タイプ: http

先頭に戻る

レスポンス

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

• application/json

200 レスポンス

ログインに成功しました。

本文()

ルート・スキーマ: Login

タイプ: object

ソースの表示

• roles: array roles
  ユーザー・ロール。
• token: string
  認可トークン。
• userId: integer
  ユーザーID

{
    "type":"object",
    "properties":{
        "roles":{
            "type":"array",
            "description":"User roles.",
            "items":{
                "type":"string"
            }
        },
        "token":{
            "type":"string",
            "description":"Authorization token."
        },
        "userId":{
            "type":"integer",
            "description":"User Id"
        }
    },
    "example":{
        "roles":[
            "ADMINISTRATOR"
        ],
        "token":"eyJraWQiOiJzaWduLXJ..",
        "userId":1004
    }
}

例:

{
    "roles":[
        "ADMINISTRATOR"
    ],
    "token":"eyJraWQiOiJzaWduLXJ..",
    "userId":1004
}

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

タイプ: array

ユーザー・ロール。

ソースの表示

• 配列: string

{
    "type":"array",
    "description":"User roles.",
    "items":{
        "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"
}

先頭に戻る