Skip to content

Commit 3c44707

Browse files
authored
Recommends Service Accounts (in preview, no automation examples) (#117)
* Recommends Service Accounts (in preview, no automation examples) * Small copy review change and link add * Sentence case fix
1 parent 6a5184d commit 3c44707

File tree

1 file changed

+28
-3
lines changed

1 file changed

+28
-3
lines changed

source/auth.txt

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -240,12 +240,36 @@ To learn more, see the blog :website:`Manage
240240
MongoDB Atlas Database Secrets in HashiCorp Vault
241241
</blog/post/manage-atlas-database-secrets-hashicorp-vault>`.
242242

243+
.. _arch-center-admin-api-recs:
243244

244245
Recommendations for {+atlas-admin-api+}
245246
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
246247

247-
|service| provides |api| key-based authentication to securely manage
248-
programmatic access. It uses |http| Digest authentication to protect requests.
248+
|service| provides two ways to authenticate to the {+atlas-admin-api+}:
249+
250+
- :atlas:`Service accounts </api/service-accounts-overview/>`
251+
(currently available as a :website:`Preview feature
252+
</resources/products/early-access>`\)
253+
- |api| keys
254+
255+
Service Accounts
256+
````````````````
257+
258+
Service accounts use industry-standard OAuth2.0 to securely authenticate
259+
with {+service+} through the {+atlas-admin-api+}. We recommend that you use service accounts instead of |api| keys when possible because they provide added security through use short-lived
260+
access tokens and required credential rotations.
261+
262+
Service accounts are
263+
available as a Preview feature, and you can manage programmatic access for service accounts only by using the {+atlas-ui+} or the {+atlas-admin-api+}. You can't manage
264+
programmatic access for service accounts through the {+atlas-cli+} or Terraform.
265+
266+
To learn more, see :atlas:`Service Accounts Overview </api/service-accounts-overview/>`.
267+
268+
API Keys
269+
````````
270+
271+
If you don't use service accounts, you can use |api| key-based authentication to securely manage
272+
programmatic access. |api| key-based authentication uses |http| Digest authentication to protect requests.
249273
The |api| public key functions as the username, and the corresponding
250274
private key serves as the password.
251275
You should store these keys in a third party secrets management system,
@@ -299,7 +323,8 @@ only be allowed in lower environments during development and testing.
299323
Recommendations for {+atlas-ui+} and {+atlas-admin-api+} (Control Plane)
300324
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
301325

302-
You can assign users and API keys to predefined roles, specifying the
326+
You can assign users, service accounts, and API keys to predefined
327+
roles, specifying the
303328
actions they can perform within |service| organizations, projects, or
304329
both. Use Identity Federation to manage access by linking your identity
305330
provider groups to |service| roles through group-role mappings.

0 commit comments

Comments
 (0)