API >
API Resources >
Programmatic API Keys >
Get All Organization API Keys Assigned to One Project

Get All Organization API Keys Assigned to One Project¶

On this page

Resource
Response
- Response Document
- results Embedded Document
Example Request
Example Response
- Response Header
- Response Body

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

Resource¶

GET /groups/{GROUP-ID}/apiKeys

Request Path Parameters¶

Name	Type	Description
`GROUP-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¶

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

Name Type Description Default

pageNum integer Page number (1-based). 1

itemsPerPage integer Maximum number of items to return, up to a maximum of 100. 100

pretty boolean Indicates whether the response body should be in a prettyprint format. 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:

`status`	HTTP response code
`envelope`	The expected 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.

Request Body Parameters¶

This endpoint does not 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	object array	This array includes one object for each item detailed in the results Embedded Document section.
links	object array	This 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	The 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. Note 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 Atlas.
`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 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_CHARTS_ADMIN` `GROUP_CLUSTER_MANAGER` `GROUP_DATA_ACCESS_ADMIN` `GROUP_DATA_ACCESS_READ_ONLY` `GROUP_DATA_ACCESS_READ_WRITE` `GROUP_OWNER` `GROUP_READ_ONLY`

Example Request¶

Note

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

copy

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --include \
  --request GET "https://cloud.mongodb.com/api/atlas/v1.0/groups/5953c5f380eef53887615f9a/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}

Response Body¶

{
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/5953c5f380eef53887615f9a/apiKeys?pretty=true&pageNum=1&itemsPerPage=100",
    "rel" : "self"
  } ],
  "results" : [ {
    "desc" : "Updated API Key description for DOCSP-6042",
    "id" : "5d1cf1f980eef570c9fc87e5",
    "links" : [ {
      "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfe20b6d97029d82fa63/apiKeys/5d1cf1f980eef570c9fc87e5",
      "rel" : "self"
    } ],
    "privateKey" : "********-****-****-9d4ae38e4ddd",
    "publicKey" : "{PUBLIC-KEY}",
    "roles" : [ {
      "groupId" : "5953c5f380eef53887615f9a",
      "roleName" : "GROUP_AUTOMATION_ADMIN"
    }, {
      "groupId" : "5953c5f380eef53887615f9a",
      "roleName" : "GROUP_MONITORING_ADMIN"
    }, {
      "orgId" : "5980cfe20b6d97029d82fa63",
      "roleName" : "ORG_MEMBER"
    }, {
      "orgId" : "5980cfe20b6d97029d82fa63",
      "roleName" : "ORG_BILLING_ADMIN"
    }, {
      "groupId" : "5953c5f380eef53887615f9a",
      "roleName" : "GROUP_DATA_ACCESS_ADMIN"
    }, {
      "groupId" : "5953c5f380eef53887615f9a",
      "roleName" : "GROUP_USER_ADMIN"
    }, {
      "groupId" : "5953c5f380eef53887615f9a",
      "roleName" : "GROUP_READ_ONLY"
    }, {
      "groupId" : "5953c5f380eef53887615f9a",
      "roleName" : "GROUP_OWNER"
    }, {
      "orgId" : "5980cfe20b6d97029d82fa63",
      "roleName" : "ORG_OWNER"
    }, {
      "groupId" : "5953c5f380eef53887615f9a",
      "roleName" : "GROUP_DATA_ACCESS_READ_WRITE"
    }, {
      "orgId" : "5980cfe20b6d97029d82fa63",
      "roleName" : "ORG_GROUP_CREATOR"
    }, {
      "orgId" : "5980cfe20b6d97029d82fa63",
      "roleName" : "ORG_READ_ONLY"
    }, {
      "groupId" : "5953c5f380eef53887615f9a",
      "roleName" : "GROUP_DATA_ACCESS_READ_ONLY"
    }, {
      "groupId" : "5953c5f380eef53887615f9a",
      "roleName" : "GROUP_BACKUP_ADMIN"
    }, {
      "groupId" : "5953c5f380eef53887615f9a",
      "roleName" : "GROUP_CLUSTER_MANAGER"
    } ]
  }, {
    "desc" : "New API key for test purposes",
    "id" : "5d1d12c087d9d63e6d682438",
    "links" : [ {
      "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfe20b6d97029d82fa63/apiKeys/5d1d12c087d9d63e6d682438",
      "rel" : "self"
    } ],
    "privateKey" : "********-****-****-cb34f12aafdb",
    "publicKey" : "oxhzytwb",
    "roles" : [ {
      "groupId" : "5953c5f380eef53887615f9a",
      "roleName" : "GROUP_READ_ONLY"
    }, {
      "orgId" : "5980cfe20b6d97029d82fa63",
      "roleName" : "ORG_MEMBER"
    }, {
      "orgId" : "5980cfe20b6d97029d82fa63",
      "roleName" : "ORG_BILLING_ADMIN"
    } ]
  } ],
  "totalCount" : 2
}

← Delete One Organization API Key Create and Assign One Organization API Key to One Project →