Skip to content

MLE-24747 Updating docs for cloud auth #241

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

Closed
wants to merge 1 commit into from
Closed

MLE-24747 Updating docs for cloud auth #241

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 5 additions & 2 deletions docs/configuring-the-connector.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ Regardless of the required authentication strategy, you must configure the follo
- `ml.connection.port` = the port of the MarkLogic app server you wish to connect to
- `ml.connection.securityContextType` = the authentication strategy required by the MarkLogic app server; defaults to DIGEST

The choices for `ml.connection.securityContextType` are DIGEST, BASIC, CERTIFICATE, KERBEROS, and NONE. The additional
properties required for each are described in the following sections.
The choices for `ml.connection.securityContextType` are `DIGEST`, `BASIC`, `CERTIFICATE`, `KERBEROS`, `CLOUD`, and
`NONE`. The additional properties required for each are described in the following sections.

### Configuring digest and basic authentication

Expand All @@ -61,6 +61,7 @@ Both digest and basic authentication require the following properties to be conf

Progress Data Cloud authentication requires the following properties to be configured:

- `ml.connection.securityContextType=CLOUD`
- `ml.connection.basePath` = the base path in your Progress Data Cloud instance that points to the REST API server you
wish to connect to
- `ml.connection.cloudApiKey` = the API key for authenticating with your Progress Data Cloud instance
Expand All @@ -71,13 +72,15 @@ You should also set `ml.connection.port` to 443 for connecting to Progress Data

Certificate authentication requires the following properties to be configured:

- `ml.connection.securityContextType=CERTIFICATE`
- `ml.connection.certFile` = path to a PKCS12 certificate file
- `ml.connection.certPassword` = password for the PKCS12 certificate file

### Configuring Kerberos authentication

Kerberos authentication requires the following property to be configured:

- `ml.connection.securityContextType=KERBEROS`
- `ml.connection.externalName` = the name of the principal to be used in Kerberos authentication

### Configuring no authentication
Expand Down