new certificates(domainOrOptionsopt)
Parameters:
| Name |
Type |
Attributes |
Description |
domainOrOptions |
string
|
object
|
<optional>
|
The project domain or options object. If object, see the object's optional properties.
Properties
| Name |
Type |
Attributes |
Description |
domain |
string
|
<optional>
|
The project domain |
token |
object
|
<optional>
|
auth token - object with value property and optional headerOrQueryName and isQuery properties |
|
- Source:
Methods
certificate_action_retrieve(certificateId)
Retrieve all certificate actions
Parameters:
| Name |
Type |
Description |
certificateId |
string
|
Certificate id to register for callback |
- Source:
certificate_callback_delete(certificateId)
Unregister system callback
Parameters:
| Name |
Type |
Description |
certificateId |
string
|
Certificate id to unregister callback |
- Source:
certificate_callback_get(certificateId)
Retrieve system stateful action callback url
Parameters:
| Name |
Type |
Description |
certificateId |
string
|
Certificate id to register for stateful action callback |
- Source:
certificate_callback_replace(certificateId, callbackUrl)
Register of certificate action callback
Parameters:
| Name |
Type |
Description |
certificateId |
string
|
Certificate id to register/replace for callback |
callbackUrl |
string
|
Callback url registered/replaced to receive stateful actions |
- Source:
certificate_cancel(certificateId)
Cancel a pending certificate
Parameters:
| Name |
Type |
Description |
certificateId |
string
|
Certificate id to cancel |
- Source:
certificate_create(xMarketId, certificateCreate)
Create a pending order for certificate
Parameters:
| Name |
Type |
Description |
xMarketId |
string
|
Setting locale for communications such as emails and error messages |
certificateCreate |
CertificateCreate
|
The certificate order information |
- Source:
certificate_download(certificateId)
Download certificate
Parameters:
| Name |
Type |
Description |
certificateId |
string
|
Certificate id to download |
- Source:
certificate_get(certificateId)
Retrieve certificate details
Parameters:
| Name |
Type |
Description |
certificateId |
string
|
Certificate id to lookup |
- Source:
certificate_reissue(certificateId, reissueCreate)
Reissue active certificate
Parameters:
| Name |
Type |
Description |
certificateId |
string
|
Certificate id to reissue |
reissueCreate |
CertificateReissue
|
The reissue request info |
- Source:
certificate_renew(certificateId, renewCreate)
Renew active certificate
Parameters:
| Name |
Type |
Description |
certificateId |
string
|
Certificate id to renew |
renewCreate |
CertificateRenew
|
The renew request info |
- Source:
certificate_revoke(certificateId, certificateRevoke)
Revoke active certificate
Parameters:
| Name |
Type |
Description |
certificateId |
string
|
Certificate id to revoke |
certificateRevoke |
CertificateRevoke
|
The certificate revocation request |
- Source:
certificate_siteseal_get(certificateId, theme, locale)
Get Site seal
Parameters:
| Name |
Type |
Description |
certificateId |
string
|
Certificate id |
theme |
string
|
This value represents the visual theme of the seal. If seal doesn't exist, default values are used if params not present. If seal does exist, default values will not be used to update unless params present. |
locale |
string
|
Determine locale for text displayed in seal image and verification page. If seal doesn't exist, default values are used if params not present. If seal does exist, default values will not be used to update unless params present. |
- Source:
certificate_validate(xMarketId, certificateCreate)
Validate a pending order for certificate
Parameters:
| Name |
Type |
Description |
xMarketId |
string
|
Setting locale for communications such as emails and error messages |
certificateCreate |
CertificateCreate
|
The certificate order info |
- Source:
certificate_verifydomaincontrol(certificateId)
Check Domain Control
Parameters:
| Name |
Type |
Description |
certificateId |
string
|
Certificate id to lookup |
- Source:
setToken(value, headerOrQueryName, isQuery)
Set Token
Parameters:
| Name |
Type |
Description |
value |
string
|
token's value |
headerOrQueryName |
string
|
the header or query name to send the token at |
isQuery |
boolean
|
true if send the token as query param, otherwise, send as header param |
- Source: