モジュール名: account

   
機能名 説明
domain/list ドメインの一覧を取得します
domain/create ドメインを作成します
domain/delete ドメインを削除します
domain/attribute/get ドメインの属性を取得します
domain/attribute/set ドメインの属性を設定します
domain/role/get ドメインの権限一覧を取得します
domain/role/set ドメインの権限を設定します
user/list ドメインのユーザー一覧を取得します
user/create ドメインのユーザーを作成します
user/delete ドメインのユーザーを削除します
user/role/get ユーザーの権限一覧を取得します
user/role/set ユーザーの権限を設定します
user/password/set ユーザーのパスワードを変更します
user/home/get ユーザーのホームフォルダーを取得します
user/home/set ユーザーのホームフォルダーを設定します
user/attribute/get ユーザーの属性を取得します
user/attribute/set ユーザーの属性を設定します
user/ftp/permission/get ユーザーのFTP設定情報を取得します
user/ftp/permission/set ユーザーのFTP設定情報を設定します
user/context/get ユーザーのコンテキスト設定を取得します
user/context/set ユーザーのコンテキスト設定を変更します
user/version/setting/get ユーザーのバージョン管理設定を取得します
user/version/setting/set ユーザーのバージョン管理設定を変更します
user/version/setting/setFile ユーザーのバージョン管理設定でSSHキーによる認証の詳細情報を設定します
user/version/fingerprints/get ユーザーのバージョン管理設定でSSHキーによる認証の場合のホストキーのフィンガープリント設定情報を取得します
user/version/fingerprints/add ユーザーのバージョン管理設定でSSHキーによる認証の場合のホストキーのフィンガープリントを追加します
user/version/fingerprints/delete ユーザーのバージョン管理設定でSSHキーによる認証の場合のホストキーのフィンガープリントを削除します
user/other/get ユーザーのその他設定を取得します
user/other/set ユーザーのその他設定を変更します
user/certificate/alias/list ユーザーの証明書のエイリアス一覧を取得します
user/certificate/show ユーザーの証明書の詳細情報を取得します
user/certificate/create ユーザーの証明書を作成します
user/certificate/delete ユーザーの証明書を削除します
user/certificate/csr/response/upload 認証された証明書を格納します
user/certificate/csr/download ユーザーの証明書のcsrファイルをダウンロードします
user/certificate/import ユーザーの証明書をインポートします
user/certificate/export ユーザーの証明書をエクスポートします
user/certificate/ca/list ユーザーの信頼するCA証明書の一覧を取得します
user/certificate/ca/show ユーザーの信頼するCA証明書の詳細情報を取得します
user/certificate/ca/delete ユーザーの信頼するCA証明書を削除します
user/certificate/ca/import ユーザーの信頼するCA証明書を追加します
user/certificate/partner/list ユーザーのパートナー証明書の一覧を取得します
user/certificate/partner/show ユーザーのパートナー証明書の詳細情報を取得します
user/certificate/partner/delete ユーザーのパートナー証明書を削除します
user/certificate/partner/import ユーザーのパートナー証明書を追加します

機能名: domain/list

説明

ドメインの一覧を取得します。
パラメーター domain で指定したドメインの配下のドメインをすべて取得します。
サブドメインもすべて取得します。

権限

administrator、developer、operator

リクエスト
HTTPメソッド リクエストURL
GET http://{Hostname}:{Port}/mcapi/account/domain/list
リクエストパラメーター
パラメーター 必須 説明
domain いいえ ドメイン一覧のルートを指定します。
指定しなかった場合はログインユーザーのドメインとなります。
リクエスト例
GET /mcapi/account/domain/list?domain=/ HTTP/1.1
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとドメイン一覧が返ります。

{
    "result": {
        "status": "success",
        "data": {
            "domain": {
                "/": {
                    "test1": {
                        "sub1": {},
                        "sub2": {}
                    },
                    "test2": {}
                }
            }
        }
    }
}
エラーケース

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

HTTPステータスコード エラーコード 説明
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4010 パラメーター domain で指定したドメインが存在しなかった場合
500 Internal Server Error 5101 内部の通信に失敗した場合
5102 サーバー内部にエラーが発生した場合

▲ このページのトップへ

機能名: domain/create

説明

ドメインを作成します。

権限

administrator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/account/domain/create
リクエストパラメーター
パラメーター 必須 説明
domain はい ドメイン名を指定します。
ドメイン名として利用できる文字列として以下の条件があります。
  • 半角の英字、数字、アンダースコア(_)、マイナス記号(-)が使用可能
  • 1文字目はアンダースコア(_)か英字のみ利用可能
  • 名前の長さには制限なし
  • 英字の大文字と小文字は区別される
password はい パスワードを指定します。
リクエスト例
POST /mcapi/account/domain/create HTTP/1.1
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Content-Length: 28

domain=/test1/sub1&password=
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとドメイン名が返ります。

{
    "result": {
        "status": "success",
        "data": {
            "domain": "/test1/sub1"
        }
    }
}
エラーケース

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

HTTPステータスコード エラーコード 説明
400 Bad Request 2001 パラメーター domain の値が正しくなかった場合
2002 パラメーター domain、password の値が設定されなかった場合
2403 同じパスのドメインが既に存在していた場合
403 Forbidden 3001 ログインしていなかった場合
500 Internal Server Error 5101 内部の通信に失敗した場合
5102 サーバー内部にエラーが発生した場合

▲ このページのトップへ

機能名: domain/delete

説明

ドメインを削除します。
ログインユーザーのドメインを削除できません。

権限

administrator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/account/domain/delete
リクエストパラメーター
パラメーター 必須 説明
domain はい ドメイン名を指定します。
deleteSubDomains いいえ 「true」で指定すると、サブドメインを含めて全部削除します。
「true」以外の場合、サブドメインがあったら削除できません。
deleteUsers いいえ 「true」で指定すると、所属ユーザーが存在しても削除します。
「true」以外の場合、所属ユーザーが存在したら削除できません。
リクエスト例
POST /mcapi/account/domain/delete HTTP/1.1
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Content-Length: 18

domain=/test1/sub1
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとドメインを削除します。

{
    "result": {
        "status": "success",
        "data": {}
    }
}
エラーケース

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

HTTPステータスコード エラーコード 説明
400 Bad Request 2002 パラメーター domain の値が設定されなかった場合
2404 サブドメインが存在するドメインを削除しようとした場合
2405 ログインユーザーが所属しているドメインを削除しようとした場合
2406 ユーザーが存在するドメインを削除しようとした場合
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4010 パラメーター domain で指定したドメインが存在しなかった場合
500 Internal Server Error 5101 内部の通信に失敗した場合
5102 サーバー内部にエラーが発生した場合

▲ このページのトップへ

機能名: domain/attribute/get

説明

ドメインの属性を取得します。

権限

administrator、developer、operator

リクエスト
HTTPメソッド リクエストURL
GET http://{Hostname}:{Port}/mcapi/account/domain/attribute/get
リクエストパラメーター
パラメーター 必須 説明
domain いいえ ドメインを指定します。
指定しなかった場合ログインユーザーのドメインとなります。
attribute いいえ 取得する属性のキーを指定します。
指定しなかった場合すべての属性を取得します。
リクエスト例
GET /mcapi/account/domain/attribute/get?domain=/ HTTP/1.1
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとドメインの属性一覧が返ります。

{
    "result": {
        "status": "success",
        "data": {
            "domain": "/",
            "attribute": {
                "attribute1": "value1",
                "attribute2": "value2"
            }
        }
    }
}
エラーケース

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

HTTPステータスコード エラーコード 説明
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4010 パラメーター domain で指定したドメインが存在しなかった場合
4011 パラメーター attribute で指定した属性が存在しなかった場合
500 Internal Server Error 5101 内部の通信に失敗した場合
5102 サーバー内部にエラーが発生した場合

▲ このページのトップへ

機能名: domain/attribute/set

説明

ドメインの属性を設定します。

権限

administrator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/account/domain/attribute/set
リクエストパラメーター
パラメーター 必須 説明
domain はい ドメイン名を指定します。
リクエスト例
設定する情報は、domain/attribute/getで取得できる形式の情報と同じ形式でリクエストのボディに設定します。
設定された情報で既存情報を上書きます。
POST /mcapi/account/user/role/set HTTP/1.1
Content-Type: application/json; charset=UTF-8
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
Content-Length: 59

{
    "attribute": {
        "attribute1": "value1",
        "attribute2": "value2"
    }
}
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとドメインの属性一覧が返ります。

{
    "result": {
        "status": "success",
        "data": {
            "domain": "/",
            "attribute": {
                "attribute1": "value1",
                "attribute2": "value2"
            }
        }
    }
}
エラーケース

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

HTTPステータスコード エラーコード 説明
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4010 パラメーター domain で指定したドメインが存在しなかった場合
500 Internal Server Error 5101 内部の通信に失敗した場合
5102 サーバー内部にエラーが発生した場合

▲ このページのトップへ

機能名: domain/role/get

説明

ドメインの権限一覧を取得します。

権限

administrator、developer、operator

リクエスト
HTTPメソッド リクエストURL
GET http://{Hostname}:{Port}/mcapi/account/domain/role/get
リクエストパラメーター
パラメーター 必須 説明
domain いいえ ドメインを指定します。
指定しなかった場合ログインユーザーのドメインとなります。
リクエスト例
GET /mcapi/account/domain/role/get?domain=/test1 HTTP/1.1
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとドメインの権限一覧が返ります。

{
    "result": {
        "status": "success",
        "data": {
            "role": [
                "role1",
                "role2"
            ]
        }
    }
}
エラーケース

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

HTTPステータスコード エラーコード 説明
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4010 パラメーター domain で指定したドメインが存在しなかった場合
500 Internal Server Error 5101 内部の通信に失敗した場合
5102 サーバー内部にエラーが発生した場合

▲ このページのトップへ

機能名: domain/role/set

説明

ドメインの権限を設定します。

権限

administrator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/account/domain/role/set
リクエストパラメーター
パラメーター 必須 説明
domain はい ドメインを指定します。
リクエスト例
設定する情報は、domain/role/getで取得できる形式の情報と同じ形式でリクエストのボディに設定します。
設定された情報で既存情報を上書きます。
POST /mcapi/account/domain/role/set?domain=/test1 HTTP/1.1
Content-Type: application/json; charset=UTF-8
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
Content-Length: 18

{
    "role": [
        "role3"
    ]
}
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとドメインの権限一覧が返ります。

{
    "result": {
        "status": "success",
        "data": {
            "role": [
                "role3"
            ]
        }
    }
}
エラーケース

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

HTTPステータスコード エラーコード 説明
400 Bad Request 2102 必須項目が設定されなかった場合
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4010 パラメーター domain で指定したドメインが存在しなかった場合
500 Internal Server Error 5101 内部の通信に失敗した場合
5102 サーバー内部にエラーが発生した場合

▲ このページのトップへ

機能名: user/list

説明

ドメインのユーザー一覧を取得します。

権限

administrator、developer、operator

