When using the certificate actions endpoint to revoke a certificate issued by a GlobalSign Certificate Center (GCC) authority, the action.reason parameter is:
- Required by the CA gateway API.
- Ignored by the GlobalSign MSSL (Managed SSL) API, which does not support specifying a revocation reason.
Therefore, this value must be included in the requests, although it will not be evaluated. For example:
{ "action": { "comment": "revoke", "succeedIfAlreadyInRequestedState": true, "type": "RevokeAction", "reason": "unspecified" }}See below for a parameter reference.
Parameter names are case sensitive.
action.comment
A descriptive text on the requested action.
Mandatory: No.
action.succeedIfAlreadyInRequestedState
The request output when the requested action has already been performed.
Value | Request output |
|---|---|
true | Success (the operation is idempotent) |
false | Error |
Mandatory: No. This optional value defaults to false.
action.reason
The certificate revocation reason. Supported values are the following.
- unspecified
- keyCompromise
- affiliationChanged
- superseded
- cessationOfOperation
Mandatory: Yes.
action.type
The type of action requested to the endpoint.
Endpoint | Value | Action |
|---|---|---|
CA actions | RenewAction | Renew a certificate |
CA actions | RevokeAction | Permanently invalidate a certificate |
CA domain actions | ReverifyDomainAction | Reverify a previously validated domain because the prior validation expired, failed, or must be refreshed to meet CA/Browser Forum or GlobalSign requirements. |
Mandatory: Yes.