diff --git a/pr/671/entrust_cagw_certificate_module.html b/pr/671/entrust_cagw_certificate_module.html index 46905947..f08072d2 100644 --- a/pr/671/entrust_cagw_certificate_module.html +++ b/pr/671/entrust_cagw_certificate_module.html @@ -218,14 +218,14 @@ see

action_reason

string

-

reason has to be given for the action.

+

Reason has to be given for the action.

action_type

string

-

what action has to be taken on the certificate that is RevokeAction, HoldAction, UnholdAction.

+

What action has to be taken on the certificate that is RevokeAction, HoldAction, UnholdAction.

Choices:

  • "RevokeAction"

  • @@ -259,7 +259,7 @@ see

cagw_api_specification_path

path

-

path for CAGW api specification doc.

+

Path for CAGW api specification doc.

@@ -281,6 +281,7 @@ see

string

This parameter defines which CA type connected at the backend. Supported list of CAs include Entrust Certificate Solution(ECS), Entrust Security Manager(SM), Entrust PKIHUB CA(PKIaaS), Microsoft CA(MSCA).

+

If connector_name is not provided when request_type=new, module will be failed.

Choices:

  • "SM"

  • @@ -556,7 +557,7 @@ see

dn

string

-

distinguished name used either for generation for CSR or given in the CAGW enrollment api when enrollment_format=PKCS12.

+

Distinguished name given for the enrollment.

@@ -575,7 +576,7 @@ see

force

boolean

-

If force is used, a certificate is requested regardless of whether path points to an existing valid certificate.

+

If force=True then a certificate is requested regardless of whether path points to an existing valid certificate.

Choices:

  • false ← (default)

  • @@ -594,7 +595,7 @@ see

p12_protection_password

string

-

p12 password for server side generation of the private key and CSR.

+

PKCS12 password for server side generation of the private key and CSR.

@@ -602,7 +603,7 @@ see

path

The destination path for the generated certificate as a PEM encoded cert.

-

If there is already an Entrust certificate at this location, it will be replaced always.

+

If there is already a certificate at the path and force=True then it will be replaced always. but if force is not specified then we get the certificate validity for existing certificate from Entrust CAGW. If cert_days < remaining_days then only a new certificate will be obtained.

If enrollment_format=PKCS12 then it will have Base64 encoded PKCS12 body.

@@ -610,7 +611,7 @@ see

port

integer

-

port for Entrust CAGW.

+

Port for Entrust CAGW.

Default: 443

@@ -618,8 +619,8 @@ see

remaining_days

integer

-

The number of days the certificate must have left being valid. If cert_days < remaining_days then a new certificate will be obtained using request_type.

-

The force option may be used to ensure that a new certificate is always obtained.

+

The number of days the certificate must have left being valid. If a certificate is already present at the path and force is not specified then we get the certificate validity for existing certificate from Entrust CAGW. If cert_days < remaining_days then a new certificate will be obtained.

+

The force=True option may be used to ensure that a new certificate is always obtained.

Default: 30

@@ -627,7 +628,7 @@ see

request_type

string / required

-

request type that is new (stands for enrollment), get (stands for get certificate), action (stands for action to be taken on the certificate).

+

Request type that is new (stands for enrollment), get (stands for get certificate), action (stands for action to be taken on the certificate).

Choices:

serial_no

string

-

serial number of the already issued certificate.

+

Serial number of the already issued certificate.

@@ -717,7 +718,7 @@ see

validate_certs

boolean

-

if set to false then SSL validation with Server is skipped. This should be set to false only for testing purposes.

+

If set to false then SSL validation with Server is skipped. This should be set to false only for testing purposes.

Choices: