Navigation

Get All Organization API Keys Assigned to One Project

Base URL: https://cloud.mongodb.com/api/atlas/v1.0

GET /groups/{GROUP-ID}/apiKeys
NameTypeDescription
GROUP-IDstringUnique identifier for the Project from which you want to retrieve its assigned Organization API keys. Use the /groups endpoint to retrieve all Projects to which the authenticated user has access.

This endpoint may use any of the HTTP request query parameters available to all Atlas API resources. These are all optional.

NameTypeNecessityDescriptionDefault
pageNumintegerOptionalPage number (1-based).1
itemsPerPageintegerOptionalMaximum number of items to return, up to a maximum of 100.100
includeCountbooleanOptionalSpecifies whether the response returns the totalCount field.true
prettybooleanOptionalIndicates whether the response body should be in a prettyprint format.false
envelopebooleanOptional

Flag indicating if Atlas should wrap the response in a JSON envelope.

Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query.

For endpoints that return one result, the response body includes:

statusHTTP response code
envelopeExpected response body

For endpoints that return a list of results, the results object is an envelope. Atlas adds the status field to the response body.

false

This endpoint doesn't use HTTP request body parameters.

The response JSON document includes an array of result objects, an array of link objects and a count of the total number of result objects retrieved.

NameTypeDescription
resultsarray of objectsOne object for each item detailed in the results Embedded Document section.
linksarray of objectsOne or more links to sub-resources and/or related resources. The relations between URL s are explained in the Web Linking Specification
totalCountintegerCount of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.

Each result is one Project API key.

NameTypeDescription
descstringDescription of this Organization API key assigned to this Project.
idstringUnique identifier for this Organization API key assigned to this Project.
privateKeystring

Redacted Private key for this Organization API key assigned to this Project.

Info With Circle IconCreated with Sketch.Note
This key displays unredacted when first created.
publicKeystringPublic key for this Organization API key assigned to this Project.
rolesarray of objectsRoles that this Organization API key assigned to this Project has. This array returns all the Organization and Project roles the user has in Atlas.
roles.groupIdstringUnique identifier of the Project to which this role belongs.
roles.orgIdstringUnique identifier of the Organization to which this role belongs.
roles.roleNamestring

Name of the role. This resource returns all the roles the user has in Atlas. Possible values are:

Organization Roles

If this is an roles.orgId (Organization), values include:

  • ORG_OWNER
  • ORG_MEMBER
  • ORG_GROUP_CREATOR
  • ORG_BILLING_ADMIN
  • ORG_READ_ONLY

Project Roles

If this is an roles.groupId (Project), values include:

  • GROUP_CLUSTER_MANAGER
  • GROUP_DATA_ACCESS_ADMIN
  • GROUP_DATA_ACCESS_READ_ONLY
  • GROUP_DATA_ACCESS_READ_WRITE
  • GROUP_OWNER
  • GROUP_READ_ONLY
Info With Circle IconCreated with Sketch.Note

The user who makes the request can be formatted either as {USERNAME}:{APIKEY} or {PUBLIC-KEY}:{PRIVATE-KEY}.

1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2 --header "Accept: application/json" \
3 --header "Content-Type: application/json" \
4 --include \
5 --request GET "https://cloud.mongodb.com/api/atlas/v1.0/groups/5953c5f380eef53887615f9a/apiKeys?pretty=true"
HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
1{
2 "links" : [ {
3 "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/5953c5f380eef53887615f9a/apiKeys?pretty=true&pageNum=1&itemsPerPage=100",
4 "rel" : "self"
5 } ],
6 "results" : [ {
7 "desc" : "Updated API Key description for DOCSP-6042",
8 "id" : "5d1cf1f980eef570c9fc87e5",
9 "links" : [ {
10 "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfe20b6d97029d82fa63/apiKeys/5d1cf1f980eef570c9fc87e5",
11 "rel" : "self"
12 } ],
13 "privateKey" : "********-****-****-9d4ae38e4ddd",
14 "publicKey" : "{PUBLIC-KEY}",
15 "roles" : [ {
16 "groupId" : "5953c5f380eef53887615f9a",
17 "roleName" : "GROUP_AUTOMATION_ADMIN"
18 }, {
19 "groupId" : "5953c5f380eef53887615f9a",
20 "roleName" : "GROUP_MONITORING_ADMIN"
21 }, {
22 "orgId" : "5980cfe20b6d97029d82fa63",
23 "roleName" : "ORG_MEMBER"
24 }, {
25 "orgId" : "5980cfe20b6d97029d82fa63",
26 "roleName" : "ORG_BILLING_ADMIN"
27 }, {
28 "groupId" : "5953c5f380eef53887615f9a",
29 "roleName" : "GROUP_DATA_ACCESS_ADMIN"
30 }, {
31 "groupId" : "5953c5f380eef53887615f9a",
32 "roleName" : "GROUP_USER_ADMIN"
33 }, {
34 "groupId" : "5953c5f380eef53887615f9a",
35 "roleName" : "GROUP_READ_ONLY"
36 }, {
37 "groupId" : "5953c5f380eef53887615f9a",
38 "roleName" : "GROUP_OWNER"
39 }, {
40 "orgId" : "5980cfe20b6d97029d82fa63",
41 "roleName" : "ORG_OWNER"
42 }, {
43 "groupId" : "5953c5f380eef53887615f9a",
44 "roleName" : "GROUP_DATA_ACCESS_READ_WRITE"
45 }, {
46 "orgId" : "5980cfe20b6d97029d82fa63",
47 "roleName" : "ORG_GROUP_CREATOR"
48 }, {
49 "orgId" : "5980cfe20b6d97029d82fa63",
50 "roleName" : "ORG_READ_ONLY"
51 }, {
52 "groupId" : "5953c5f380eef53887615f9a",
53 "roleName" : "GROUP_DATA_ACCESS_READ_ONLY"
54 }, {
55 "groupId" : "5953c5f380eef53887615f9a",
56 "roleName" : "GROUP_BACKUP_ADMIN"
57 }, {
58 "groupId" : "5953c5f380eef53887615f9a",
59 "roleName" : "GROUP_CLUSTER_MANAGER"
60 } ]
61 }, {
62 "desc" : "New API key for test purposes",
63 "id" : "5d1d12c087d9d63e6d682438",
64 "links" : [ {
65 "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfe20b6d97029d82fa63/apiKeys/5d1d12c087d9d63e6d682438",
66 "rel" : "self"
67 } ],
68 "privateKey" : "********-****-****-cb34f12aafdb",
69 "publicKey" : "oxhzytwb",
70 "roles" : [ {
71 "groupId" : "5953c5f380eef53887615f9a",
72 "roleName" : "GROUP_READ_ONLY"
73 }, {
74 "orgId" : "5980cfe20b6d97029d82fa63",
75 "roleName" : "ORG_MEMBER"
76 }, {
77 "orgId" : "5980cfe20b6d97029d82fa63",
78 "roleName" : "ORG_BILLING_ADMIN"
79 } ]
80 } ],
81 "totalCount" : 2
82}
Give Feedback