リクエスト
HTTPメソッド リクエストURL
GET http://{Hostname}:{Port}/mcapi/account/user/list
リクエストパラメーター
パラメーター 必須 説明
domain いいえ 取得するユーザーのドメインを指定します。
指定しなかった場合ログインユーザーの所属ドメインとなります。
getRole いいえ ユーザーの権限を取得する場合は「true」で指定します。
省略あるいは「false」の場合は取得しません。
リクエスト例
GET /mcapi/account/user/list?domain=/ HTTP/1.1
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
レスポンス
HTTPステータスコード

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

実行結果(権限を取得しなかった場合)

実行に成功するとドメインのユーザー一覧が返ります。

{
    "result": {
        "status": "success",
        "data": {
            "user": {
                "/": [
                    "user1",
                    "user2"
                ]
            }
        }
    }
}
実行結果(権限を取得した場合)

実行に成功するとドメインのユーザー一覧(ユーザー名、権限)が返ります。

{
    "result": {
        "status": "success",
        "data": {
            "user": {
                "/": [
                    {
                      "name": "user1",
                      "role": "administrator"
                    },
                    {
                      "name": "user2",
                      "role": "developer"
                    }
                ]
            }
        }
    }
}
エラーケース

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

HTTPステータスコード エラーコード 説明
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4010 パラメーター domain で指定したドメインが存在しなかった場合
500 Internal Server Error 5101 内部の通信に失敗した場合
5102 サーバー内部にエラーが発生した場合

▲ このページのトップへ

機能名: user/create

説明

ドメインのユーザーを作成します。

権限

administrator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/account/user/create
リクエストパラメーター
パラメーター 必須 説明
domain はい ドメイン名を指定します。
userName はい ユーザー名を指定します。
ユーザ名として利用できる文字列として以下の条件があります。
  • 半角の英字、数字、アンダースコア(_)、マイナス記号(-)、ドット(.)が使用可能
  • 1文字目はアンダースコア(_)か英字のみ利用可能
  • 名前の長さには制限なし
  • 英字の大文字と小文字は区別される
password はい パスワードを指定します。
role はい ユーザーの権限を指定します。
「administrator」、「developer」、「operator 」のいずれかで指定します。
リクエスト例
POST /mcapi/account/user/create HTTP/1.1
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Content-Length: 28

domain=/test1/sub1&userName=user2&password=
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとドメインのユーザー一覧が返ります。

{
    "result": {
        "status": "success",
        "data": {
            "user": {
                "/test1/sub1": [
                    "user1",
                    "user2"
                ]
            }
        }
    }
}
エラーケース

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

HTTPステータスコード エラーコード 説明
400 Bad Request 2001 パラメーター userName の値が正しくなかった場合
2002 パラメーター domain、userName、password、role の値が設定されていなかった場合
2406 同じ名前のユーザーが既に存在していた場合
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4010 パラメーター domain で指定したドメインが存在しなかった場合
500 Internal Server Error 5101 内部の通信に失敗した場合
5102 サーバー内部にエラーが発生した場合
5103 サーバーのクリアでエラーが発生した場合

▲ このページのトップへ

機能名: user/delete

説明

ドメインのユーザーを削除します。
ログインユーザーを削除できません。
ドメインのasuユーザーも削除できません。

権限

administrator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/account/user/delete
リクエストパラメーター
パラメーター 必須 説明
domain はい ドメイン名を指定します。
userName はい ユーザー名を指定します。
deleteHome いいえ 「true」で指定された場合、ユーザーのホームディレクトリを削除します。
「false」または未設定の場合、ホームディレクトリを削除しません。
リクエスト例
POST /mcapi/account/user/delete HTTP/1.1
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Content-Length: 35

domain=/test1/sub1&userName=user2
レスポンス
HTTPステータスコード

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

実行結果

実行に成功すると削除したユーザーのドメインのユーザー一覧が返ります。

{
    "result": {
        "status": "success",
        "data": {
            "user": {
                "/test1/sub1": [
                    "user1"
                ]
            }
        }
    }
}
エラーケース

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

HTTPステータスコード エラーコード 説明
400 Bad Request 2002 パラメーター domain、userName の値が設定されなかった場合
2407 スーパーユーザーを削除しようとした場合
2408 ログインユーザーを削除しようとした場合
2414 ドメインのasuユーザーを削除しようとした場合
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4002 パラメーター userName で指定したユーザーが存在しなかった場合
4010 パラメーター domain で指定したドメインが存在しなかった場合
500 Internal Server Error 5101 内部の通信に失敗した場合
5102 サーバー内部にエラーが発生した場合
5103 サーバーのクリアでエラーが発生した場合

▲ このページのトップへ

機能名: user/role/get

説明

ユーザーの権限一覧を取得します。

権限

administrator、developer、operator

リクエスト
HTTPメソッド リクエストURL
GET http://{Hostname}:{Port}/mcapi/account/user/role/get
リクエストパラメーター
パラメーター 必須 説明
userName いいえ 権限を取得するユーザーを指定します。
指定しなかった場合ログインユーザーとなります。
リクエスト例
GET /mcapi/account/user/role/get?userName=/test1/user1 HTTP/1.1
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとユーザーの権限一覧が返ります。

{
    "result": {
        "status": "success",
        "data": {
            "role": {
                "basic": [
                    "operator"
                ],
                "extension": [
                    "role1"
                ]
            }
        }
    }
}
エラーケース

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

HTTPステータスコード エラーコード 説明
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4002 パラメーター userName で指定したユーザーが存在しなかった場合
500 Internal Server Error 5101 内部の通信に失敗した場合
5102 サーバー内部にエラーが発生した場合

▲ このページのトップへ

機能名: user/role/set

説明

ユーザーの権限を設定します。

権限

administrator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/account/user/role/set
リクエストパラメーター
なし
リクエスト例
設定する情報は、user/role/getで取得できる形式の情報と同じ形式でリクエストのボディに設定します。
ただし、スーパーユーザー(/asu)まはたドメインのasuの権限は設定できません。
POST /mcapi/account/user/role/set HTTP/1.1
Content-Type: application/json; charset=UTF-8
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
Content-Length: 81

{
    "user": "/abc1/test",
    "role": {
        "basic": [
            "operator"
        ],
        "extension": [
            "role1",
            "role2"
        ]
    }
}
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとユーザーの権限一覧が返ります。

{
    "result": {
        "status": "success",
        "data": {
            "role": {
                "basic": [
                    "operator"
                ],
                "extension": [
                    "role1",
                    "role2"
                ]
            }
        }
    }
}
エラーケース

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

HTTPステータスコード エラーコード 説明
400 Bad Request 2102 必須項目が設定されなかった場合
403 Forbidden 3000 スーパーユーザー(/asu)まはたドメインのasuの権限を設定しようとした場合
3001 ログインしていなかった場合
500 Internal Server Error 5101 内部の通信に失敗した場合
5102 サーバー内部にエラーが発生した場合
5103 サーバーのクリアでエラーが発生した場合

▲ このページのトップへ

機能名: user/password/set

説明

ユーザーのパスワードを変更します。
ログインユーザーが自分のパスワードを変更する場合、passwordのAPIを利用してください。

権限

administrator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/account/user/password/set
リクエストパラメーター
パラメーター 必須 説明
userName はい パスワードを変更するユーザーを指定します。
password はい 新しいパスワードを指定します。
リクエスト例
POST /mcapi/account/user/password/set HTTP/1.1
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
X-Fs-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
Content-Length: 31

userName=/test1/user1&password=
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとユーザーのパスワードを変更します。

{
    "result": {
        "status": "success",
        "data": {
            "user": "/test1/user1"
        }
    }
}
エラーケース

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

エラーコード HTTPステータスコード 説明
400 Bad Request 2002 パラメーター userName、password の値が設定されなかった場合
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4002 パラメーター userName で指定したユーザーが存在しなかった場合
500 Internal Server Error 5101 内部の通信に失敗した場合
5102 サーバー内部にエラーが発生した場合
5103 サーバーのクリアでエラーが発生した場合

▲ このページのトップへ

機能名: user/home/get

説明

ユーザーのホームフォルダーを取得します。

権限

administrator、developer、operator

リクエスト
HTTPメソッド リクエストURL
GET http://{Hostname}:{Port}/mcapi/account/user/home/get
リクエストパラメーター
パラメーター 必須 説明
userName いいえ ユーザーを指定します。
指定しなかった場合ログインユーザーとなります。
リクエスト例
GET /mcapi/account/user/home/get?userName=/test1/user1 HTTP/1.1
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとユーザーのホームフォルダーが返ります。
ホームフォルダー情報として、次の情報が取得できます。

{
    "result": {
        "status": "success",
        "data": {
            "home": {
                "user": "/test1/user1",
                "homeDirectory": "C:/home/@test1/user1",
                "attributeHome": ""
            }
        }
    }
}
エラーケース

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

HTTPステータスコード エラーコード 説明
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4002 パラメーター userName で指定したユーザーが存在しなかった場合
500 Internal Server Error 5001 ファイルの読み込みでエラーが発生した場合
5101 内部の通信に失敗した場合
5102 サーバー内部にエラーが発生した場合

▲ このページのトップへ

機能名: user/home/set

説明

ユーザーのホームフォルダーを設定します。

権限

administrator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/account/user/home/set
リクエストパラメーター
パラメーター 必須 説明
userName はい ホームフォルダーを変更するユーザーを指定します。
リクエスト例
ホームフォルダー情報として、次の情報を設定します。
POST /mcapi/account/user/home/set?userName=/abc/test HTTP/1.1
Content-Type: application/json; charset=UTF-8
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
Content-Length: 115

{
    "homeDirectory": "C:/home/@test1/user1",
    "copyFromCurrentHome": true,
    "deleteFormerHome": false
}
レスポンス
HTTPステータスコード

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

実行結果

実行に成功すると、user/home/getと同じ形式でユーザーのホームフォルダー情報が返ります。

{
    "result": {
        "status": "success",
        "data": {
            "home": {
                "user": "/test1/user1",
                "homeDirectory": "C:/home/@test1/user1",
                "attributeHome": "C:/home/@test1/user1"
            }
        }
    }
}
エラーケース

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

HTTPステータスコード エラーコード 説明
400 Bad Request 2102 必須項目が設定されなかった場合
2103 JSONデータのデータ型が正しくなかった場合
2701 新しいホームを元ホームのサブフォルダに指定し、元ホームをコピーあるいは削除しようとした場合
2702 新しいホームと元ホームは同じだった場合
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4002 キー user で指定したユーザーが存在しなかった場合
500 Internal Server Error 5001 ファイルの読み込みでエラーが発生した場合
5101 内部の通信に失敗した場合
5102 サーバー内部にエラーが発生した場合

▲ このページのトップへ

機能名: user/attribute/get

説明

ユーザーの属性を取得します。

権限

administrator、developer、operator

リクエスト
HTTPメソッド リクエストURL
GET http://{Hostname}:{Port}/mcapi/account/user/attribute/get
リクエストパラメーター
パラメーター 必須 説明
userName いいえ ユーザー名を指定します。
指定しなかった場合ログインユーザーとなります。
attribute いいえ 取得する属性のキーを指定します。
指定しなかった場合すべての属性を取得します。
リクエスト例
GET /mcapi/account/domain/attribute/get?userName=/abc/test HTTP/1.1
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとユーザーの属性一覧が返ります。

