Create One Organization API Key¶
On this page
To make this API request, you must have the
Organization Owner
role.
To make this API request, you must have the
Project Owner
role.
Resource¶
Base URL: https://cloud.mongodb.com/api/atlas/v1.0
POST /orgs/{ORG-ID}/apiKeys
Request Path Parameters¶
All path parameters are required.
Name | Type | Description |
---|---|---|
ORG-ID | string | Unique identifier for the organization
whose API Keys you want to retrieve. Use the
/orgs endpoint
to retrieve all organizations to which the authenticated
user has access. |
Request Query Parameters¶
This endpoint might use any of the HTTP request query parameters available to all Atlas Administration API resources. All of these are optional.
Name | Type | Necessity | Description | Default | ||||||
---|---|---|---|---|---|---|---|---|---|---|
pretty | boolean | Optional | Flag indicating whether the response body should be in a
prettyprint format. | false | ||||||
envelope | boolean | Optional | Flag indicating if Atlas should wrap the response in a JSON envelope. This option may be needed for some API clients. These 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:
| false |
Request Body Parameters¶
At least one of the two body parameters are required.
Name | Type | Necessity | Description |
---|---|---|---|
desc | string | Optional | Description of the key. If desc is provided, it must be
between 1 and 250 characters long. |
roles | string array | Optional | List of roles that the API Key needs to have. If the
The Organization roles are
|
Response¶
Name | Type | Description |
---|---|---|
desc | string | Description of this Organization API key. |
id | string | Unique identifier for this Organization API key. |
links | string | An array of documents, representing a link
to one or more sub-resources and/or related resources such as
list pagination. See Linking for
more information. |
privateKey | string | Redacted Private key for this Organization API key. Note This key displays unredacted when first created. |
publicKey | string | Public key for this Organization API key. |
roles | object array | Roles that this Organization API key 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
Project Roles If this is a
|
Example Request¶
The user who makes the request can be formatted either as
{USERNAME}:{APIKEY}
or {PUBLIC-KEY}:{PRIVATE-KEY}
.
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --request POST "https://cloud.mongodb.com/api/atlas/v1.0/orgs/{ORG-ID}/apiKeys?pretty=true" \ --data '{ "desc" : "New API key for test purposes", "roles": ["ORG_MEMBER", "ORG_BILLING_ADMIN"] }'
Example Response¶
Response Header¶
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
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¶
1 { 2 "desc" : "New API key for test purposes", 3 "id" : "5c47ba5127d9d61b9fd8a27b", 4 "links" : [ { 5 "href" : "https://cloud.mongodb.com/api/atlas/v1.0/orgs/5980cfc70b6d12029d82e3f6/apiKeys/5c47ba5127d9d61b9fd8a27b", 6 "rel" : "self" 7 } ], 8 "privateKey" : "********-****-****-db2c132ca78d", 9 "publicKey" : "{PUBLIC-KEY}", 10 "roles" : [ { 11 "orgId" : "5980cfc70b6d97029d82e3f6", 12 "roleName" : "ORG_BILLING_ADMIN" 13 }, { 14 "orgId" : "5980cfc70b6d97029d82e3f6", 15 "roleName" : "ORG_MEMBER" 16 } ] 17 }