Skip to content

Commit c808699

Browse files
committed
CLOUDP-298233: Postman SA support
1 parent 5ba5c86 commit c808699

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

tools/postman/collection-description.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,28 @@ This collection is an introduction to the [MongoDB Atlas Administration API](htt
77
To test out the MongoDB Atlas Admin API collection, start by [creating a free MongoDB Atlas cluster](https://www.mongodb.com/docs/atlas/tutorial/deploy-free-tier-cluster/).
88
Once you have a cluster, you can [fork this collection](https://learning.postman.com/docs/collaborating-in-postman/using-version-control/forking-elements/\#create-a-fork) into your own workspace in order to manage your MongoDB Atlas resources. Make sure to also fork the MongoDB Atlas Administration API Environment at the same time.
99

10-
Once you have your cluster up and running, follow [this guide](https://www.mongodb.com/docs/atlas/configure-api-access/) to find your public and private API keys. Set each of these values as secrets in the [Postman Vault](https://learning.postman.com/docs/sending-requests/postman-vault/postman-vault-secrets/):
10+
### Authentication Using Service Accounts (OAuth)
11+
12+
Once you have your cluster up and running, follow [this guide](https://www.mongodb.com/docs/atlas/configure-api-access/) to create new Service Account.
13+
Once created copy your public and private API keys.
14+
Set each of these values as secrets in the [Postman Vault](https://learning.postman.com/docs/sending-requests/postman-vault/postman-vault-secrets/):
15+
16+
- Service Account Client ID: \`mongodb-public-clientid\`
17+
- Service Account Client Secret: \`mongodb-private-clientsecret\`
18+
19+
#### Digest Authentication
20+
21+
Alternatively to Service Account you can use [API Keys](https://www.mongodb.com/docs/atlas/configure-api-access/) authentication.
22+
Set each of these values as secrets in the [Postman Vault](https://learning.postman.com/docs/sending-requests/postman-vault/postman-vault-secrets/):
1123

1224
- public API key as the value for a key named \`mongodb-public-api-key\`
1325
- private API key as the value for a key named \`mongodb-private-api-key\`
1426

27+
Additionally to setting those values you would need to manually configure[Digest Authentication in the Collection Authentication Settings](https://learning.postman.com/docs/sending-requests/authorization/digest-auth/)
28+
29+
30+
### Using API
31+
1532
You can now explore the various endpoints. For each endpoint, edit the query and path variables such as group ID and organization ID. For some requests, like POST requests, editing the body of the request is also required.
1633

1734
For more details, you can follow along with the [Configuring Atlas in Postman With the Atlas Administration API](https://www.mongodb.com/developer/products/atlas/admin-api-postman/) blog.

0 commit comments

Comments
 (0)