{
    "result": {
        "status": "success",
        "data": {
            "user": "/abc/test",
            "attribute": {
                "attribute1": "value1",
                "attribute2": "value2"
            }
        }
    }
}
エラーケース

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

HTTPステータスコード エラーコード 説明
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4002 パラメーター userName で指定したユーザーが存在しなかった場合
4011 パラメーター attribute で指定した属性が存在しなかった場合
500 Internal Server Error 5101 内部の通信に失敗した場合
5102 サーバー内部にエラーが発生した場合

▲ このページのトップへ

機能名: user/attribute/set

説明

ユーザーの属性を設定します。

権限

administrator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/account/user/attribute/set
リクエストパラメーター
パラメーター 必須 説明
userName はい ユーザー名を指定します。
リクエスト例
設定する情報は、user/attribute/getで取得できる形式の情報と同じ形式でリクエストのボディに設定します。
設定された情報で既存情報を上書きます。
POST /mcapi/account/user/attribute/set?userName=/abc/test HTTP/1.1
Content-Type: application/json; charset=UTF-8
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
Content-Length: 59

{
    "attribute": {
        "attribute1": "value1",
        "attribute2": "value2"
    }
}
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとユーザーの属性一覧が返ります。

{
    "result": {
        "status": "success",
        "data": {
            "user": "/abc/test",
            "attribute": {
                "attribute1": "value1",
                "attribute2": "value2"
            }
        }
    }
}
エラーケース

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

HTTPステータスコード エラーコード 説明
400 Bad Request 2102 必須項目が設定されなかった場合
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4002 パラメーター userName で指定したユーザーが存在しなかった場合
500 Internal Server Error 5101 内部の通信に失敗した場合
5102 サーバー内部にエラーが発生した場合

▲ このページのトップへ

機能名: user/ftp/permission/get

説明

ユーザーのFTP設定情報を取得します。

権限

administrator、developer、operator

リクエスト
HTTPメソッド リクエストURL
GET http://{Hostname}:{Port}/mcapi/account/user/ftp/permission/get
リクエストパラメーター
パラメーター 必須 説明
userName いいえ ユーザー名を指定します。
指定しなかった場合ログインユーザーとなります。
リクエスト例
GET /mcapi/account/domain/ftp/permission/get?userName=/abc/test HTTP/1.1
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとユーザーのFTP設定情報が返ります。
FTP設定情報として、次の情報が取得できます。

{
    "result": {
        "status": "success",
        "data": {
            "user": "/abc/test",
            "ftp": {
                "allowFtp": true,
                "allowUpload": false
            }
        }
    }
}
エラーケース

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

HTTPステータスコード エラーコード 説明
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4002 パラメーター userName で指定したユーザーが存在しなかった場合
500 Internal Server Error 5101 内部の通信に失敗した場合
5102 サーバー内部にエラーが発生した場合

▲ このページのトップへ

機能名: user/ftp/permission/set

説明

ユーザーのFTP権限を設定します。

権限

administrator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/account/user/ftp/permission/set
リクエストパラメーター
パラメーター 必須 説明
userName はい ユーザー名を指定します。
リクエスト例
設定する情報は、user/ftp/permission/getで取得できる形式の情報と同じ形式でリクエストのボディに設定します。
設定された情報で既存情報を上書きます。
POST /mcapi/account/user/ftp/permission/set?userName=/abc/test HTTP/1.1
Content-Type: application/json; charset=UTF-8
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
Content-Length: 47

{
    "ftp": {
        "allowFtp": true,
        "allowUpload": true
    }
}
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとユーザーのFTP設定情報が返ります。

{
    "result": {
        "status": "success",
        "data": {
            "user": "/abc/test",
            "ftp": {
                "allowFtp": true,
                "allowUpload": false
            }
        }
    }
}
エラーケース

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

HTTPステータスコード エラーコード 説明
400 Bad Request 2102 必須項目が設定されなかった場合
2103 JSONデータのデータ型が正しくなかった場合
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4002 パラメーター userName で指定したユーザーが存在しなかった場合
500 Internal Server Error 5101 内部の通信に失敗した場合
5102 サーバー内部にエラーが発生した場合

▲ このページのトップへ

機能名: user/context/get

説明

ユーザーのコンテキスト設定を取得します。

権限

administrator、developer、operator

リクエスト
HTTPメソッド リクエストURL
GET http://{Hostname}:{Port}/mcapi/account/user/context/get
リクエストパラメーター
パラメーター 必須 説明
userName いいえ ユーザーを指定します。
指定しなかった場合ログインユーザーとなります。
リクエスト例
GET /mcapi/account/user/context/get?userName=/test1/user1 HTTP/1.1
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとユーザーのコンテキスト設定が返ります。
コンテキスト設定情報として、次の情報が取得できます。

{
    "result": {
        "status": "success",
        "data": {
            "context": {
                "allowHttp": true,
                "contextPath": "/test/path",
                "basicAuthentication": true,
                "documentRoot": "system/htdocs",
                "welcomePage": "",
                "listing": false,
                "includes": "**/*.html",
                "excludes": "",
                "maxBodySize": 1048576,
                "autoRegister": false,
                "defaultFlow": "Flow1"
            }
        }
    }
}
エラーケース

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

HTTPステータスコード エラーコード 説明
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4002 パラメーター userName で指定したユーザーが存在しなかった場合
500 Internal Server Error 5101 内部の通信に失敗した場合
5102 サーバー内部にエラーが発生した場合

▲ このページのトップへ

機能名: user/context/set

説明

ユーザーのコンテキスト設定を変更します。

権限

administrator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/account/user/context/set
リクエストパラメーター
パラメーター 必須 説明
userName はい コンテキスト設定を変更するユーザーを指定します。
リクエスト例
設定する情報は、user/context/getで取得できる形式の情報と同じ形式でリクエストのボディに設定します。
設定された情報だけを更新します。
コンテキストパスはユニークです。
POST /mcapi/account/user/context/set?userName=/abc/test HTTP/1.1
Content-Type: application/json; charset=UTF-8
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
Content-Length: 223

{
    "context": {
        "allowHttp": true,
        "contextPath": "/test/path",
        "basicAuthentication": true,
        "documentRoot": "system/htdocs",
        "welcomePage": "",
        "listing": false,
        "includes": "**/*.html",
        "excludes": "",
        "maxBodySize": 1048576,
        "autoRegister": false,
        "defaultFlow": "Flow1"
    }
}
レスポンス
HTTPステータスコード

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

実行結果

実行に成功すると、user/context/getと同じ形式でユーザーのコンテキスト設定情報が返ります。

{
    "result": {
        "status": "success",
        "data": {
            "context": {
                "allowHttp": true,
                "contextPath": "/test/path",
                "basicAuthentication": true,
                "documentRoot": "system/htdocs",
                "welcomePage": "",
                "listing": false,
                "includes": "**/*.html",
                "excludes": "",
                "maxBodySize": 1048576,
                "autoRegister": false,
                "defaultFlow": "Flow1"
            }
        }
    }
}
エラーケース

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

HTTPステータスコード エラーコード 説明
400 Bad Request 2102 必須項目が設定されなかった場合
2103 JSONデータのデータ型が正しくなかった場合
2409 同じパスのコンテキスト設定情報が既に存在していた場合
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4002 パラメーター userName で指定したユーザーが存在しなかった場合
500 Internal Server Error 5101 内部の通信に失敗した場合
5102 サーバー内部にエラーが発生した場合

▲ このページのトップへ

機能名: user/version/setting/get

説明

ユーザーのバージョン管理設定を取得します。

権限

administrator、developer、operator

リクエスト
HTTPメソッド リクエストURL
GET http://{Hostname}:{Port}/mcapi/account/user/version/setting/get
リクエストパラメーター
パラメーター 必須 説明
userName いいえ ユーザーを指定します。
指定しなかった場合ログインユーザーとなります。
リクエスト例
GET /mcapi/account/user/version/setting/get?userName=/test1/user1 HTTP/1.1
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとユーザーのバージョン管理設定が返ります。
バージョン管理設定情報として、次の情報が取得できます。

{
    "result": {
        "status": "success",
        "data": {
            "versionSetting": {
                "allowVersionControl": true,
                "vcType": "SVN",
                "vcUrl": "svn://testHost/testHome",
                "userName": "testUser",
                "ignoreFilePatterns": "*.xfp2;*.$$$",
                "lockFilePatterns": "*.xfp;*.xsf"
            }
        }
    }
}
エラーケース

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

HTTPステータスコード エラーコード 説明
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4002 パラメーター userName で指定したユーザーが存在しなかった場合
500 Internal Server Error 5101 内部の通信に失敗した場合
5102 サーバー内部にエラーが発生した場合

▲ このページのトップへ

機能名: user/version/setting/set

説明

ユーザーのバージョン管理設定を変更します。

権限

administrator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/account/user/version/setting/set
リクエストパラメーター
パラメーター 必須 説明
userName はい バージョン管理設定を変更するユーザーを指定します。
リクエスト例
設定する情報は、user/version/setting/getで取得できる形式の情報と同じ形式でリクエストのボディに設定します。
ただし、リポジトリのタイプが「SVN」の場合は、パスワード(password)が必須です。また、URLに対応するフォルダをリポジトリに作成する(makeRepository)という設定が指定できます。作成する場合は「true」、しない場合は「false」で指定します。デフォルト値は「false」です。
リポジトリのタイプが「GIT」の場合は、 パスワード(password)またはAPIトークン(vcToken)が必須です。認証としてSSHキー(ssh)を指定する場合は、user/version/setting/setFileを使用します。
指定された情報だけを更新します。
POST /mcapi/account/user/version/setting/set?userName=/abc/test HTTP/1.1
Content-Type: application/json; charset=UTF-8
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
Content-Length: 274

{
    "versionSetting": {
        "allowVersionControl": true,
        "vcUrl": "svn://testHost/testHome",
        "userName": "testUser",
        "password": "",
        "ignoreFilePatterns": "*.xfp2;*.$$$",
        "lockFilePatterns": "*.xfp;*.xsf",
        "makeRepository": false
    }
}
レスポンス
HTTPステータスコード

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

実行結果

実行に成功すると、user/version/setting/getと同じ形式でユーザーのバージョン管理設定情報が返ります。
そして、下記の情報も返ります。

{
    "result": {
        "status": "success",
        "data": {
            "user": "/abc/test",
            "revision": 1000,
            "versionSetting": {
                "allowVersionControl": true,
                "vcUrl": "svn://testHost/testHome",
                "userName": "testUser",
                "ignoreFilePatterns": "*.xfp2;*.$$$",
                "lockFilePatterns": "*.xfp;*.xsf"
            }
        }
    }
}
エラーケース

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

