Assign One Organization API Key to One Project¶
On this page
Base URL: https://cloud.mongodb.com/api/atlas/v1.0
Resource¶
PATCH /groups/{GROUP-ID}/apiKeys/{API-KEY-ID}
Request Path Parameters¶
Name | Type | Description |
---|---|---|
GROUP-ID | string | Unique identifier for the Project whose API keys you want to
update. Use the
/groups endpoint
to retrieve all organizations to which the authenticated
user has access. |
API-KEY-ID | string | Unique identifier for the API key you want to update. Use the
/groups/{GROUP-ID}/apiKeys endpoint
to retrieve all API keys to which the authenticated
user has access for the specified organization. |
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¶
The body parameter is required.
Name | Type | Necessity | Description |
---|---|---|---|
roles | string array | Required | List of roles that the API Key should be granted. A minimum of one role must be provided. Any roles provided must be valid for the assigned Project:
|
Response¶
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 | array of objects | 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
Project Roles If this is an
|
Example Request¶
1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ 2 --header "Accept: application/json" \ 3 --header "Content-Type: application/json" \ 4 --include \ 5 --request PATCH "https://cloud.mongodb.com/api/atlas/v1.0/groups/5a0b1b0087d9d615f3d7e4bf/apiKeys/5c100f5180eef54be61ecf17?pretty=true" 6 --data '{ 7 "roles": [ "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE" ] 8 }'
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" : "test", 3 "id" : "5c100f5180eef54be61ecf17", 4 "links" : [ { 5 "href" : "https://cloud.mongodb.com/api/atlas/v1.0/orgs/5980cfc60b6d97029d82e32b/apiKeys/5c100f5180eef54be61ecf17", 6 "rel" : "self" 7 } ], 8 "privateKey" : "********-****-****-1493e7bcfde9", 9 "publicKey" : "{PUBLIC-KEY}", 10 "roles" : [ { 11 "groupId" : "5a0b1b0087d9d615f3d7e4bf", 12 "roleName" : "GROUP_DATA_ACCESS_READ_WRITE" 13 }, { 14 "groupId" : "5a0b1b0087d9d615f3d7e4bf", 15 "roleName" : "GROUP_READ_ONLY" 16 }, { 17 "groupId" : "56a10ad2e4b0fd3b9a9bb396", 18 "roleName" : "GROUP_READ_ONLY" 19 }, { 20 "orgId" : "5980cfc60b6d97029d82e32b", 21 "roleName" : "ORG_MEMBER" 22 } ] 23 }