Skip to content

Fixed typo in README-PLAYBOOK.md #500

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
paulternate wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Fixed typo in README-PLAYBOOK.md #500

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f20357e
Fixed typo in README-PLAYBOOK.md
paulternate Jun 28, 2024
815ab73
Update README-PLAYBOOK.md
paulternate Jul 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README-PLAYBOOK.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ The top-level structure of the file is described as follows:

| Field | Type | Required | Description |
|------------------|------------------------------------------------------|----------------|-----------------------------------------------------------------------------------------------------------------|
| certificateTasks | array of [CertificateTak](#certificatetask) objects | ***Required*** | One or more [CertificateTask](#certificatetask) objects to be executed by VCert. |
| certificateTasks | array of [CertificateTask](#certificatetask) objects | ***Required*** | One or more [CertificateTask](#certificatetask) objects to be executed by VCert. |
| config | [Config](#config) object | ***Required*** | Contains one [Connection](#connection) object to either TLS Protect Cloud, TLS Protect Datacenter, or Firefly. |

### Config
Expand All @@ -123,7 +123,7 @@ The top-level structure of the file is described as follows:
|--------------|----------------------------------------------|------------|------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| accessToken | string | *Optional* | *Optional* | n/a | Used when [Connection.platform](#connection) is `tlspdc` for authenticating to the REST API.<br/>If omitted, invalid, or expired, vcert will attempt to use the [Credential.p12Task](#credentials) or [Credential.refreshToken](#credentials) to get a valid accessToken.<br/>Upon successful refresh, this value will be overwritten with the new valid accessToken. |
| apiKey | string | n/a | *Optional* | n/a | Used when [Connection.platform](#connection) is `tlspc` for authenticating to the REST API. |
| clientId | string | *Optional* | n/a | *Optional* | Used when [Connection.platform](#connection) is `tlspc` to map to the API integration to be used. If omitted, uses `vcert-sdk` as default.<br/><br/>Used when [Connection.platform](#connection) is `firefly` along with `clientSecret` to follow a `credentials authorization flow`. |
| clientId | string | *Optional* | n/a | *Optional* | Used when [Connection.platform](#connection) is `tlspdc` to map to the API integration to be used. If omitted, uses `vcert-sdk` as default.<br/><br/>Used when [Connection.platform](#connection) is `firefly` along with `clientSecret` to follow a `credentials authorization flow`. |
| clientSecret | string | n/a | n/a | *Optional* | Used when [Connection.platform](#connection) is `firefly` along with `clientId` to follow a `credentials authorization flow` to get an authorization token from the OAuth2 Provider. |
| externalJWT | string | n/a | *Optional* | n/a | Used when [Connection.platform](#connection) is `tlspc` along with `tokenURL` to request a new authorization token from a service account. |
| idP | [IdentityProvider](#identityprovider) object | n/a | n/a | ***Required*** | Used when [Connection.platform](#connection) is `firefly` to request a new authorization token to the OAuth2 Provider. |
Expand Down