Navigation

Deauthorize a Cloud Provider Access Role

The Atlas API uses HTTP Digest Authentication. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request.

For complete documentation on configuring API access for an Atlas project, see Configure Atlas API Access.

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

Note

Groups and projects are synonymous terms. Your {GROUP-ID} is the same as your project ID. For existing groups, your group/project ID remains the same. The resource and corresponding endpoints use the term groups.

Resource

DELETE api/atlas/v1.0/groups/{GROUP-ID}/cloudProviderAccess/{CLOUD-PROVIDER}/{ROLE-ID}

Request Path Parameters

Parameter Type Description
GROUP-ID string Unique identifier for the project with a cloud provider role you want to deauthorize.
CLOUD-PROVIDER string Cloud provider of the role you want to deauthorize. Currently only AWS is supported.
ROLE-ID string Unique identifier of the role to deauthorize.

Request Query Parameters

The following query parameters are optional:

Query Parameter Type Description Default
pretty boolean Displays response in a prettyprint format. false
envelope boolean Specifies whether or not to wrap the response in an envelope. false

Request Body Parameters

This endpoint does not use HTTP request body parameters.

Response

A successful request to this endpoint returns no content.

Example Request

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" -X DELETE --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     "https://cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/cloudProviderAccess/{CLOUD-PROVIDER}/{ROLE-ID}?pretty=true"