Skip to content

Commit 33f25b4

Browse files
author
Keyfactor
committed
Update generated docs
1 parent 9f8ff0f commit 33f25b4

1 file changed

Lines changed: 11 additions & 12 deletions

File tree

README.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55
<p align="center">
66
<!-- Badges -->
77
<img src="https://img.shields.io/badge/integration_status-production-3D1973?style=flat-square" alt="Integration Status: production" />
8-
<a href="https://github.com/Keyfactor/globalsign-mssl-caplugin-dev/releases"><img src="https://img.shields.io/github/v/release/Keyfactor/globalsign-mssl-caplugin-dev?style=flat-square" alt="Release" /></a>
9-
<img src="https://img.shields.io/github/issues/Keyfactor/globalsign-mssl-caplugin-dev?style=flat-square" alt="Issues" />
10-
<img src="https://img.shields.io/github/downloads/Keyfactor/globalsign-mssl-caplugin-dev/total?style=flat-square&label=downloads&color=28B905" alt="GitHub Downloads (all assets, all releases)" />
8+
<a href="https://github.com/Keyfactor/globalsign-mssl-caplugin/releases"><img src="https://img.shields.io/github/v/release/Keyfactor/globalsign-mssl-caplugin?style=flat-square" alt="Release" /></a>
9+
<img src="https://img.shields.io/github/issues/Keyfactor/globalsign-mssl-caplugin?style=flat-square" alt="Issues" />
10+
<img src="https://img.shields.io/github/downloads/Keyfactor/globalsign-mssl-caplugin/total?style=flat-square&label=downloads&color=28B905" alt="GitHub Downloads (all assets, all releases)" />
1111
</p>
1212

1313
<p align="center">
@@ -60,7 +60,7 @@ This extension uses the contact information of the GCC Domain point of contact f
6060

6161
1. Install the AnyCA Gateway REST per the [official Keyfactor documentation](https://software.keyfactor.com/Guides/AnyCAGatewayREST/Content/AnyCAGatewayREST/InstallIntroduction.htm).
6262

63-
2. On the server hosting the AnyCA Gateway REST, download and unzip the latest [GlobalSign MSSL Gateway AnyCA Gateway REST plugin](https://github.com/Keyfactor/globalsign-mssl-caplugin-dev/releases/latest) from GitHub.
63+
2. On the server hosting the AnyCA Gateway REST, download and unzip the latest [GlobalSign MSSL Gateway AnyCA Gateway REST plugin](https://github.com/Keyfactor/globalsign-mssl-caplugin/releases/latest) from GitHub.
6464

6565
3. Copy the unzipped directory (usually called `net6.0` or `net8.0`) to the Extensions directory:
6666

@@ -127,22 +127,21 @@ This extension uses the contact information of the GCC Domain point of contact f
127127

128128
## Valid GlobalSign SAN Usage
129129
GlobalSign supports specific combinations of SAN types with certain products. For example, a Private IP can only be used as a SAN with a `PV_INTRA` Certificate.
130-
Refer to the GlobalSign documentation for more information on SAN usage:
131-
[GlobalSign MSSL API User Guide (Section 2.2.5)](https://www.globalsign.com/en/repository/globalsign-mssl-api-user-guide.pdf)
130+
Please refer to the GlobalSign documentation for more information on SAN usage: [GlobalSign MSSL API User Guide (Section 2.2.5)](https://www.globalsign.com/en/repository/globalsign-mssl-api-user-guide.pdf)
132131

133132
## Enrollment Fields
134133

135134
### Required Enrollment Fields
136135
The following fields are required for enrollment on all certificate templates:
137-
- **ContactName** Set Data Type to 'string'. The name of the contact person for the certificate. This is required by the GlobalSign API.
136+
- **ContactName**: Set Data Type to 'string' when creating the field. The name of the contact person for the certificate. This is required by the GlobalSign API.
138137

139138
### PV_INTRA Specific Enrollment Fields
140139
The following fields are available for use in the enrollment of `PV_INTRA` Certificates:
141-
- **PrivateDomain** Set Data Type to 'string'. Set to `true` if enrolling a certificate for a private domain (e.g., `.local`, `.lab`, etc.).
142-
- **If `PrivateDomain` is set to `true`, the following fields must also be specified:**
143-
- **RequesterEmail** Set Data Type to 'string'. The contact email address for the enrollment. Required by the GlobalSign API.
144-
- **RequesterTel:** Set Data Type to 'string'. The contact telephone number for the enrollment. Required by the GlobalSign API.
145-
- **InternalIP** Set Data Type to 'string'. Set to `true` if an IP SAN attached during a `PV_INTRA` certificate enrollment is a private IP address (e.g., `10.x.x.x`, `192.168.x.x`, etc.).
140+
- **PrivateDomain**: Set Data Type to 'string' when creating the field. Set to `true` if enrolling a certificate for a private domain (e.g., `.local`, `.lab`, etc.).
141+
- **If PrivateDomain is set to `true`, the following fields must also be specified:**
142+
- **RequesterEmail**: Set Data Type to 'string' when creating the field. The contact email address for the enrollment. Required by the GlobalSign API.
143+
- **RequesterTel**: Set Data Type to 'string' when creating the field. The contact telephone number for the enrollment. Required by the GlobalSign API.
144+
- **InternalIP**: Set Data Type to 'string' when creating the field. Set to `true` if an IP SAN attached during a `PV_INTRA` certificate enrollment is a private IP address (e.g., `10.x.x.x`, `192.168.x.x`, etc.).
146145

147146

148147
## License

0 commit comments

Comments
 (0)