HTTPステータスコード エラーコード 説明
400 Bad Request 2102 必須項目が設定されなかった場合
2103 JSONデータのデータ型が正しくなかった場合
2413 ユーザー名またはパスワードが正しくなかった場合
2415 Gitのユーザー名またはパスワードが正しくなかった場合
2416 Gitのユーザー名またはAPIトークンが正しくなかった場合
2417 Gitのユーザー名またはSSHキーの情報が正しくなかった場合
2418 GitサーバーがSSHキーによる認証を受け入れていない場合
2419 GitサーバーがSSH認証を要求した場合
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4002 パラメーター userName で指定したユーザーが存在しなかった場合
500 Internal Server Error 5101 内部の通信に失敗した場合
5102 サーバー内部にエラーが発生した場合
5107 SVNサーバーとの通信でエラーが発生した場合
5108 Gitサーバーとの通信でエラーが発生した場合

▲ このページのトップへ

機能名: user/version/setting/setFile

説明

ユーザーのバージョン管理設定でSSHキーによる認証の詳細情報を設定します。
multipart/form-dataの形式を使用してSSHキーファイルをアップロードします。

権限

administrator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/account/user/version/setting/setFile
リクエストパラメーター
なし
リクエスト例
multipart/form-data形式を使用して、SSHキーファイル(vcSshKey)をアップロードします。user/version/setting/setで指定する他の情報は、multipart/form-data形式のフォームデータとして指定します。
認証タイプ(vcAuthentication)は「ssh」である必要があります。また、sshキーパスフレーズ(vcPassphrase)を指定できます。
POST mcapi/account/user/version/setting/setFile HTTP/1.1
Content-Type: multipart/form-data; boundary=---------------------------81972253839649788001497290483
X-As-SessionId: D090E489A39E4F49ACE3976A9FB3E92F
Content-Length: 5368

-----------------------------81972253839649788001497290483
Content-Disposition: form-data; name="allowVersionControl"

on
-----------------------------81972253839649788001497290483
Content-Disposition: form-data; name="vcType"

GIT
-----------------------------81972253839649788001497290483
Content-Disposition: form-data; name="vcUrl"

git@gittest.com:username/gitrepository
-----------------------------81972253839649788001497290483
Content-Disposition: form-data; name="vcAuthentication"

ssh

-----------------------------81972253839649788001497290483
Content-Disposition: form-data; name="vcSshKey"; filename="id_rsa"
Content-Type: application/octet-stream

-----BEGIN OPENSSH PRIVATE KEY-----
b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAACFwAAAAdzc2gtcn
NhAAAAAwEAAQAAAgEAtAz3IjKWUBf3as8gN2PZAKYJk+t89VKxtC52Dyd31nZ5ll4K4dQg
svhXeKdV+2GPkVkM1X53TJmrH8IakRNNpStmSFhXPFtdsB89Ot4I+i7Yn5qMxpj2uU0c8N
tpXi6pa7Y5xuIzx1Ym6cDTS8OLDlfFulLVd/IwT02HUJRzENQC7A+fSIohC/SDb6Uofqeg
hHERfB5YFM3t6aN2x0BWBDx04sHx63v4A+9lRnOiLXCBERtPvRbCg31UIKKEY3gh62JzKY
sUfKpq3SmxwYSlqDjHva+swrlFWZos2Y93skwhqIsoPr17jKfhJq8HUCC+Af6FglN0z43p
g1SQg8VsMzdvMZxr38yos3Yx/xaDxxLDnE5Hna98kNUMydlpoO56itSTlu44ST4zbopZGL
uu8hq6CRlWJHo1+9VeCie5TuwE/qX26b9TLIWSqyokOz3FvfnFph6WP5pWcnbYFSMebziX
5Q+Rras2gliNYMnskwywZZ19FRtsBIHcJbCcXKv7ZEHU/2ualzqI+Y9g3QzERl1RLz0uIj
P3bZc+i2d7so+xGznnriBXZUj4t4OcPsGX3V61uqvSU2GG41UX1qhBeDbG9JNakDHr+aN3
QVAGR4buXF4F+26zv2cP9UvuhxlM66eD0RbpAhM+sMGOtal1U/BKv7HFlSanQTGbk6BBAE
sAAAdI8UOP4vFDj+IAAAAHc3NoLXJzYQAAAgEAtAz3IjKWUBf3as8gN2PZAKYJk+t89VKx
tC52Dyd31nZ5ll4K4dQgsvhXeKdV+2GPkVkM1X53TJmrH8IakRNNpStmSFhXPFtdsB89Ot
4I+i7Yn5qMxpj2uU0c8NtpXi6pa7Y5xuIzx1Ym6cDTS8OLDlfFulLVd/IwT02HUJRzENQC
7A+fSIohC/SDb6UofqeghHERfB5YFM3t6aN2x0BWBDx04sHx63v4A+9lRnOiLXCBERtPvR
bCg31UIKKEY3gh62JzKYsUfKpq3SmxwYSlqDjHva+swrlFWZos2Y93skwhqIsoPr17jKfh
Jq8HUCC+Af6FglN0z43pg1SQg8VsMzdvMZxr38yos3Yx/xaDxxLDnE5Hna98kNUMydlpoO
56itSTlu44ST4zbopZGLuu8hq6CRlWJHo1+9VeCie5TuwE/qX26b9TLIWSqyokOz3FvfnF
ph6WP5pWcnbYFSMebziX5Q+Rras2gliNYMnskwywZZ19FRtsBIHcJbCcXKv7ZEHU/2ualz
qI+Y9g3QzERl1RLz0uIjP3bZc+i2d7so+xGznnriBXZUj4t4OcPsGX3V61uqvSU2GG41UX
1qhBeDbG9JNakDHr+aN3QVAGR4buXF4F+26zv2cP9UvuhxlM66eD0RbpAhM+sMGOtal1U/
BKv7HFlSanQTGbk6BBAEsAAAADAQABAAACABJ7LjbVaHZqL1xITG9DEXguktcbGeV4ioML
LdUaYQOjf5F+r7FEe+LC+P+KdZnrBriNonKbm5VCRL1qyB1SFOs6TDJq1vF8E17LphZPyi
4b9uJTE9Yix1h34NucOfGP6pYCy2VtvJDed/oQb9/b/38GZWZdsEmyk2DgfV45DqKQkIg4
hkoE26WFgKRKGKD/hctya7AI0VO5W41a2QtUwD+JERphe/qG7AtDXGrh3ai6XpUp74JiPq
8Ogz8iT2KCZ0DpBxchjoXJXFS9PeC2Q+bDhUUkLiCCseqjl6zxPAESLXZGamgePPtQFB1L
Y/3GjppXzM520IupbmmrmXXdIuDmtiyh9ciSyjBfXqWu9J06kjObX3GNxcLWq62vZEyOml
+NiRNc1DRmYjCjEuBQdQK2u6g66hUfgiX3F4bpN1wectqeVFPgSY58hpFzXwen7JC1gqCJ
k7S6TLsYHmO8XFikO4eRLDgN17fN9+asUt2cdFRzcvkcJhoyNauXaoYKvY9sOIsc4XuHBJ
JruXK9DPqnmCHXGbllZ6IW9JXueViTMyQObFjZ5U3hNGYX+XRDNoPzn/rQdYS1Opr735lT
MneA/+IaRKnMR4LS+q5YnJrRq6YAQGhmdIxliZzriN6jTYofrDgUepnBXnUhYVapGd3azL
w4oP2Cef3i2LeeDRgpAAABAFa9pSmZjYQSCQnRpXwX2HxV62j1GFVpukOtTTOHO6suDpKz
b930JzuBGpjbj9rqWE+wk3RESJYZHARD1EGntmM5hszdDNIpISzRC7aUdMjpjtmC0Uc0dy
WMa2C2fQAXVgmnWmZvLyTm9ulLJ9aRvwYpvHrR08XuJ6/gHcEHfUBybT9L0/Z4mTbj64Uy
y/Vz0XF3fEZdeNVAy5fmROr9yqoqoEIDPMvBzaJu8o2Xo6XbCfOgL/fC7AfzhiEIcS6sVo
jmDz4z27N6OVB202w6SMoaqCrripGGNgzrbuy186uPNXeN43QfH3639FzmqxMK2mg5S/QO
gDeIj6+o+rxXeBwAAAEBAOpjBID0+93EgsmJS0Q+f/ffF2dF71JhpTvlrF59Ee28nZp8su
6fp6E3RwaG7aPxvMsbhCmxFha8mpZf/Lgjhi2dN2JEzBC9ej0yie8gj8zdE4bSsPcpOx6b
htC41B84rZ8/7Rhq/3Vms5sGK5tOZZsHErifSOrExPbSIoFsq/9iJWAEcgufDKK0hT2NHX
e96mlK1Ls6QvmN8dCTEVYPzIJoR1ryOhThBIsqOqTdVB2QJOOr+9NNmXaPwnLQA+7TuhG5
CBziEhUSVEGr7FUo5N8eHAtF+ve093kbs71/WZHSpSi879avMr4D/Zi1RgbEVrMoa6rfd/
9/E4nzEPfC1P8AAAEBAMSnRxgZhQnrfZoC0Ok08eQ6et80CA1xW/+Arzr9wv2WABsgVRCz
G/pGXKsmoxHAgzh3oLumHs5cqv0Zc9CxUtrVfXe4RevgN8dTr8BESXzZklthPa4iJor5Fp
6RlBmfxZxhri/csRmfCKKFFxwQdgD7JZ3DLOw4pUD87cs1uToHQhZLa8szWnjF0wdbeZ3w
yvpGJ/++MdeK4KOYTRWFWyDRXIHSR4xtSokghjey64dYPXEINOCmUq6/3Ray8S0zpKr1Ec
ogM3zkCADir4qGyuEbf+r+sVB8JEmD+YLzEm1TofkJVZkshQLx6yVBGRSSWyw3B5jyvjl7
DLR1w733mLUAAAAMc2FtODRAZ214LmF0AQIDBAUGBw==
-----END OPENSSH PRIVATE KEY-----

-----------------------------81972253839649788001497290483
Content-Disposition: form-data; name="fileDisplay"

id_rsa
-----------------------------81972253839649788001497290483
Content-Disposition: form-data; name="vcPassphrase"


-----------------------------81972253839649788001497290483
Content-Disposition: form-data; name="vcEmail"

user@company.com
-----------------------------81972253839649788001497290483
Content-Disposition: form-data; name="ignoreFilePatterns"

.*;_*;*.xfp2;*.$$$
-----------------------------81972253839649788001497290483
Content-Disposition: form-data; name="lockFilePatterns"

*.xfp;*.xmp;*.xvar;*.xsf
-----------------------------81972253839649788001497290483
Content-Disposition: form-data; name="userName"

/abcde/test


-----------------------------81972253839649788001497290483--
レスポンス
HTTPステータスコード

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

実行に成功すると、user/version/setting/getと同じ形式でユーザーのバージョン管理設定情報が返ります。
そして、下記の情報も返ります。

{
    "result": {
        "status": "success",
        "data": {
            "user": "/abc/test",
            "revision": 1000,
            "versionSetting": {
                "allowVersionControl": true,
                "vcUrl": "git@github.com:username/test.git",
                "userName": "username",
                "ignoreFilePatterns": "*.xfp2;*.$$$",
                "lockFilePatterns": "*.xfp;*.xsf"
            }
        }
    }
}
エラーケース

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

