Skip to content

Commit

Permalink
DOC-4630 DOC-4629 Feedback updates to fix cert-based auth steps in re…
Browse files Browse the repository at this point in the history
…lease notes
  • Loading branch information
rrelledge committed Dec 11, 2024
1 parent 43d7fd7 commit 249ccd1
Showing 1 changed file with 15 additions and 7 deletions.
22 changes: 15 additions & 7 deletions content/operate/rs/release-notes/rs-7-8-releases/rs-7-8-4-tba.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,16 @@ This version offers:

- To set up certificate-based authentication, use [REST API]({{<relref "/operate/rs/references/rest-api">}}) requests to do the following:

1. Configure a trusted CA certificate `mtls_trusted_ca` using an [update cluster certificate]({{<relref "/operate/rs/references/rest-api/requests/cluster/certificates#put-cluster-update_cert">}}) request:

```sh
PUT /v1/cluster/update_cert
{
"name": "mtls_trusted_ca",
"certificate": "<content of certificate PEM file>"
}
```

1. [Update cluster settings]({{<relref "/operate/rs/references/rest-api/requests/cluster#put-cluster">}}) with mutual TLS configuration:

```sh
Expand All @@ -49,19 +59,17 @@ This version offers:
}]
}
```
1. Configure a trusted CA certificate `mtls_trusted_ca` using an [update cluster certificate]({{<relref "/operate/rs/references/rest-api/requests/cluster/certificates#put-cluster-update_cert">}}) request:

1. Include `"auth_method": "certificate"` and `certificate_subject_line` in the request body when you [create new users]({{<relref "/operate/rs/references/rest-api/requests/users#post-user">}}) or [update existing users]({{<relref "/operate/rs/references/rest-api/requests/users#put-user">}}):

```sh
PUT /v1/cluster/update_cert
POST /v1/users | PUT /v1/users/<user-id>
{
"name": "mtls_trusted_ca",
"certificate": "<content of certificate PEM file>"
"auth_method": "certificate",
"certificate_subject_line": "<subject of the user's client certificate>"
}
```

1. Include `"auth_method": "certificate"` in the request body when you [create new users]({{<relref "/operate/rs/references/rest-api/requests/users#post-user">}}) or [update existing users]({{<relref "/operate/rs/references/rest-api/requests/users#put-user">}}).

- Limitations:

- Certificate-based authentication is not implemented for the Cluster Manager UI.
Expand Down

0 comments on commit 249ccd1

Please sign in to comment.