Docs Menu
Docs Home
/
MongoDB Cloud Manager
/
API
/
Cloud Manager Administration API Resources
/
Programmatic API Keys
/
Organization API Keys on Projects

Get All Organization API Keys Assigned to One Project

On this page

  • Resource
  • Request Path Parameters
  • Request Query Parameters
  • Request Body Parameters
  • Response
  • Response Document
  • results Embedded Document
  • Example Request
  • Example Response
  • Response Header
  • Response Body

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

Resource

GET /groups/{PROJECT-ID}/apiKeys

Request Path Parameters

Name
Type
Description
PROJECT-ID
string
Unique 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.

Request Query Parameters

The following query parameters are optional:

Name
Type
Description
Default
pageNum
integer
Page number (1-index based).
1
itemsPerPage
integer
Number of items to return per page, up to a maximum of 500.
100
pretty
boolean
false
envelope
boolean

Indicates whether or not to wrap the response in an 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, response body includes:

Name
Description
status
HTTP response code
content
Expected response body

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

None

Request Body Parameters

This endpoint doesn't use HTTP request body parameters.

Response

Response Document

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.

Name
Type
Description
results
array
Array includes one object for each item detailed in the results Embedded Document section.
links
array
Array includes one or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification.
totalCount
number
Integer count 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.

results Embedded Document

Each result is one Project API key.

Name
Type
Description
desc
string
Description of this Organization API key assigned to this Project.
id
string
Unique identifier for this Organization API key assigned to this Project.
privateKey
string

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

This key displays unredacted when first created.

publicKey
string
Public key for this Organization API key assigned to this Project.
roles
object array
Roles that this Organization API key assigned to this Project has. This array returns all the Organization and Project roles the user has in Cloud Manager.
roles.groupId
string
Unique identifier of the Project to which this role belongs.
roles.orgId
string
Unique identifier of the Organization to which this role belongs.
roles.roleName
string

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

Organization Roles

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

Role Value in API
Role
ORG_OWNER
ORG_MEMBER
ORG_GROUP_CREATOR
ORG_BILLING_ADMIN
ORG_READ_ONLY
ORG_BILLING_READ_ONLY

Project Roles

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

Role Value in API
Role
GROUP_AUTOMATION_ADMIN
GROUP_BACKUP_ADMIN
GROUP_BILLING_ADMIN
Project Billing Admin
GROUP_DATA_ACCESS_ADMIN
GROUP_DATA_ACCESS_READ_ONLY
GROUP_DATA_ACCESS_READ_WRITE
GROUP_MONITORING_ADMIN
GROUP_OWNER
GROUP_READ_ONLY
GROUP_USER_ADMIN

Example Request

Note

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

1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2     --header "Accept: application/json" \
3     --include \
4     --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/apiKeys?pretty=true"

Example Response

Response Header

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}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

Response Body

1{
2  "links" : [ {
3    "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/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" : "{PROJECT-ID}",
17      "roleName" : "GROUP_AUTOMATION_ADMIN"
18    }, {
19      "groupId" : "{PROJECT-ID}",
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" : "{PROJECT-ID}",
29      "roleName" : "GROUP_DATA_ACCESS_ADMIN"
30    }, {
31      "groupId" : "{PROJECT-ID}",
32      "roleName" : "GROUP_USER_ADMIN"
33    }, {
34      "groupId" : "{PROJECT-ID}",
35      "roleName" : "GROUP_READ_ONLY"
36    }, {
37      "groupId" : "{PROJECT-ID}",
38      "roleName" : "GROUP_OWNER"
39    }, {
40      "orgId" : "5980cfe20b6d97029d82fa63",
41      "roleName" : "ORG_OWNER"
42    }, {
43      "groupId" : "{PROJECT-ID}",
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" : "{PROJECT-ID}",
53      "roleName" : "GROUP_DATA_ACCESS_READ_ONLY"
54    }, {
55      "groupId" : "{PROJECT-ID}",
56      "roleName" : "GROUP_BACKUP_ADMIN"
57    }, {
58      "groupId" : "{PROJECT-ID}",
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" : "{PROJECT-ID}",
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}

Back

Organization API Keys on Projects

Next

Create and Assign One Organization API Key to One Project