HTTPステータスコード エラーコード 説明
400 Bad Request 2102 必須項目が設定されなかった場合
2203 SSHキーファイルのデータを取得できなかった場合
2413 ユーザー名またはパスワードが正しくなかった場合
2415 Gitのユーザー名またはパスワードが正しくなかった場合
2416 Gitのユーザー名またはAPIトークンが正しくなかった場合
2417 Gitのユーザー名またはSSHキーの情報が正しくなかった場合
2418 GitサーバーがSSHキーによる認証を受け入れていない場合
2419 GitサーバーがSSH認証を要求した場合
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4002 パラメーター userName で指定したユーザーが存在しなかった場合
500 Internal Server Error 5101 内部の通信に失敗した場合
5102 サーバー内部にエラーが発生した場合
5108 Gitサーバーとの通信でエラーが発生した場合

▲ このページのトップへ

機能名: user/version/fingerprints/get

説明

ユーザーのバージョン管理設定でSSHキーによる認証の場合のホストキーのフィンガープリント設定情報を取得します。

権限

administrator、developer、operator

リクエスト
HTTPメソッド リクエストURL
GET http://{Hostname}:{Port}/mcapi/account/user/version/fingerprints/get
リクエストパラメーター
パラメーター 必須 説明
userName はい SSHホストキーのフィンガープリント設定情報を取得するユーザーを指定します。
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとユーザーのSSHホストキーの現在設定されているフィンガープリント設定情報がすべて返ります。

{
	"result": {
		"status": "success",
		"data": {
			"fingerprint": [
				"SHA256:nThbg6kXUpJWGl7E1IGOCspRomTxdCARLviKw6E5SY8"
			]
		}
	}
}
エラーケース

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

HTTPステータスコード エラーコード 説明
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4002 パラメーター userName で指定したユーザーが存在しなかった場合
500 Internal Server Error 5101 内部の通信に失敗した場合
5102 サーバー内部にエラーが発生した場合

▲ このページのトップへ

機能名: user/version/fingerprints/add

説明

ユーザーのバージョン管理設定でSSHキーによる認証の場合のホストキーのフィンガープリントを追加します。

権限

administrator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/account/user/version/fingerprints/add
リクエストパラメーター
パラメーター 必須 説明
userName はい SSHキーによる認証の場合のホストキーのフィンガープリントを追加するユーザーを指定します。
リクエスト例
POST /mcapi/account/user/version/fingerprints/add?userName=/abc/test HTTP/1.1
Content-Type: application/json; charset=UTF-8
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
Content-Length: 68

{
	"fingerprint":"SHA256:p2QAMXNIC1TJYWeIOttrVc98/R1BUFWu3/LiyKgUfQM"
}
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとユーザーのSSHホストキーの現在設定されているフィンガープリント設定情報がすべて返ります。

{
	"result": {
		"status": "success",
		"data": {
			"fingerprint": [
				"SHA256:nThbg6kXUpJWGl7E1IGOCspRomTxdCARLviKw6E5SY8",
				"SHA256:p2QAMXNIC1TJYWeIOttrVc98/R1BUFWu3/LiyKgUfQM"
			]
		}
	}
}
エラーケース

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

HTTPステータスコード エラーコード 説明
400 Bad Request 2102 必須項目が設定されなかった場合
2103 JSONデータのデータ型が正しくなかった場合
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4002 パラメーター userName で指定したユーザーが存在しなかった場合
500 Internal Server Error 5101 内部の通信に失敗した場合
5102 サーバー内部にエラーが発生した場合

▲ このページのトップへ

機能名: user/version/fingerprints/delete

説明

ユーザーのバージョン管理設定でSSHキーによる認証の場合のホストキーのフィンガープリントを削除します。

権限

administrator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/account/user/version/fingerprints/delete
リクエストパラメーター
パラメーター 必須 説明
userName はい SSHキーによる認証の場合のホストキーのフィンガープリントを削除するユーザーを指定します。
リクエスト例
POST /mcapi/account/user/version/fingerprints/delete?userName=/abc/test HTTP/1.1
Content-Type: application/json; charset=UTF-8
X-As-SessionId: D090E489A39E4F49ACE3976A9FB3E92F
Content-Length: 68

{
	"fingerprint":"SHA256:p2QAMXNIC1TJYWeIOttrVc98/R1BUFWu3/LiyKgUfQM"
}
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとユーザーのSSHホストキーの現在設定されているフィンガープリント設定情報がすべて返ります。

{
	"result": {
		"status": "success",
		"data": {
			"fingerprint": [
				"SHA256:nThbg6kXUpJWGl7E1IGOCspRomTxdCARLviKw6E5SY8"
			]
		}
	}
}
エラーケース

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

HTTPステータスコード エラーコード 説明
400 Bad Request 2102 必須項目が設定されなかった場合
2103 JSONデータのデータ型が正しくなかった場合
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4002 パラメーター userName で指定したユーザーが存在しなかった場合
500 Internal Server Error 5101 内部の通信に失敗した場合
5102 サーバー内部にエラーが発生した場合

▲ このページのトップへ

機能名: user/other/get

説明

ユーザーのその他設定を取得します。

権限

administrator、developer、operator

リクエスト
HTTPメソッド リクエストURL
GET http://{Hostname}:{Port}/mcapi/account/user/other/get
リクエストパラメーター
パラメーター 必須 説明
userName いいえ ユーザーを指定します。
指定しなかった場合ログインユーザーとなります。
リクエスト例
GET /mcapi/account/user/other/get?userName=/test1/user1 HTTP/1.1
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとユーザーのその他設定が返ります。
その他設定情報として、次の情報が取得できます。

{
    "result": {
        "status": "success",
        "data": {
            "other": {
                "makeExportFileWhenUpdate": true,
                "exportFileName": "trigger.xml",
                "designerReadOnly": true
            }
        }
    }
}
エラーケース

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

HTTPステータスコード エラーコード 説明
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4002 パラメーター userName で指定したユーザーが存在しなかった場合
500 Internal Server Error 5101 内部の通信に失敗した場合
5102 サーバー内部にエラーが発生した場合

▲ このページのトップへ

機能名: user/other/set

説明

ユーザーのその他設定を変更します。

権限

administrator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/account/user/other/set
リクエストパラメーター
パラメーター 必須 説明
userName はい その他設定を変更するユーザーを指定します。
リクエスト例
設定する情報は、user/other/getで取得できる形式の情報と同じ形式でリクエストのボディに設定します。
設定された情報だけを更新します。
POST /mcapi/account/user/other/set?userName=/abc/test HTTP/1.1
Content-Type: application/json; charset=UTF-8
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
Content-Length: 125

{
    "other": {
        "makeExportFileWhenUpdate": true,
        "exportFileName": "trigger.xml",
        "designerReadOnly": true
    }
}
レスポンス
HTTPステータスコード

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

実行結果

実行に成功すると、user/other/getと同じ形式でユーザーのその他設定情報が返ります。

{
    "result": {
        "status": "success",
        "data": {
            "other": {
                "makeExportFileWhenUpdate": true,
                "exportFileName": "trigger.xml",
                "designerReadOnly": true
            }
        }
    }
}
エラーケース

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

HTTPステータスコード エラーコード 説明
400 Bad Request 2103 JSONデータのデータ型が正しくなかった場合
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4002 パラメーター userName で指定したユーザーが存在しなかった場合
500 Internal Server Error 5101 内部の通信に失敗した場合
5102 サーバー内部にエラーが発生した場合

▲ このページのトップへ

機能名: user/certificate/alias/list

説明

ユーザーの証明書のエイリアス一覧を取得します。

権限

administrator、operator

リクエスト
HTTPメソッド リクエストURL
GET http://{Hostname}:{Port}/mcapi/account/user/certificate/alias/list
リクエストパラメーター
パラメーター 必須 説明
userName いいえ ユーザー名を指定します。
指定しなかった場合ログインユーザーとなります。
リクエスト例
GET /mcapi/account/user/certificate/alias/list?userName=/test HTTP/1.1
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとユーザーの証明書のエイリアス一覧が返ります。存在しない場合は空配列です。

{
    "result": {
        "status": "success",
        "data": {
            "alias": [
                "first",
                "second"
            ]
        }
    }
}
エラーケース

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

HTTPステータスコード エラーコード 説明
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4002 パラメーター userName で指定したユーザーが存在しなかった場合
500 Internal Server Error 5102 サーバー内部にエラーが発生した場合

▲ このページのトップへ

機能名: user/certificate/show

説明

ユーザーの証明書の詳細情報を取得します。

権限

administrator、operator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/account/user/certificate/show
リクエストパラメーター
パラメーター 必須 説明
alias はい 取得する証明書のエイリアスを指定します。
password はい 格納用パスワードを入力します。
userName いいえ ユーザー名を指定します。
指定しなかった場合ログインユーザーとなります。
リクエスト例
POST /mcapi/account/user/certificate/show HTTP/1.1
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
X-Fs-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
Content-Length: 43

password=123456&userName=/test&alias=second
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとユーザーの証明書の詳細情報が返ります。
ユーザーの証明書の発行先、発行者情報として、次の情報が取得できます。

ユーザーの証明書のその他情報として、次の情報が取得できます。

{
    "result": {
        "status": "success",
        "data": {
            "certificate": {
                "subject": {
                    "C": "JP",
                    "ST": "StateName",
                    "L": "LocalityName",
                    "O": "OrganizationName",
                    "OU": "UnitName",
                    "CN": "subject"
                },
                "issuer": {
                    "C": "JP",
                    "ST": "CaState",
                    "L": "CaCity",
                    "O": "CaOrg",
                    "OU": "CaUnit",
                    "CN": "CA"
                },
                "notValidBefore": "2013-01-13 09:56:53",
                "notValidAfter": "2013-04-13 09:56:53",
                "version": "1",
                "signatureAlgorithm": "SHA1withRSA",
                "usage": {
                    "digitalSignature": true,
                    "nonRepudiation": false,
                    "keyEncipherment": false,
                    "dataEncipherment": false,
                    "keyAgreement": true,
                    "keyCertSign": false,
                    "cRLSign": false,
                    "encipherOnly": true,
                    "decipherOnly": false
                },
                "fingerprintSha1": "c0:a3:ce:70:bb:a8:8a:94:d4:37:d7:75:3f:4b:7b:8d:d1:f7:d5:59",
                "fingerprintSha256": "b4:13:f4:7d:13:ee:2f:e6:c8:45:b2:ee:14:1a:f8:1d:e8:58:df:4e:c5:49:a5:8b:79:70:bb:96:64:5b:c8:d2",
                "serialNumber": "1378947413351",
                "chainInfo": [
                    "CN=CA,OU=CaUnit,O=CaOrg,L=CaCity,ST=CaState,C=JP",
                    "CN=CA,OU=CaUnit,O=CaOrg,L=CaCity,ST=CaState,C=JP"
                ]
            }
        }
    }
}
エラーケース

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

