| 機能名 | 説明 |
|---|---|
| server/exist | サーバー証明書の存在を確認します |
| server/show | サーバー証明書の詳細情報を取得します |
| server/create | サーバー証明書を作成します |
| server/delete | サーバー証明書を削除します |
| server/csr/response/upload | 認証されたサーバー証明書を格納します |
| server/csr/download | サーバー証明書のcsrファイルをダウンロードします |
| server/import | サーバー証明書をインポートします |
| server/export | サーバー証明書をエクスポートします |
| server/ca/list | クライアント認証で信頼する認証局の証明書の一覧を取得します |
| server/ca/show | クライアント認証で信頼する認証局の証明書の詳細情報を取得します |
| server/ca/delete | クライアント認証で信頼する認証局の証明書を削除します |
| server/ca/import | クライアント認証で信頼する認証局の証明書を追加します |
| client/exist | クライアント証明書の存在を確認します |
| client/show | クライアント証明書の詳細情報を取得します |
| client/create | クライアント証明書を作成します |
| client/delete | クライアント証明書を削除します |
| client/csr/response/upload | 認証されたクライアント証明書を格納します |
| client/csr/download | クライアント証明書のcsrファイルをダウンロードします |
| client/import | クライアント証明書をインポートします |
| client/export | クライアント証明書をエクスポートします |
| client/ca/list | サーバー認証で信頼する認証局の証明書の一覧を取得します |
| client/ca/show | サーバー認証で信頼する認証局の証明書の詳細情報を取得します |
| client/ca/delete | サーバー認証で信頼する認証局の証明書を削除します |
| client/ca/import | サーバー認証で信頼する認証局の証明書を追加します |
サーバー証明書の存在を確認します。
administrator、developer、operator
| HTTPメソッド | リクエストURL |
|---|---|
| GET | http://{Hostname}:{Port}/mcapi/certificate/server/exist |
GET /mcapi/certificate/server/exist HTTP/1.1 X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
APIの実行が成功した場合、HTTPステータスコードは200が返ります。
実行に成功するとサーバー証明書の存在(exist)が返ります。存在する場合は「true」、存在しない場合は「false」です。
{
"result": {
"status": "success",
"data": {
"exist": true
}
}
}
下記以外のエラーについては、共通エラーコードを参照してください。
| HTTPステータスコード | エラーコード | 説明 |
|---|---|---|
| 403 Forbidden | 3001 | ログインしていなかった場合 |
| 500 Internal Server Error | 5102 | サーバー内部にエラーが発生した場合 |
サーバー証明書の詳細情報を取得します。
administrator、developer、operator
| HTTPメソッド | リクエストURL |
|---|---|
| POST | http://{Hostname}:{Port}/mcapi/certificate/server/show |
| パラメーター | 必須 | 説明 |
|---|---|---|
| password | はい | 格納用パスワードを入力します。 |
POST /mcapi/certificate/server/show HTTP/1.1 Content-Type: application/x-www-form-urlencoded; charset=UTF-8 X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4 Content-Length: 15 password=123456
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"
},
"notBefore": "2013-01-13 09:56:53",
"notAfter": "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",
"fingerprintMd5": "c8:30:64:3c:df:48:83:3c:15:fb:a0:04:6a:9c:61:61",
"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 が設定されていなかった場合 |
| 2401 | パスワードが正しくなかった場合 | |
| 403 Forbidden | 3001 | ログインしていなかった場合 |
| 403 Not Found | 4012 | 証明書情報が存在しない場合 |
| 500 Internal Server Error | 5102 | サーバー内部にエラーが発生した場合 |
| 5304 | 証明書情報の解析でエラーが発生した場合 |
サーバー証明書を作成します。
administrator
| HTTPメソッド | リクエストURL |
|---|---|
| POST | http://{Hostname}:{Port}/mcapi/certificate/server/create |
POST /mcapi/certificate/server/create 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": "md5WithRSAEncryption"
}
}
APIの実行が成功した場合、HTTPステータスコードは200が返ります。
実行に成功するとサーバー証明書を作成します。
{
"result": {
"status": "success",
"data": {
}
}
}
下記以外のエラーについては、共通エラーコードを参照してください。
| HTTPステータスコード | エラーコード | 説明 |
|---|---|---|
| 400 Bad Request | 2101 | JSONデーターの値が正しくなかった場合 |
| 2102 | 必須項目が設定されなかった場合 | |
| 2103 | JSONデーターのデーター型が正しくなかった場合 | |
| 2107 | キー password, privateKeyPassword の値が6文字未満の場合 | |
| 403 Forbidden | 3001 | ログインしていなかった場合 |
| 500 Internal Server Error | 5002 | ファイルの書き込みでエラーが発生した場合 |
| 5101 | 内部の通信に失敗した場合 | |
| 5102 | サーバー内部にエラーが発生した場合 | |
| 5305 | キーストア格納時にエラーが発生した場合 | |
| 5306 | キーストアの読み込みあるいは削除時にエラーが発生した場合 | |
| 5307 | キーの作成でエラーが発生した場合 | |
| 5308 | プライベートキーの取得でエラーが発生した場合 | |
| 5309 | CSRの作成でエラーが発生した場合 |
サーバー証明書を削除します。csrファイルも削除します。
administrator
| HTTPメソッド | リクエストURL |
|---|---|
| POST | http://{Hostname}:{Port}/mcapi/certificate/server/delete |
| パラメーター | 必須 | 説明 |
|---|---|---|
| password | はい | 格納用パスワードを入力します。 |
POST /mcapi/certificate/server/delete HTTP/1.1 Content-Type: application/x-www-form-urlencoded; charset=UTF-8 Content-Length: 31 password=123456
APIの実行が成功した場合、HTTPステータスコードは200が返ります。
実行に成功するとサーバー証明書を削除します。
{
"result": {
"status": "success",
"data": {}
}
}
下記以外のエラーについては、共通エラーコードを参照してください。
| HTTPステータスコード | エラーコード | 説明 |
|---|---|---|
| 400 Bad Request | 2002 | パラメーター password が設定されていなかった場合 |
| 2401 | パスワードが正しくなかった場合 | |
| 403 Forbidden | 3001 | ログインしていなかった場合 |
| 403 Not Found | 4012 | 証明書情報が存在しない場合 |
| 500 Internal Server Error | 5002 | ファイルの書き込みでエラーが発生した場合 |
| 5101 | 内部の通信に失敗した場合 | |
| 5102 | サーバー内部にエラーが発生した場合 | |
| 5305 | キーストア格納時にエラーが発生した場合 | |
| 5306 | キーストアの読み込みあるいは削除時にエラーが発生した場合 |
サーバー証明書をインポートします。
administrator
| HTTPメソッド | リクエストURL |
|---|---|
| POST | http://{Hostname}:{Port}/mcapi/certificate/server/import |
HTMLでファイルをアップロードするときに送信されるmultipart/form-data形式と同じ形式のデータをPOSTします。
対応ファイル形式は、PKCS#12、JavaKeyStoreになります。
サーバー証明書情報として、次の情報がリクエストのボディに設定します。
POST /mcapi/certificate/server/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="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--
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"
},
"notBefore": "2013-01-13 09:56:53",
"notAfter": "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",
"fingerprintMd5": "c8:30:64:3c:df:48:83:3c:15:fb:a0:04:6a:9c:61:61",
"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, privateKeyPassword, filePassword が設定されていなかった場合 |
| 2004 | パラメーター password, privateKeyPassword の値が6文字未満の場合 | |
| 2202 | リクエストからファイル名を取得できなかった場合 | |
| 2203 | リクエストからファイルデーターを取得できなかった場合 | |
| 2204 | アップロードされた証明書情報の解析でエラーが発生した場合 | |
| 2301 | リクエストデーターの解析でエラーが発生した場合 | |
| 2401 | パスワードが正しくなかった場合 | |
| 403 Forbidden | 3001 | ログインしていなかった場合 |
| 500 Internal Server Error | 5002 | ファイルの書き込みでエラーが発生した場合 |
| 5101 | 内部の通信に失敗した場合 | |
| 5102 | サーバー内部にエラーが発生した場合 | |
| 5305 | キーストア格納時にエラーが発生した場合 | |
| 5306 | キーストアの読み込みあるいは削除時にエラーが発生した場合 |
サーバー証明書のcsrファイルをダウンロードします。
administrator、operator
| HTTPメソッド | リクエストURL |
|---|---|
| POST | http://{Hostname}:{Port}/mcapi/certificate/server/csr/download |
| パラメーター | 必須 | 説明 |
|---|---|---|
| password | はい | 格納用パスワードを入力します。 |
| privateKeyPassword | はい | 秘密鍵用パスワードを入力します。 |
POST /mcapi/certificate/server/csr/download HTTP/1.1 Content-Type: application/x-www-form-urlencoded; charset=UTF-8 X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4 Content-Length: 41 password=123456&privateKeyPassword=abcdef
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 | パラメーター password, peivateKeyPassword が設定されていなかった場合 |
| 2401 | パスワードが正しくなかった場合 | |
| 403 Forbidden | 3001 | ログインしていなかった場合 |
| 403 Not Found | 4012 | 証明書情報が存在しない場合 |
| 500 Internal Server Error | 5002 | ファイルの書き込みでエラーが発生した場合 |
| 5006 | ファイルをZIPした時にエラーが発生した場合 | |
| 5102 | サーバー内部にエラーが発生した場合 | |
| 5310 | csrファイルが存在しない場合 |
認証されたサーバー証明書を格納します。
administrator
| HTTPメソッド | リクエストURL |
|---|---|
| POST | http://{Hostname}:{Port}/mcapi/certificate/server/csr/response/upload |
HTMLでファイルをアップロードするときに送信されるmultipart/form-data形式と同じ形式のデータをPOSTします。
対応ファイル形式は、X.509、pkcs#7のPEM、DERになります。
サーバー証明書情報として、次の情報をリクエストのボディに設定します。
POST /mcapi/certificate/server/csr/response/upload 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="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--
APIの実行が成功した場合、HTTPステータスコードは200が返ります。
実行に成功するとサーバー証明書が格納されます。
{
"result": {
"status": "success",
"data": {}
}
}
下記以外のエラーについては、共通エラーコードを参照してください。
| HTTPステータスコード | エラーコード | 説明 |
|---|---|---|
| 400 Bad Request | 2002 | パラメーター password, privateKeyPassword が設定されていなかった場合 |
| 2202 | リクエストからファイル名を取得できなかった場合 | |
| 2203 | リクエストからファイルデーターを取得できなかった場合 | |
| 2204 | アップロードされた証明書情報の解析でエラーが発生した場合 | |
| 2301 | リクエストデーターの解析でエラーが発生した場合 | |
| 2401 | パスワードが正しくなかった場合 | |
| 2801 | 公開鍵のバリデーションでエラーが発生した場合 | |
| 403 Forbidden | 3001 | ログインしていなかった場合 |
| 403 Not Found | 4012 | 証明書情報が存在しない場合 |
| 500 Internal Server Error | 5002 | ファイルの書き込みでエラーが発生した場合 |
| 5101 | 内部の通信に失敗した場合 | |
| 5102 | サーバー内部にエラーが発生した場合 | |
| 5305 | キーストア格納時にエラーが発生した場合 | |
| 5306 | キーストアの読み込みあるいは削除時にエラーが発生した場合 |
サーバー証明書を指定した形式でエクスポートします。
administrator、operator
| HTTPメソッド | リクエストURL |
|---|---|
| POST | http://{Hostname}:{Port}/mcapi/certificate/server/export |
| パラメーター | 必須 | 説明 |
|---|---|---|
| password | はい | 格納用パスワードを入力します。 |
| outputFormat | はい | ファイルの出力形式を指定します。 「X509」あるいは「PKCS7」 |
| dataFormat | はい | 内部データ形式を指定します。 「PEM」あるいは「DER」 |
POST /mcapi/certificate/server/export HTTP/1.1 Content-Type: application/x-www-form-urlencoded; charset=UTF-8 X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4 Content-Length: 48 password=123456&outputFormat=X509&dataFormat=PEM
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 | ログインしていなかった場合 |
| 403 Not Found | 4012 | 証明書情報が存在しない場合 |
| 500 Internal Server Error | 5001 | ファイルの読み込みでエラーが発生した場合 |
| 5002 | ファイルの書き込みでエラーが発生した場合 | |
| 5006 | ファイルをZIPした時にエラーが発生した場合 | |
| 5102 | サーバー内部にエラーが発生した場合 | |
| 5303 | 証明書情報の読み込みでエラーが発生した場合 | |
| 5306 | キーストアの読み込みあるいは削除時にエラーが発生した場合 |
クライアント認証で信頼する認証局の証明書の一覧を取得します。
administrator、developer、operator
| HTTPメソッド | リクエストURL |
|---|---|
| GET | http://{Hostname}:{Port}/mcapi/certificate/server/ca/list |
GET /mcapi/certificate/server/ca/list HTTP/1.1 X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
APIの実行が成功した場合、HTTPステータスコードは200が返ります。
実行に成功するとクライアント認証で信頼する認証局の証明書一覧が返ります。
証明書情報として、次の情報が取得できします。
{
"result": {
"status": "success",
"data": {
"certificate": [
{
"alias": "b6307f15-1c1d-48ff-a49c-e0c0b5709a5c0",
"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": "7095ce58-629a-429a-b39f-fd702e342e6c",
"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 | ログインしていなかった場合 |
| 500 Internal Server Error | 5102 | サーバー内部にエラーが発生した場合 |
| 5304 | 証明書情報の解析でエラーが発生した場合 | |
| 5306 | キーストアの読み込みあるいは削除時にエラーが発生した場合 |
クライアント認証で信頼する認証局の証明書の詳細情報を取得します。
administrator、developer、operator
| HTTPメソッド | リクエストURL |
|---|---|
| GET | http://{Hostname}:{Port}/mcapi/certificate/server/ca/show |
| パラメーター | 必須 | 説明 |
|---|---|---|
| alias | はい | CA証明書のエイリアスを入力します。 |
GET /mcapi/certificate/server/ca/show?alias=7095ce58-629a-429a-b39f-fd702e342e6c HTTP/1.1 X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
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"
},
"notBefore": "2013-01-13 09:56:53",
"notAfter": "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",
"fingerprintMd5": "c8:30:64:3c:df:48:83:3c:15:fb:a0:04:6a:9c:61:61",
"serialNumber": "1378947413351"
}
}
}
}
下記以外のエラーについては、共通エラーコードを参照してください。
| HTTPステータスコード | エラーコード | 説明 |
|---|---|---|
| 400 Bad Request | 2002 | パラメーター alias が設定されていなかった場合 |
| 403 Forbidden | 3001 | ログインしていなかった場合 |
| 403 Not Found | 4012 | 証明書情報が存在しない場合 |
| 500 Internal Server Error | 5102 | サーバー内部にエラーが発生した場合 |
| 5304 | 証明書情報の解析でエラーが発生した場合 | |
| 5306 | キーストアの読み込みあるいは削除時にエラーが発生した場合 |
クライアント認証で信頼する認証局の証明書を削除します。
administrator
| HTTPメソッド | リクエストURL |
|---|---|
| POST | http://{Hostname}:{Port}/mcapi/certificate/server/ca/delete |
| パラメーター | 必須 | 説明 |
|---|---|---|
| alias | はい | 削除する証明書のエイリアスを指定します。 |
POST /mcapi/certificate/server/ca/delete HTTP/1.1 Content-Type: application/x-www-form-urlencoded; charset=UTF-8 Content-Length: 10 alias=test
APIの実行が成功した場合、HTTPステータスコードは200が返ります。
実行に成功すると証明書を削除します。残っているクライアント認証で信頼する認証局の証明書の一覧が返ります。
{
"result": {
"status": "success",
"data": {
"certificate": [
{
"alias": "b6307f15-1c1d-48ff-a49c-e0c0b5709a5c0",
"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": "7095ce58-629a-429a-b39f-fd702e342e6c",
"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 | ログインしていなかった場合 |
| 403 Not Found | 4012 | 証明書情報が存在しない場合 |
| 500 Internal Server Error | 5002 | ファイルの書き込みでエラーが発生した場合 |
| 5102 | サーバー内部にエラーが発生した場合 | |
| 5304 | 証明書情報の解析でエラーが発生した場合 | |
| 5305 | キーストア格納時にエラーが発生した場合 | |
| 5306 | キーストアの読み込みあるいは削除時にエラーが発生した場合 |
クライアント認証で信頼する認証局の証明書を追加します。アップロード後エイリアスが自動的に発行されます。
administrator
| HTTPメソッド | リクエストURL |
|---|---|
| POST | http://{Hostname}:{Port}/mcapi/certificate/server/ca/import |
HTMLでファイルをアップロードするときに送信されるmultipart/form-data形式と同じ形式のデータをPOSTします。
対応ファイル形式は、X.509、pkcs#7のPEM、DERになります。
証明書情報として、次の情報をリクエストのボディに設定します。
POST /mcapi/certificate/server/ca/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="caFile"; filename="test.cer" Content-Type: text/plain [リクエストのデータとしてファイルがバイナリ形式で付加されます] -----------------------------120912416424652--
APIの実行が成功した場合、HTTPステータスコードは200が返ります。
実行に成功するとクライアント認証で信頼する認証局の証明書が追加されます。CA証明書の一覧が返ります。
{
"result": {
"status": "success",
"data": {
"certificate": [
{
"alias": "b6307f15-1c1d-48ff-a49c-e0c0b5709a5c0",
"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": "7095ce58-629a-429a-b39f-fd702e342e6c",
"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 | ログインしていなかった場合 |
| 500 Internal Server Error | 5002 | ファイルの書き込みでエラーが発生した場合 |
| 5102 | サーバー内部にエラーが発生した場合 | |
| 5304 | 証明書情報の解析でエラーが発生した場合 | |
| 5305 | キーストア格納時にエラーが発生した場合 | |
| 5306 | キーストアの読み込みあるいは削除時にエラーが発生した場合 |
クライアント証明書の存在を確認します。
administrator、developer、operator
| HTTPメソッド | リクエストURL |
|---|---|
| GET | http://{Hostname}:{Port}/mcapi/certificate/client/exist |
GET /mcapi/certificate/client/exist HTTP/1.1 X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
APIの実行が成功した場合、HTTPステータスコードは200が返ります。
実行に成功するとクライアント証明書の存在(exist)が返ります。存在する場合は「true」、存在しない場合は「false」です。
{
"result": {
"status": "success",
"data": {
"exist": true
}
}
}
下記以外のエラーについては、共通エラーコードを参照してください。
| HTTPステータスコード | エラーコード | 説明 |
|---|---|---|
| 403 Forbidden | 3001 | ログインしていなかった場合 |
| 500 Internal Server Error | 5102 | サーバー内部にエラーが発生した場合 |
クライアント証明書の詳細情報を取得します。
administrator、developer、operator
| HTTPメソッド | リクエストURL |
|---|---|
| POST | http://{Hostname}:{Port}/mcapi/certificate/client/show |
| パラメーター | 必須 | 説明 |
|---|---|---|
| password | はい | 格納用パスワードを入力します。 |
POST /mcapi/certificate/client/show HTTP/1.1 Content-Type: application/x-www-form-urlencoded; charset=UTF-8 X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4 Content-Length: 15 password=123456
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"
},
"notBefore": "2013-01-13 09:56:53",
"notAfter": "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",
"fingerprintMd5": "c8:30:64:3c:df:48:83:3c:15:fb:a0:04:6a:9c:61:61",
"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 が設定されていなかった場合 |
| 2401 | パスワードが正しくなかった場合 | |
| 403 Forbidden | 3001 | ログインしていなかった場合 |
| 403 Not Found | 4012 | 証明書情報が存在しない場合 |
| 500 Internal Server Error | 5102 | サーバー内部にエラーが発生した場合 |
| 5304 | 証明書情報の解析でエラーが発生した場合 |
クライアント証明書を作成します。
administrator
| HTTPメソッド | リクエストURL |
|---|---|
| POST | http://{Hostname}:{Port}/mcapi/certificate/client/create |
POST /mcapi/certificate/client/create 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": "md5WithRSAEncryption"
}
}
APIの実行が成功した場合、HTTPステータスコードは200が返ります。
実行に成功するとクライアント証明書を作成します。
{
"result": {
"status": "success",
"data": {
}
}
}
下記以外のエラーについては、共通エラーコードを参照してください。
| HTTPステータスコード | エラーコード | 説明 |
|---|---|---|
| 400 Bad Request | 2101 | JSONデーターの値が正しくなかった場合 |
| 2102 | 必須項目が設定されなかった場合 | |
| 2103 | JSONデーターのデーター型が正しくなかった場合 | |
| 2107 | キー password, privateKeyPassword の値が6文字未満の場合 | |
| 403 Forbidden | 3001 | ログインしていなかった場合 |
| 500 Internal Server Error | 5002 | ファイルの書き込みでエラーが発生した場合 |
| 5101 | 内部の通信に失敗した場合 | |
| 5102 | サーバー内部にエラーが発生した場合 | |
| 5305 | キーストア格納時にエラーが発生した場合 | |
| 5306 | キーストアの読み込みあるいは削除時にエラーが発生した場合 | |
| 5307 | キーの作成でエラーが発生した場合 | |
| 5308 | プライベートキーの取得でエラーが発生した場合 | |
| 5309 | CSRの作成でエラーが発生した場合 |
クライアント証明書を削除します。csrファイルも削除します。
administrator
| HTTPメソッド | リクエストURL |
|---|---|
| POST | http://{Hostname}:{Port}/mcapi/certificate/client/delete |
| パラメーター | 必須 | 説明 |
|---|---|---|
| password | はい | 格納用パスワードを入力します。 |
POST /mcapi/certificate/client/delete HTTP/1.1 Content-Type: application/x-www-form-urlencoded; charset=UTF-8 Content-Length: 31 password=123456
APIの実行が成功した場合、HTTPステータスコードは200が返ります。
実行に成功するとクライアント証明書を削除します。
{
"result": {
"status": "success",
"data": {}
}
}
下記以外のエラーについては、共通エラーコードを参照してください。
| HTTPステータスコード | エラーコード | 説明 |
|---|---|---|
| 400 Bad Request | 2002 | パラメーター password が設定されていなかった場合 |
| 2401 | パスワードが正しくなかった場合 | |
| 403 Forbidden | 3001 | ログインしていなかった場合 |
| 403 Not Found | 4012 | 証明書情報が存在しない場合 |
| 500 Internal Server Error | 5002 | ファイルの書き込みでエラーが発生した場合 |
| 5101 | 内部の通信に失敗した場合 | |
| 5102 | サーバー内部にエラーが発生した場合 | |
| 5305 | キーストア格納時にエラーが発生した場合 | |
| 5306 | キーストアの読み込みあるいは削除時にエラーが発生した場合 |
クライアント証明書をインポートします。
administrator
| HTTPメソッド | リクエストURL |
|---|---|
| POST | http://{Hostname}:{Port}/mcapi/certificate/client/import |
HTMLでファイルをアップロードするときに送信されるmultipart/form-data形式と同じ形式のデータをPOSTします。
対応ファイル形式は、PKCS#12、JavaKeyStoreになります。
クライアント証明書情報として、次の情報がリクエストのボディに設定します。
POST /mcapi/certificate/client/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="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--
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"
},
"notBefore": "2013-01-13 09:56:53",
"notAfter": "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",
"fingerprintMd5": "c8:30:64:3c:df:48:83:3c:15:fb:a0:04:6a:9c:61:61",
"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, privateKeyPassword, filePassword が設定されていなかった場合 |
| 2004 | パラメーター password, privateKeyPassword の値が6文字未満の場合 | |
| 2202 | リクエストからファイル名を取得できなかった場合 | |
| 2203 | リクエストからファイルデーターを取得できなかった場合 | |
| 2204 | アップロードされた証明書情報の解析でエラーが発生した場合 | |
| 2301 | リクエストデーターの解析でエラーが発生した場合 | |
| 2401 | パスワードが正しくなかった場合 | |
| 403 Forbidden | 3001 | ログインしていなかった場合 |
| 500 Internal Server Error | 5002 | ファイルの書き込みでエラーが発生した場合 |
| 5101 | 内部の通信に失敗した場合 | |
| 5102 | サーバー内部にエラーが発生した場合 | |
| 5305 | キーストア格納時にエラーが発生した場合 | |
| 5306 | キーストアの読み込みあるいは削除時にエラーが発生した場合 |
クライアント証明書のcsrファイルをダウンロードします。
administrator、operator
| HTTPメソッド | リクエストURL |
|---|---|
| POST | http://{Hostname}:{Port}/mcapi/certificate/client/csr/download |
| パラメーター | 必須 | 説明 |
|---|---|---|
| password | はい | 格納用パスワードを入力します。 |
| privateKeyPassword | はい | 秘密鍵用パスワードを入力します。 |
POST /mcapi/certificate/client/csr/download HTTP/1.1 Content-Type: application/x-www-form-urlencoded; charset=UTF-8 X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4 Content-Length: 41 password=123456&privateKeyPassword=abcdef
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 | パラメーター password, peivateKeyPassword が設定されていなかった場合 |
| 2401 | パスワードが正しくなかった場合 | |
| 403 Forbidden | 3001 | ログインしていなかった場合 |
| 403 Not Found | 4012 | 証明書情報が存在しない場合 |
| 500 Internal Server Error | 5002 | ファイルの書き込みでエラーが発生した場合 |
| 5006 | ファイルをZIPした時にエラーが発生した場合 | |
| 5102 | サーバー内部にエラーが発生した場合 | |
| 5310 | csrファイルが存在しない場合 |
認証されたクライアント証明書を格納します。
administrator
| HTTPメソッド | リクエストURL |
|---|---|
| POST | http://{Hostname}:{Port}/mcapi/certificate/client/csr/response/upload |
HTMLでファイルをアップロードするときに送信されるmultipart/form-data形式と同じ形式のデータをPOSTします。
対応ファイル形式は、X.509、pkcs#7のPEM、DERになります。
クライアント証明書情報として、次の情報をリクエストのボディに設定します。
POST /mcapi/certificate/client/csr/response/upload 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="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--
APIの実行が成功した場合、HTTPステータスコードは200が返ります。
実行に成功するとクライアント証明書が格納されます。
{
"result": {
"status": "success",
"data": {}
}
}
下記以外のエラーについては、共通エラーコードを参照してください。
| HTTPステータスコード | エラーコード | 説明 |
|---|---|---|
| 400 Bad Request | 2002 | パラメーター password, privateKeyPassword が設定されていなかった場合 |
| 2202 | リクエストからファイル名を取得できなかった場合 | |
| 2203 | リクエストからファイルデーターを取得できなかった場合 | |
| 2204 | アップロードされた証明書情報の解析でエラーが発生した場合 | |
| 2301 | リクエストデーターの解析でエラーが発生した場合 | |
| 2401 | パスワードが正しくなかった場合 | |
| 2801 | 公開鍵のバリデーションでエラーが発生した場合 | |
| 403 Forbidden | 3001 | ログインしていなかった場合 |
| 403 Not Found | 4012 | 証明書情報が存在しない場合 |
| 500 Internal Server Error | 5002 | ファイルの書き込みでエラーが発生した場合 |
| 5101 | 内部の通信に失敗した場合 | |
| 5102 | サーバー内部にエラーが発生した場合 | |
| 5305 | キーストア格納時にエラーが発生した場合 | |
| 5306 | キーストアの読み込みあるいは削除時にエラーが発生した場合 |
クライアント証明書を指定した形式でエクスポートします。
administrator、operator
| HTTPメソッド | リクエストURL |
|---|---|
| POST | http://{Hostname}:{Port}/mcapi/certificate/client/export |
| パラメーター | 必須 | 説明 |
|---|---|---|
| password | はい | 格納用パスワードを入力します。 |
| outputFormat | はい | ファイルの出力形式を指定します。 「X509」あるいは「PKCS7」 |
| dataFormat | はい | 内部データ形式を指定します。 「PEM」あるいは「DER」 |
POST /mcapi/certificate/client/export HTTP/1.1 Content-Type: application/x-www-form-urlencoded; charset=UTF-8 X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4 Content-Length: 48 password=123456&outputFormat=X509&dataFormat=PEM
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 | ログインしていなかった場合 |
| 403 Not Found | 4012 | 証明書情報が存在しない場合 |
| 500 Internal Server Error | 5001 | ファイルの読み込みでエラーが発生した場合 |
| 5002 | ファイルの書き込みでエラーが発生した場合 | |
| 5006 | ファイルをZIPした時にエラーが発生した場合 | |
| 5102 | サーバー内部にエラーが発生した場合 | |
| 5303 | 証明書情報の読み込みでエラーが発生した場合 | |
| 5306 | キーストアの読み込みあるいは削除時にエラーが発生した場合 |
サーバー認証で信頼する認証局の証明書の一覧を取得します。
administrator、developer、operator
| HTTPメソッド | リクエストURL |
|---|---|
| GET | http://{Hostname}:{Port}/mcapi/certificate/client/ca/list |
GET /mcapi/certificate/client/ca/list HTTP/1.1 X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
APIの実行が成功した場合、HTTPステータスコードは200が返ります。
実行に成功するとサーバー認証で信頼する認証局の証明書一覧が返ります。
証明書情報として、次の情報が取得できします。
{
"result": {
"status": "success",
"data": {
"certificate": [
{
"alias": "b6307f15-1c1d-48ff-a49c-e0c0b5709a5c0",
"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": "7095ce58-629a-429a-b39f-fd702e342e6c",
"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 | ログインしていなかった場合 |
| 500 Internal Server Error | 5102 | サーバー内部にエラーが発生した場合 |
| 5304 | 証明書情報の解析でエラーが発生した場合 | |
| 5306 | キーストアの読み込みあるいは削除時にエラーが発生した場合 |
サーバー認証で信頼する認証局の証明書の詳細情報を取得します。
administrator、developer、operator
| HTTPメソッド | リクエストURL |
|---|---|
| GET | http://{Hostname}:{Port}/mcapi/certificate/client/ca/show |
| パラメーター | 必須 | 説明 |
|---|---|---|
| alias | はい | CA証明書のエイリアスを入力します。 |
GET /mcapi/certificate/client/ca/show?alias=7095ce58-629a-429a-b39f-fd702e342e6c HTTP/1.1 X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
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"
},
"notBefore": "2013-01-13 09:56:53",
"notAfter": "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",
"fingerprintMd5": "c8:30:64:3c:df:48:83:3c:15:fb:a0:04:6a:9c:61:61",
"serialNumber": "1378947413351"
}
}
}
}
下記以外のエラーについては、共通エラーコードを参照してください。
| HTTPステータスコード | エラーコード | 説明 |
|---|---|---|
| 400 Bad Request | 2002 | パラメーター alias が設定されていなかった場合 |
| 403 Forbidden | 3001 | ログインしていなかった場合 |
| 403 Not Found | 4012 | 証明書情報が存在しない場合 |
| 500 Internal Server Error | 5102 | サーバー内部にエラーが発生した場合 |
| 5304 | 証明書情報の解析でエラーが発生した場合 | |
| 5306 | キーストアの読み込みあるいは削除時にエラーが発生した場合 |
サーバー認証で信頼する認証局の証明書を削除します。
administrator
| HTTPメソッド | リクエストURL |
|---|---|
| POST | http://{Hostname}:{Port}/mcapi/certificate/client/ca/delete |
| パラメーター | 必須 | 説明 |
|---|---|---|
| alias | はい | 削除する証明書のエイリアスを指定します。 |
POST /mcapi/certificate/client/ca/delete HTTP/1.1 Content-Type: application/x-www-form-urlencoded; charset=UTF-8 Content-Length: 10 alias=test
APIの実行が成功した場合、HTTPステータスコードは200が返ります。
実行に成功すると証明書を削除します。残っているサーバー認証で信頼する認証局の証明書の一覧が返ります。
{
"result": {
"status": "success",
"data": {
"certificate": [
{
"alias": "b6307f15-1c1d-48ff-a49c-e0c0b5709a5c0",
"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": "7095ce58-629a-429a-b39f-fd702e342e6c",
"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 | ログインしていなかった場合 |
| 403 Not Found | 4012 | 証明書情報が存在しない場合 |
| 500 Internal Server Error | 5002 | ファイルの書き込みでエラーが発生した場合 |
| 5102 | サーバー内部にエラーが発生した場合 | |
| 5304 | 証明書情報の解析でエラーが発生した場合 | |
| 5305 | キーストア格納時にエラーが発生した場合 | |
| 5306 | キーストアの読み込みあるいは削除時にエラーが発生した場合 |
サーバー認証で信頼する認証局の証明書を追加します。アップロード後エイリアスが自動的に発行されます。
administrator
| HTTPメソッド | リクエストURL |
|---|---|
| POST | http://{Hostname}:{Port}/mcapi/certificate/client/ca/import |
HTMLでファイルをアップロードするときに送信されるmultipart/form-data形式と同じ形式のデータをPOSTします。
対応ファイル形式は、X.509、pkcs#7のPEM、DERになります。
証明書情報として、次の情報をリクエストのボディに設定します。
POST /mcapi/certificate/client/ca/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="caFile"; filename="test.cer" Content-Type: text/plain [リクエストのデータとしてファイルがバイナリ形式で付加されます] -----------------------------120912416424652--
APIの実行が成功した場合、HTTPステータスコードは200が返ります。
実行に成功するとサーバー認証で信頼する認証局の証明書が追加されます。CA証明書の一覧が返ります。
{
"result": {
"status": "success",
"data": {
"certificate": [
{
"alias": "b6307f15-1c1d-48ff-a49c-e0c0b5709a5c0",
"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": "7095ce58-629a-429a-b39f-fd702e342e6c",
"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 | ログインしていなかった場合 |
| 500 Internal Server Error | 5002 | ファイルの書き込みでエラーが発生した場合 |
| 5102 | サーバー内部にエラーが発生した場合 | |
| 5304 | 証明書情報の解析でエラーが発生した場合 | |
| 5305 | キーストア格納時にエラーが発生した場合 | |
| 5306 | キーストアの読み込みあるいは削除時にエラーが発生した場合 |