RevokeCertificate

Classic/VPC環境で利用できます。

Advanced証明書を失効させます。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
POST	/api/v2/certificate/revoke

リクエストヘッダ

Certificate Manager APIで共通して使用されるヘッダの詳細は、Certificate Managerのリクエストヘッダをご参照ください。

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`orderId`	String	Required	失効対象の証明書が含まれたオーダー ID
`certificateNo`	Integer	Required	証明書番号 0~N オーダー内のすべての証明書を失効させる場合: `0`を入力
`revokeType`	String	Required	失効タイプ入力値: `affiliationChanged`、`superseded`、`cessationOfOperation`、`unspecified`のうちいずれか
`revokeType`	String	Required	失効の理由 `affiliationChanged` \| `superseded` \| `cessationOfOperation` \| `unspecified` `affiliationChanged`: 組織名などの識別情報が変更された場合 `superseded`: 有効期限切れ前に新しい証明書に置き換えられた、または置き換えられる予定の場合 `cessationOfOperation`: ドメインまたはサービスが恒久的に停止している、あるいは停止予定の場合 `unspecified`: その他 (上記の失効理由に該当するものが何もない場合にのみ、使用することを推奨)

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://certificatemanager.apigw.ntruss.com/api/v2/certificate/revoke' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
    "orderId": "1",
    "certificateNo": 1,
    "revokeType": "superseded"
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`returnCode`	String	-	レスポンスコード
`returnMessage`	String	-	レスポンスメッセージ
`totalRows`	Integer	-	今回の失効リクエストに含まれた証明書の数

レスポンスステータスコード

Certificate Manager APIで共通して使用されるレスポンスステータスコードの詳細は、Certificate Managerのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "returnCode": "0",
    "returnMessage": "Success",
    "totalRows": 1
}