HTTPステータスコード エラーコード 説明
400 Bad Request 2002 パラメーター password, alias が設定されていなかった場合
2401 パスワードが正しくなかった場合
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4002 パラメーター userName で指定したユーザーが存在しなかった場合
4012 証明書情報が存在しない場合
500 Internal Server Error 5102 サーバー内部にエラーが発生した場合
5304 証明書情報の解析でエラーが発生した場合

▲ このページのトップへ

機能名: user/certificate/create

説明

ユーザーの証明書を作成します。

権限

administrator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/account/user/certificate/create
リクエストパラメーター
パラメーター 必須 説明
alias はい 作成する証明書のエイリアスを指定します。
同じエイリアスの証明書が存在したら削除されます。
userName いいえ ユーザー名を指定します。
指定しなかった場合ログインユーザーとなります。
リクエスト例
ユーザーの証明書情報として、次の情報がリクエストのボディに設定します。
POST /mcapi/account/user/certificate/create?userName=/test&alias=alias HTTP/1.1
Content-Type: application/json; charset=UTF-8
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
Content-Length: 318

{
    "certificate": {
        "C": "JP",
        "ST": "StateName",
        "L": "LocalityName",
        "O": "OrganizationName",
        "OU": "UnitName",
        "CN": "subject",
        "password": "123456",
        "privateKeyPassword": "123456",
        "keySize": 1024,
        "keyAlgorithm": "RSA",
        "validPeriod": 30,
        "signatureAlgorithm": "sha256WithRSAEncryption"
    }
}
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとユーザーの証明書を作成します。

{
    "result": {
        "status": "success",
        "data": {
        }
    }
}
エラーケース

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

HTTPステータスコード エラーコード 説明
400 Bad Request 2002 パラメーター alias が設定されていなかった場合
2101 JSONデータの値が正しくなかった場合
2102 必須項目が設定されなかった場合
2103 JSONデータのデータ型が正しくなかった場合
2107 キー password, privateKeyPassword の値が6文字未満の場合
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4002 パラメーター userName で指定したユーザーが存在しなかった場合
500 Internal Server Error 5002 ファイルの書き込みでエラーが発生した場合
5101 内部の通信に失敗した場合
5102 サーバー内部にエラーが発生した場合
5305 キーストア格納時にエラーが発生した場合
5306 キーストアの読み込みあるいは削除時にエラーが発生した場合
5307 キーの作成でエラーが発生した場合
5308 プライベートキーの取得でエラーが発生した場合
5309 CSRの作成でエラーが発生した場合

▲ このページのトップへ

機能名: user/certificate/delete

説明

ユーザーの証明書を削除します。csrファイルも削除します。

権限

administrator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/account/user/certificate/delete
リクエストパラメーター
パラメーター 必須 説明
alias はい 削除する証明書のエイリアスを指定します。
password はい 格納用パスワードを入力します。
userName いいえ ユーザー名を指定します。
指定しなかった場合ログインユーザーとなります。
リクエスト例
POST /mcapi/account/user/certificate/delete HTTP/1.1
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Content-Length: 42

userName=/test&password=123456&alias=alias
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとユーザーの証明書を削除します。

{
    "result": {
        "status": "success",
        "data": {}
    }
}
エラーケース

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

HTTPステータスコード エラーコード 説明
400 Bad Request 2002 パラメーター password, alias が設定されていなかった場合
2401 パスワードが正しくなかった場合
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4002 パラメーター userName で指定したユーザーが存在しなかった場合
4012 証明書情報が存在しない場合
500 Internal Server Error 5002 ファイルの書き込みでエラーが発生した場合
5101 内部の通信に失敗した場合
5102 サーバー内部にエラーが発生した場合
5305 キーストア格納時にエラーが発生した場合
5306 キーストアの読み込みあるいは削除時にエラーが発生した場合

▲ このページのトップへ

機能名: user/certificate/import

説明

ユーザーの証明書をインポートします。

権限

administrator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/account/user/certificate/import
リクエストパラメーター
なし
リクエスト例

HTMLでファイルをアップロードするときに送信されるmultipart/form-data形式と同じ形式のデータをPOSTします。
対応ファイル形式は、PKCS#12、JavaKeyStoreになります。
ユーザーの証明書情報として、次の情報がリクエストのボディに設定します。

POST /mcapi/account/user/certificate/import HTTP/1.1
Content-Type: multipart/form-data; boundary=---------------------------120912416424652; charset=UTF-8
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
Content-Length: 333

-----------------------------120912416424652 
Content-Disposition: form-data; name="alias"

alias
-----------------------------120912416424652 
Content-Disposition: form-data; name="userName"

/test
-----------------------------120912416424652 
Content-Disposition: form-data; name="filePassword"

123456
-----------------------------120912416424652
Content-Disposition: form-data; name="password"

987654
-----------------------------120912416424652
Content-Disposition: form-data; name="privateKeyPassword"

zyxwvu
-----------------------------120912416424652
Content-Disposition: form-data; name="filedata"; filename="test.p12" 
Content-Type: text/plain

[リクエストのデータとしてファイルがバイナリ形式で付加されます]
-----------------------------120912416424652--
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとユーザーの証明書情報が返ります。

{
    "result": {
        "status": "success",
        "data": {
            "certificate": {
                "subject": {
                    "C": "JP",
                    "ST": "StateName",
                    "L": "LocalityName",
                    "O": "OrganizationName",
                    "OU": "UnitName",
                    "CN": "subject"
                },
                "issuer": {
                    "C": "JP",
                    "ST": "CaState",
                    "L": "CaCity",
                    "O": "CaOrg",
                    "OU": "CaUnit",
                    "CN": "CA"
                },
                "notValidBefore": "2013-01-13 09:56:53",
                "notValidAfter": "2013-04-13 09:56:53",
                "version": "1",
                "signatureAlgorithm": "SHA1withRSA",
                "usage": {
                    "digitalSignature": true,
                    "nonRepudiation": false,
                    "keyEncipherment": false,
                    "dataEncipherment": false,
                    "keyAgreement": true,
                    "keyCertSign": false,
                    "cRLSign": false,
                    "encipherOnly": true,
                    "decipherOnly": false
                },
                "fingerprintSha1": "c0:a3:ce:70:bb:a8:8a:94:d4:37:d7:75:3f:4b:7b:8d:d1:f7:d5:59",
                "fingerprintSha256": "b4:13:f4:7d:13:ee:2f:e6:c8:45:b2:ee:14:1a:f8:1d:e8:58:df:4e:c5:49:a5:8b:79:70:bb:96:64:5b:c8:d2",
                "serialNumber": "1378947413351",
                "chainInfo": [
                    "CN=CA,OU=CaUnit,O=CaOrg,L=CaCity,ST=CaState,C=JP",
                    "CN=CA,OU=CaUnit,O=CaOrg,L=CaCity,ST=CaState,C=JP"
                ]
            }
        }
    }
}
エラーケース

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

HTTPステータスコード エラーコード 説明
400 Bad Request 2002 パラメーター alias, password, privateKeyPassword, filePassword が設定されていなかった場合
2004 パラメーター password, privateKeyPassword の値が6文字未満の場合
2202 リクエストからファイル名を取得できなかった場合
2203 リクエストからファイルデータを取得できなかった場合
2204 アップロードされた証明書情報の解析でエラーが発生した場合
2301 リクエストデータの解析でエラーが発生した場合
2401 パスワードが正しくなかった場合
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4002 パラメーター userName で指定したユーザーが存在しなかった場合
500 Internal Server Error 5002 ファイルの書き込みでエラーが発生した場合
5101 内部の通信に失敗した場合
5102 サーバー内部にエラーが発生した場合
5305 キーストア格納時にエラーが発生した場合
5306 キーストアの読み込みあるいは削除時にエラーが発生した場合

▲ このページのトップへ

機能名: user/certificate/csr/download

説明

ユーザーの証明書のcsrファイルをダウンロードします。

権限

administrator、operator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/account/user/certificate/csr/download
リクエストパラメーター
パラメーター 必須 説明
alias はい 証明書のエイリアスを指定します。
password はい 格納用パスワードを入力します。
privateKeyPassword はい 秘密鍵用パスワードを入力します。
userName いいえ ユーザー名を指定します。
指定しなかった場合ログインユーザーとなります。
リクエスト例
GET /mcapi/account/user/certificate/csr/download HTTP/1.1
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
X-Fs-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
Content-Length: 68

password=123456&privateKeyPassword=abcdef&userName=/test&alias=alias
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとcsrファイルが返ります。

HTTP/1.1 200 OK
Content-Type: application/zip
Content-Length: 44556
Content-Disposition: filename="csr.zip"

[レスポンスのボディとしてcsrファイルがバイナリ形式で付加されます]
エラーケース

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

エラーコード HTTPステータスコード 説明
400 Bad Request 2002 パラメーター alias, password, peivateKeyPassword が設定されていなかった場合
2401 パスワードが正しくなかった場合
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4002 パラメーター userName で指定したユーザーが存在しなかった場合
4012 証明書情報が存在しない場合
500 Internal Server Error 5002 ファイルの書き込みでエラーが発生した場合
5006 ファイルをZIPした時にエラーが発生した場合
5102 サーバー内部にエラーが発生した場合
5310 csrファイルが存在しない場合

▲ このページのトップへ

機能名: user/certificate/csr/response/upload

説明

認証されたユーザーの証明書を格納します。

権限

administrator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/account/user/certificate/csr/response/upload
リクエストパラメーター
なし
リクエスト例

HTMLでファイルをアップロードするときに送信されるmultipart/form-data形式と同じ形式のデータをPOSTします。
対応ファイル形式は、X.509、pkcs#7のPEM、DERになります。
ユーザーの証明書情報として、次の情報をリクエストのボディに設定します。

認証局の証明書が必要ない場合、chainFileをアップロードする必要はありません。

POST /mcapi/account/user/certificate/csr/response/upload?userName=/test HTTP/1.1
Content-Type: multipart/form-data; boundary=---------------------------120912416424652; charset=UTF-8
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
Content-Length: 333

-----------------------------120912416424652 
Content-Disposition: form-data; name="alias"

alias
-----------------------------120912416424652 
Content-Disposition: form-data; name="userName"

/test
-----------------------------120912416424652
Content-Disposition: form-data; name="password"

123456
-----------------------------120912416424652
Content-Disposition: form-data; name="privateKeyPassword"

abcdef
-----------------------------120912416424652
Content-Disposition: form-data; name="certFile"; filename="test.crt" 
Content-Type: text/plain

[証明書ファイルをバイナリ形式で付加します]
-----------------------------120912416424652
Content-Disposition: form-data; name="chainFile"; filename="ca.crt" 
Content-Type: text/plain

[認証局の証明書ファイルをバイナリ形式で付加します]
-----------------------------120912416424652--
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとユーザーの証明書が格納されます。

{
    "result": {
        "status": "success",
        "data": {}
    }
}
エラーケース

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

