MongoDB/getOrgApiKey

Online calls unavailable · details below

MongoDBMongoDB Atlas Administration API v2

GET/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}

Read get Org Api Key.

Contract-preserving GET endpoint for get Org Api Key in the MongoDB Atlas Administration API. Resource-specific values are supplied by the caller at runtime.

All 540 MongoDB Atlas administration endpoints from a fixed Apache-2.0 OpenAPI revision. Hub provides documentation and an independent SDK/CLI, but never proxies account, organization, project, network, backup, or operational data; callers connect directly with local credentials.

Request

operationId
getOrgApiKey
Server
https://cloud.mongodb.com
Authentication
ServiceAccounts, DigestAuth

Request parameters

envelope

queryboolean

envelope value in the Atlas Administration API contract.

orgId

pathstringrequired

org Id value in the Atlas Administration API contract.

4888442a3354817a7320eb61

pretty

queryboolean

pretty value in the Atlas Administration API contract.

apiUserId

pathstringrequired

api User Id value in the Atlas Administration API contract.

Responses

200

ApiKeyUserDetailsapplication/vnd.atlas.2023-01-01+json

Successful supplier response.

Properties: descidlinksprivateKeypublicKeyroles

401

ApiErrorapplication/json

Supplier response with HTTP status 401.

Properties: badRequestDetaildetailerrorerrorCodeparametersreason

403

ApiErrorapplication/json

Supplier response with HTTP status 403.

Properties: badRequestDetaildetailerrorerrorCodeparametersreason

404

ApiErrorapplication/json

Supplier response with HTTP status 404.

Properties: badRequestDetaildetailerrorerrorCodeparametersreason

429

ApiErrorapplication/json

Supplier response with HTTP status 429.

Properties: badRequestDetaildetailerrorerrorCodeparametersreason

500

ApiErrorapplication/json

Supplier response with HTTP status 500.

Properties: badRequestDetaildetailerrorerrorCodeparametersreason

{
  "id": "32b6e34b3d91647abb20e7b8",
  "links": {
    "href": "https://cloud.mongodb.com/api/atlas",
    "rel": "self"
  },
  "privateKey": "55c3bbb6-b4bb-0be1-e66d20841f3e",
  "publicKey": "zmmrboas",
  "roles": {
    "groupId": "32b6e34b3d91647abb20e7b8",
    "orgId": "32b6e34b3d91647abb20e7b8"
  }
}