atlas api serviceAccounts deleteProjectServiceAccountAccessListEntry
Public Preview: please provide feedback: Removes the specified access list entry from the specified Service Account for the project.
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
You can't remove the requesting IP address from the access list.
This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteProjectServiceAccountAccessListEntry.
For more information and examples, see the referenced API documentation linked above.
Syntax
atlas api serviceAccounts deleteProjectServiceAccountAccessListEntry [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
--clientId | string | true | The Client ID of the Service Account. |
--envelope | envelope | false | Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
--groupId | string | true | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. 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. |
-h, --help | false | help for deleteProjectServiceAccountAccessListEntry | |
--ipAddress | string | true | One IP address or multiple IP addresses represented as one CIDR block. When specifying a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /. |
-o, --output | string | false | preferred api format, can be ["json", go-template] This value defaults to "json". |
--outputFile | string | false | file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) |
--pretty | false | Flag that indicates whether the response body should be in the prettyprint format. | |
--version | string | false | api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". |
Inherited Options
Name | Type | Required | Description |
|---|---|---|---|
-P, --profile | string | false | Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Examples
atlas api serviceAccounts deleteProjectServiceAccountAccessListEntry --version 2024-08-05 --clientId mdb_sa_id_1234567890abcdef12345678 --groupId 32b6e34b3d91647abb20e7b8 --ipAddress 192.0.2.0%2F24