HTTPステータスコード エラーコード 説明
400 Bad Request 2002 パラメーター alias, password, privateKeyPassword が設定されていなかった場合
2202 リクエストからファイル名を取得できなかった場合
2203 リクエストからファイルデータを取得できなかった場合
2204 アップロードされた証明書情報の解析でエラーが発生した場合
2301 リクエストデータの解析でエラーが発生した場合
2401 パスワードが正しくなかった場合
2801 公開鍵のバリデーションでエラーが発生した場合
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4002 パラメーター userName で指定したユーザーが存在しなかった場合
4012 証明書情報が存在しない場合
500 Internal Server Error 5002 ファイルの書き込みでエラーが発生した場合
5101 内部の通信に失敗した場合
5102 サーバー内部にエラーが発生した場合
5305 キーストア格納時にエラーが発生した場合
5306 キーストアの読み込みあるいは削除時にエラーが発生した場合

▲ このページのトップへ

機能名: user/certificate/export

説明

ユーザーの証明書を指定した形式でエクスポートします。

権限

administrator、operator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/account/user/certificate/export
リクエストパラメーター
パラメーター 必須 説明
alias はい 証明書のエイリアスを指定します。
password はい 格納用パスワードを入力します。
outputFormat はい ファイルの出力形式を指定します。
「X509」あるいは「PKCS7」
dataFormat はい 内部データ形式を指定します。
「PEM」あるいは「DER」
userName いいえ ユーザー名を指定します。
指定しなかった場合ログインユーザーとなります。
リクエスト例
POST /mcapi/account/user/certificate/export HTTP/1.1
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
Content-Length: 75

password=123456&outputFormat=X509&dataFormat=PEM&userName=/test&alias=alias
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとユーザーの証明書ファイルが返ります。

HTTP/1.1 200 OK
Content-Type: application/zip
Content-Length: 44556
Content-Disposition: filename="certs.zip"

[レスポンスのボディとして証明書ファイルがバイナリ形式で付加されます]
エラーケース

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

エラーコード HTTPステータスコード 説明
400 Bad Request 2002 パラメーター password, outputFormat, dataFormat が設定されていなかった場合
2003 パラメーター outputFormat, dataFormat の値が正しくなかった場合
2401 パスワードが正しくなかった場合
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4002 パラメーター userName で指定したユーザーが存在しなかった場合
4012 証明書情報が存在しない場合
500 Internal Server Error 5001 ファイルの読み込みでエラーが発生した場合
5002 ファイルの書き込みでエラーが発生した場合
5006 ファイルをZIPした時にエラーが発生した場合
5102 サーバー内部にエラーが発生した場合
5303 証明書情報の読み込みでエラーが発生した場合
5306 キーストアの読み込みあるいは削除時にエラーが発生した場合

▲ このページのトップへ

機能名: user/certificate/ca/list

説明

ユーザーの信頼する認証局の証明書の一覧を取得します。

権限

administrator、operator

リクエスト
HTTPメソッド リクエストURL
GET http://{Hostname}:{Port}/mcapi/account/user/certificate/ca/list
リクエストパラメーター
パラメーター 必須 説明
userName いいえ ユーザー名を指定します。
指定しなかった場合ログインユーザーとなります。
リクエスト例
GET /mcapi/account/user/certificate/ca/list?userName=/test HTTP/1.1
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとユーザーの信頼する認証局の証明書一覧が返ります。
証明書情報として、次の情報が取得できします。

{
    "result": {
        "status": "success",
        "data": {
            "certificate": [
                {
                    "alias": "7095ce58-629a-429a-b39f-fd702e342e6c",
                    "subject": "CN=Certum CA,O=Unizeto Sp. z o.o.,C=PL",
                    "issuer": "CN=Certum CA,O=Unizeto Sp. z o.o.,C=PL",
                    "notBefore": "2002-06-11 19:46:39",
                    "notAfter": "2027-06-11 19:46:39"
                },
                {
                    "alias": "b6307f15-1c1d-48ff-a49c-e0c0b5709a5c0",
                    "subject": "CN=subject,OU=UnitName,O=OrganizationName,L=LocalityName,ST=StateName,C=JP",
                    "issuer": "CN=ca,OU=caUnit,O=caOrg,L=caCity,ST=csState,C=JP",
                    "notBefore": "2013-10-02 20:47:04",
                    "notAfter": "2014-10-02 20:47:04"
                }
            ]
        }
    }
}
エラーケース

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

HTTPステータスコード エラーコード 説明
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4002 パラメーター userName で指定したユーザーが存在しなかった場合
500 Internal Server Error 5102 サーバー内部にエラーが発生した場合
5304 証明書情報の解析でエラーが発生した場合
5306 キーストアの読み込みあるいは削除時にエラーが発生した場合

▲ このページのトップへ

機能名: user/certificate/ca/show

説明

ユーザーの信頼する認証局の証明書の詳細情報を取得します。

権限

administrator、operator

リクエスト
HTTPメソッド リクエストURL
GET http://{Hostname}:{Port}/mcapi/account/user/certificate/ca/show
リクエストパラメーター
パラメーター 必須 説明
alias はい CA証明書のエイリアスを入力します。
userName いいえ ユーザー名を指定します。
指定しなかった場合ログインユーザーとなります。
リクエスト例
GET /mcapi/account/user/certificate/ca/show?alias=7095ce58-629a-429a-b39f-fd702e342e6c&userName=/test HTTP/1.1
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
レスポンス
HTTPステータスコード

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

実行結果

実行に成功すると証明書の詳細情報が返ります。
証明書の発行先、発行者情報として、次の情報が取得できます。

証明書のその他情報として、次の情報が取得できます。

{
    "result": {
        "status": "success",
        "data": {
            "certificate": {
                "subject": {
                    "C": "JP",
                    "ST": "StateName",
                    "L": "LocalityName",
                    "O": "OrganizationName",
                    "OU": "UnitName",
                    "CN": "subject"
                },
                "issuer": {
                    "C": "JP",
                    "ST": "CaState",
                    "L": "CaCity",
                    "O": "CaOrg",
                    "OU": "CaUnit",
                    "CN": "CA"
                },
                "notValidBefore": "2013-01-13 09:56:53",
                "notValidAfter": "2013-04-13 09:56:53",
                "version": "1",
                "signatureAlgorithm": "SHA1withRSA",
                "usage": {
                    "digitalSignature": true,
                    "nonRepudiation": false,
                    "keyEncipherment": false,
                    "dataEncipherment": false,
                    "keyAgreement": true,
                    "keyCertSign": false,
                    "cRLSign": false,
                    "encipherOnly": true,
                    "decipherOnly": false
                },
                "fingerprintSha1": "c0:a3:ce:70:bb:a8:8a:94:d4:37:d7:75:3f:4b:7b:8d:d1:f7:d5:59",
                "fingerprintSha256": "b4:13:f4:7d:13:ee:2f:e6:c8:45:b2:ee:14:1a:f8:1d:e8:58:df:4e:c5:49:a5:8b:79:70:bb:96:64:5b:c8:d2",
                "serialNumber": "1378947413351"
            }
        }
    }
}
エラーケース

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

HTTPステータスコード エラーコード 説明
400 Bad Request 2002 パラメーター alias が設定されていなかった場合
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4002 パラメーター userName で指定したユーザーが存在しなかった場合
4012 証明書情報が存在しない場合
500 Internal Server Error 5102 サーバー内部にエラーが発生した場合
5304 証明書情報の解析でエラーが発生した場合
5306 キーストアの読み込みあるいは削除時にエラーが発生した場合

▲ このページのトップへ

機能名: user/certificate/ca/delete

説明

ユーザーの信頼する認証局の証明書を削除します。

権限

administrator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/account/user/certificate/ca/delete
リクエストパラメーター
パラメーター 必須 説明
alias はい 削除する証明書のエイリアスを指定します。
userName いいえ ユーザー名を指定します。
指定しなかった場合ログインユーザーとなります。
リクエスト例
POST /mcapi/account/user/certificate/ca/delete?userName=/test HTTP/1.1
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Content-Length: 10

alias=test
レスポンス
HTTPステータスコード

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

実行結果

実行に成功すると証明書を削除します。残っているユーザーの信頼する認証局の証明書の一覧が返ります。

{
    "result": {
        "status": "success",
        "data": {
            "certificate": [
                {
                    "alias": "7095ce58-629a-429a-b39f-fd702e342e6c",
                    "subject": "CN=Certum CA,O=Unizeto Sp. z o.o.,C=PL",
                    "issuer": "CN=Certum CA,O=Unizeto Sp. z o.o.,C=PL",
                    "notBefore": "2002-06-11 19:46:39",
                    "notAfter": "2027-06-11 19:46:39"
                },
                {
                    "alias": "b6307f15-1c1d-48ff-a49c-e0c0b5709a5c0",
                    "subject": "CN=subject,OU=UnitName,O=OrganizationName,L=LocalityName,ST=StateName,C=JP",
                    "issuer": "CN=ca,OU=caUnit,O=caOrg,L=caCity,ST=csState,C=JP",
                    "notBefore": "2013-10-02 20:47:04",
                    "notAfter": "2014-10-02 20:47:04"
                }
            ]
        }
    }
}
エラーケース

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

HTTPステータスコード エラーコード 説明
400 Bad Request 2002 パラメーター alias が設定されていなかった場合
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4002 パラメーター userName で指定したユーザーが存在しなかった場合
4012 証明書情報が存在しない場合
500 Internal Server Error 5002 ファイルの書き込みでエラーが発生した場合
5102 サーバー内部にエラーが発生した場合
5304 証明書情報の解析でエラーが発生した場合
5305 キーストア格納時にエラーが発生した場合
5306 キーストアの読み込みあるいは削除時にエラーが発生した場合

▲ このページのトップへ

機能名: user/certificate/ca/import

説明

ユーザーの信頼する認証局の証明書を追加します。アップロード後エイリアスが自動的に発行されます。

権限

administrator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/account/user/certificate/ca/import
リクエストパラメーター
パラメーター 必須 説明
userName いいえ ユーザー名を指定します。
指定しなかった場合ログインユーザーとなります。
リクエスト例

HTMLでファイルをアップロードするときに送信されるmultipart/form-data形式と同じ形式のデータをPOSTします。
対応ファイル形式は、X.509、pkcs#7のPEM、DERになります。
証明書情報として、次の情報をリクエストのボディに設定します。

POST /mcapi/account/user/certificate/ca/import?userName=/test HTTP/1.1
Content-Type: multipart/form-data; boundary=---------------------------120912416424652; charset=UTF-8
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
Content-Length: 333

-----------------------------120912416424652
Content-Disposition: form-data; name="caFile"; filename="test.cer" 
Content-Type: text/plain

[リクエストのデータとしてファイルがバイナリ形式で付加されます]
-----------------------------120912416424652--
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとユーザーの信頼する認証局の証明書が追加されます。CA証明書の一覧が返ります。

{
    "result": {
        "status": "success",
        "data": {
            "certificate": [
                {
                    "alias": "7095ce58-629a-429a-b39f-fd702e342e6c",
                    "subject": "CN=Certum CA,O=Unizeto Sp. z o.o.,C=PL",
                    "issuer": "CN=Certum CA,O=Unizeto Sp. z o.o.,C=PL",
                    "notBefore": "2002-06-11 19:46:39",
                    "notAfter": "2027-06-11 19:46:39"
                },
                {
                    "alias": "b6307f15-1c1d-48ff-a49c-e0c0b5709a5c0",
                    "subject": "CN=subject,OU=UnitName,O=OrganizationName,L=LocalityName,ST=StateName,C=JP",
                    "issuer": "CN=ca,OU=caUnit,O=caOrg,L=caCity,ST=csState,C=JP",
                    "notBefore": "2013-10-02 20:47:04",
                    "notAfter": "2014-10-02 20:47:04"
                }
            ]
        }
    }
}
エラーケース

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

