モジュール名: auth

機能名	説明
login	ログインします
logout	ログアウトします

説明

MC APIを使用するためにログインします。
各APIを使用する場合は、まず最初にloginを実行します。
そして、実行結果として取得できるセッションIDを、それ以後のAPIリクエストのHTTPヘッダーX-As-SessionIdに設定します。
セッションIDの使用方法についてはAPIの実行方法を参照してください。

リクエスト

HTTPメソッド	リクエストURL
POST	`http://{Hostname}:{Port}/mcapi/auth/login`

リクエストパラメーター

パラメーター	必須	説明
userName	はい	ログインするためのユーザー名を指定します。
password	はい	パスワードを指定します。
timeout	いいえ	セッションタイムアウト時間を分で指定します。省略時は30分となります。
getRole	いいえ	ログインユーザーの権限を取得する場合は「true」で指定します。省略あるいは「false」の場合は取得しません。

リクエスト例

POST /mcapi/auth/login HTTP/1.1
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Content-Length: 30

userName=/guest&password=guest&getRole=true

レスポンス

HTTPステータスコード

APIの実行が成功した場合、HTTPステータスコードは200が返ります。

実行結果

ログインに成功するとセッションID、サーバー名、サーバーID、権限（指定した場合）が返ります。
権限はユーザーの基本権限である「administrator」、「developer」、「operator」のいずれかが返ります。
セッションIDの使用方法についてはAPIの実行方法を参照してください。

{
    "result": {
        "status": "success",
        "data": {
            "sessionId": "76B7EDBB1F14443FA538E62E05C5EEA4",
            "serverName": "testserver",
            "serverId": "d33e6e68-c6ba-45e1-8a81-ce5de009ff39",
            "role": [
                "operator"
            ]
        }
    }
}

エラーケース

下記以外のエラーについては、共通エラーコードを参照してください。

HTTPステータスコード	エラーコード	説明
400 Bad Request	2002	パラメーター userName, password の値が設定されなかった場合
400 Bad Request	2003	パラメーター timeout の値のデーター型が正しくなかった場合
403 Forbidden	3002	ログインに失敗した場合
500 Internal Server Error	5001	設定ファイルの読み込みに失敗した場合
	5101	内部の通信に失敗した場合
	5102	サーバー内部にエラーが発生した場合

▲ このページのトップへ

機能名: logout

説明

ログアウトします。