diff --git a/README-PLAYBOOK.md b/README-PLAYBOOK.md index d910fbab..e46d4cdc 100644 --- a/README-PLAYBOOK.md +++ b/README-PLAYBOOK.md @@ -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 @@ -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.
If omitted, invalid, or expired, vcert will attempt to use the [Credential.p12Task](#credentials) or [Credential.refreshToken](#credentials) to get a valid accessToken.
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.

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.

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. |