HTTPステータスコード エラーコード 説明
400 Bad Request 2202 リクエストからファイル名を取得できなかった場合
2203 リクエストからファイルデータを取得できなかった場合
2204 アップロードされた証明書情報の解析でエラーが発生した場合
2301 リクエストデータの解析でエラーが発生した場合
2802 証明書は有効期限が切れた場合
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4002 パラメーター userName で指定したユーザーが存在しなかった場合
500 Internal Server Error 5002 ファイルの書き込みでエラーが発生した場合
5102 サーバー内部にエラーが発生した場合
5304 証明書情報の解析でエラーが発生した場合
5305 キーストア格納時にエラーが発生した場合
5306 キーストアの読み込みあるいは削除時にエラーが発生した場合

▲ このページのトップへ

機能名: user/certificate/partner/list

説明

ユーザーのパートナー証明書の一覧を取得します。

権限

administrator、operator

リクエスト
HTTPメソッド リクエストURL
GET http://{Hostname}:{Port}/mcapi/account/user/certificate/partner/list
リクエストパラメーター
パラメーター 必須 説明
userName いいえ ユーザー名を指定します。
指定しなかった場合ログインユーザーとなります。
リクエスト例
GET /mcapi/account/user/certificate/partner/list HTTP/1.1
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとユーザーのパートナー証明書一覧が返ります。
証明書情報として、次の情報が取得できします。

{
    "result": {
        "status": "success",
        "data": {
            "certificate": [
                {
                    "alias": "7095ce58-629a-429a-b39f-fd702e342e6c",
                    "subject": "CN=Certum CA,O=Unizeto Sp. z o.o.,C=PL",
                    "issuer": "CN=Certum CA,O=Unizeto Sp. z o.o.,C=PL",
                    "notBefore": "2002-06-11 19:46:39",
                    "notAfter": "2027-06-11 19:46:39"
                },
                {
                    "alias": "b6307f15-1c1d-48ff-a49c-e0c0b5709a5c0",
                    "subject": "CN=subject,OU=UnitName,O=OrganizationName,L=LocalityName,ST=StateName,C=JP",
                    "issuer": "CN=ca,OU=caUnit,O=caOrg,L=caCity,ST=csState,C=JP",
                    "notBefore": "2013-10-02 20:47:04",
                    "notAfter": "2014-10-02 20:47:04"
                }
            ]
        }
    }
}
エラーケース

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

HTTPステータスコード エラーコード 説明
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4002 パラメーター userName で指定したユーザーが存在しなかった場合
500 Internal Server Error 5102 サーバー内部にエラーが発生した場合
5304 証明書情報の解析でエラーが発生した場合
5306 キーストアの読み込みあるいは削除時にエラーが発生した場合

▲ このページのトップへ

機能名: user/certificate/partner/show

説明

ユーザーのパートナー証明書の詳細情報を取得します。

権限

administrator、operator

リクエスト
HTTPメソッド リクエストURL
GET http://{Hostname}:{Port}/mcapi/account/user/certificate/partner/show
リクエストパラメーター
パラメーター 必須 説明
alias はい CA証明書のエイリアスを入力します。
userName いいえ ユーザー名を指定します。
指定しなかった場合ログインユーザーとなります。
リクエスト例
GET /mcapi/account/user/certificate/partner/show?alias=7095ce58-629a-429a-b39f-fd702e342e6c HTTP/1.1
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
レスポンス
HTTPステータスコード

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

実行結果

実行に成功すると証明書の詳細情報が返ります。
証明書の発行先、発行者情報として、次の情報が取得できます。

証明書のその他情報として、次の情報が取得できます。

{
    "result": {
        "status": "success",
        "data": {
            "certificate": {
                "subject": {
                    "C": "JP",
                    "ST": "StateName",
                    "L": "LocalityName",
                    "O": "OrganizationName",
                    "OU": "UnitName",
                    "CN": "subject"
                },
                "issuer": {
                    "C": "JP",
                    "ST": "CaState",
                    "L": "CaCity",
                    "O": "CaOrg",
                    "OU": "CaUnit",
                    "CN": "CA"
                },
                "notValidBefore": "2013-01-13 09:56:53",
                "notValidAfter": "2013-04-13 09:56:53",
                "version": "1",
                "signatureAlgorithm": "SHA1withRSA",
                "usage": {
                    "digitalSignature": true,
                    "nonRepudiation": false,
                    "keyEncipherment": false,
                    "dataEncipherment": false,
                    "keyAgreement": true,
                    "keyCertSign": false,
                    "cRLSign": false,
                    "encipherOnly": true,
                    "decipherOnly": false
                },
                "fingerprintSha1": "c0:a3:ce:70:bb:a8:8a:94:d4:37:d7:75:3f:4b:7b:8d:d1:f7:d5:59",
                "fingerprintSha256": "b4:13:f4:7d:13:ee:2f:e6:c8:45:b2:ee:14:1a:f8:1d:e8:58:df:4e:c5:49:a5:8b:79:70:bb:96:64:5b:c8:d2",
                "serialNumber": "1378947413351"
            }
        }
    }
}
エラーケース

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

HTTPステータスコード エラーコード 説明
400 Bad Request 2002 パラメーター alias が設定されていなかった場合
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4002 パラメーター userName で指定したユーザーが存在しなかった場合
4012 証明書情報が存在しない場合
500 Internal Server Error 5102 サーバー内部にエラーが発生した場合
5304 証明書情報の解析でエラーが発生した場合
5306 キーストアの読み込みあるいは削除時にエラーが発生した場合

▲ このページのトップへ

機能名: user/certificate/partner/delete

説明

ユーザーのパートナー証明書を削除します。

権限

administrator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/account/user/certificate/partner/delete
リクエストパラメーター
パラメーター 必須 説明
alias はい 削除する証明書のエイリアスを指定します。
userName いいえ ユーザー名を指定します。
指定しなかった場合ログインユーザーとなります。
リクエスト例
POST /mcapi/account/user/certificate/partner/delete HTTP/1.1
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Content-Length: 10

alias=test
レスポンス
HTTPステータスコード

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

実行結果

実行に成功すると証明書を削除します。残っているユーザーのパートナー証明書の一覧が返ります。

{
    "result": {
        "status": "success",
        "data": {
            "certificate": [
                {
                    "alias": "7095ce58-629a-429a-b39f-fd702e342e6c",
                    "subject": "CN=Certum CA,O=Unizeto Sp. z o.o.,C=PL",
                    "issuer": "CN=Certum CA,O=Unizeto Sp. z o.o.,C=PL",
                    "notBefore": "2002-06-11 19:46:39",
                    "notAfter": "2027-06-11 19:46:39"
                },
                {
                    "alias": "b6307f15-1c1d-48ff-a49c-e0c0b5709a5c0",
                    "subject": "CN=subject,OU=UnitName,O=OrganizationName,L=LocalityName,ST=StateName,C=JP",
                    "issuer": "CN=ca,OU=caUnit,O=caOrg,L=caCity,ST=csState,C=JP",
                    "notBefore": "2013-10-02 20:47:04",
                    "notAfter": "2014-10-02 20:47:04"
                }
            ]
        }
    }
}
エラーケース

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

HTTPステータスコード エラーコード 説明
400 Bad Request 2002 パラメーター alias が設定されていなかった場合
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4002 パラメーター userName で指定したユーザーが存在しなかった場合
4012 証明書情報が存在しない場合
500 Internal Server Error 5002 ファイルの書き込みでエラーが発生した場合
5102 サーバー内部にエラーが発生した場合
5304 証明書情報の解析でエラーが発生した場合
5305 キーストア格納時にエラーが発生した場合
5306 キーストアの読み込みあるいは削除時にエラーが発生した場合

▲ このページのトップへ

機能名: user/certificate/partner/import

説明

ユーザーのパートナー証明書を追加します。アップロード後エイリアスが自動的に発行されます。

権限

administrator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/account/user/certificate/partner/import
リクエストパラメーター
パラメーター 必須 説明
userName いいえ ユーザー名を指定します。
指定しなかった場合ログインユーザーとなります。
alias いいえ パートナー証明書のエイリアスを指定します。
指定しなかった場合自動的に生成します。
リクエスト例

HTMLでファイルをアップロードするときに送信されるmultipart/form-data形式と同じ形式のデータをPOSTします。
対応ファイル形式は、X.509、pkcs#7のPEM、DERになります。
証明書情報として、次の情報をリクエストのボディに設定します。

POST /mcapi/account/user/certificate/partner/import HTTP/1.1
Content-Type: multipart/form-data; boundary=---------------------------120912416424652; charset=UTF-8
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
Content-Length: 333

-----------------------------120912416424652 
Content-Disposition: form-data; name="alias"

alias
-----------------------------120912416424652
Content-Disposition: form-data; name="caFile"; filename="test.cer" 
Content-Type: text/plain

[リクエストのデータとしてファイルがバイナリ形式で付加されます]
-----------------------------120912416424652--
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとユーザーのパートナー証明書が追加されます。証明書の一覧が返ります。

{
    "result": {
        "status": "success",
        "data": {
            "certificate": [
                {
                    "alias": "alias",
                    "subject": "CN=Certum CA,O=Unizeto Sp. z o.o.,C=PL",
                    "issuer": "CN=Certum CA,O=Unizeto Sp. z o.o.,C=PL",
                    "notBefore": "2002-06-11 19:46:39",
                    "notAfter": "2027-06-11 19:46:39"
                },
                {
                    "alias": "b6307f15-1c1d-48ff-a49c-e0c0b5709a5c0",
                    "subject": "CN=subject,OU=UnitName,O=OrganizationName,L=LocalityName,ST=StateName,C=JP",
                    "issuer": "CN=ca,OU=caUnit,O=caOrg,L=caCity,ST=csState,C=JP",
                    "notBefore": "2013-10-02 20:47:04",
                    "notAfter": "2014-10-02 20:47:04"
                }
            ]
        }
    }
}
エラーケース

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

HTTPステータスコード エラーコード 説明
400 Bad Request 2202 リクエストからファイル名を取得できなかった場合
2203 リクエストからファイルデータを取得できなかった場合
2204 アップロードされた証明書情報の解析でエラーが発生した場合
2301 リクエストデータの解析でエラーが発生した場合
2802 証明書は有効期限が切れた場合
2803 指定したエイリアスは既に存在していた場合
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4002 パラメーター userName で指定したユーザーが存在しなかった場合
500 Internal Server Error 5002 ファイルの書き込みでエラーが発生した場合
5102 サーバー内部にエラーが発生した場合
5304 証明書情報の解析でエラーが発生した場合
5305 キーストア格納時にエラーが発生した場合
5306 キーストアの読み込みあるいは削除時にエラーが発生した場合

▲ このページのトップへ