You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Remove One Entry from One Project IP Access List
107
+
* @description Removes one access list entry from the specified project's IP access list. Each entry in the project's IP access list contains one IP address, one CIDR-notated block of IP addresses, or one AWS Security Group ID. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The `/groups/{GROUP-ID}/accessList` endpoint manages the database IP access list. This endpoint is distinct from the `orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist` endpoint, which manages the access list for MongoDB Cloud organizations.
* @description Removes one database user from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role, the Project Stream Processing Owner role, or the Project Database Access Admin role.
/** @description 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. */
5327
+
envelope?: components["parameters"]["envelope"];
5328
+
/** @description Flag that indicates whether the response body should be in the prettyprint format. */
5329
+
pretty?: components["parameters"]["pretty"];
5330
+
};
5331
+
header?: never;
5332
+
path: {
5333
+
/** @description 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.
5334
+
*
5335
+
* **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. */
5336
+
groupId: components["parameters"]["groupId"];
5337
+
/** @description Access list entry that you want to remove from the project's IP access list. This value can use one of the following: one AWS security group ID, one IP address, or one CIDR block of addresses. For CIDR blocks that use a subnet mask, replace the forward slash (`/`) with its URL-encoded value (`%2F`). When you remove an entry from the IP access list, existing connections from the removed address or addresses may remain open for a variable amount of time. The amount of time it takes MongoDB Cloud to close the connection depends upon several factors, including:
5338
+
*
5339
+
* - how your application established the connection,
5340
+
* - how MongoDB Cloud or the driver using the address behaves, and
5341
+
* - which protocol (like TCP or UDP) the connection uses. */
5342
+
entryValue: string;
5343
+
};
5344
+
cookie?: never;
5345
+
};
5346
+
requestBody?: never;
5347
+
responses: {
5348
+
/** @description This endpoint does not return a response body. */
/** @description 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. */
5601
+
envelope?: components["parameters"]["envelope"];
5602
+
/** @description Flag that indicates whether the response body should be in the prettyprint format. */
5603
+
pretty?: components["parameters"]["pretty"];
5604
+
};
5605
+
header?: never;
5606
+
path: {
5607
+
/** @description 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.
5608
+
*
5609
+
* **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. */
5610
+
groupId: components["parameters"]["groupId"];
5611
+
/** @description The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`. */
5612
+
databaseName: string;
5613
+
/** @description Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:
5614
+
*
5615
+
* | Authentication Method | Parameter Needed | Parameter Value | username Format |
5616
+
* |---|---|---|---|
5617
+
* | AWS IAM | awsIAMType | ROLE | <abbr title="Amazon Resource Name">ARN</abbr> |
5618
+
* | AWS IAM | awsIAMType | USER | <abbr title="Amazon Resource Name">ARN</abbr> |
0 commit comments