diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml
index 92292f5d..d6c6f82c 100644
--- a/.github/workflows/pr.yml
+++ b/.github/workflows/pr.yml
@@ -20,6 +20,7 @@ jobs:
uses: golangci/golangci-lint-action@v3.5.0
with:
version: v1.52.2
+ args: --timeout=10m
tests-on-unix:
needs: golangci-lint # run after golangci-lint action to not produce duplicated errors
diff --git a/admin/api_data_federation.go b/admin/api_data_federation.go
index 09f17609..313959ea 100644
--- a/admin/api_data_federation.go
+++ b/admin/api_data_federation.go
@@ -101,7 +101,7 @@ type DataFederationApi interface {
CreateOneDataFederationQueryLimitWithParams(ctx context.Context, args *CreateOneDataFederationQueryLimitApiParams) CreateOneDataFederationQueryLimitApiRequest
// Interface only available internally
- createOneDataFederationQueryLimitExecute(r CreateOneDataFederationQueryLimitApiRequest) ([]DataFederationTenantQueryLimit, *http.Response, error)
+ createOneDataFederationQueryLimitExecute(r CreateOneDataFederationQueryLimitApiRequest) (*DataFederationTenantQueryLimit, *http.Response, error)
/*
DeleteDataFederationPrivateEndpoint Remove One Federated Database Instance and Online Archive Private Endpoint from One Project
@@ -317,7 +317,7 @@ type DataFederationApi interface {
ReturnFederatedDatabaseQueryLimitWithParams(ctx context.Context, args *ReturnFederatedDatabaseQueryLimitApiParams) ReturnFederatedDatabaseQueryLimitApiRequest
// Interface only available internally
- returnFederatedDatabaseQueryLimitExecute(r ReturnFederatedDatabaseQueryLimitApiRequest) ([]DataFederationTenantQueryLimit, *http.Response, error)
+ returnFederatedDatabaseQueryLimitExecute(r ReturnFederatedDatabaseQueryLimitApiRequest) (*DataFederationTenantQueryLimit, *http.Response, error)
/*
ReturnFederatedDatabaseQueryLimits Return All Query Limits for One Federated Database Instance
@@ -710,7 +710,7 @@ func (a *DataFederationApiService) CreateOneDataFederationQueryLimitWithParams(c
}
}
-func (r CreateOneDataFederationQueryLimitApiRequest) Execute() ([]DataFederationTenantQueryLimit, *http.Response, error) {
+func (r CreateOneDataFederationQueryLimitApiRequest) Execute() (*DataFederationTenantQueryLimit, *http.Response, error) {
return r.ApiService.createOneDataFederationQueryLimitExecute(r)
}
@@ -738,13 +738,13 @@ func (a *DataFederationApiService) CreateOneDataFederationQueryLimit(ctx context
// Execute executes the request
//
-// @return []DataFederationTenantQueryLimit
-func (a *DataFederationApiService) createOneDataFederationQueryLimitExecute(r CreateOneDataFederationQueryLimitApiRequest) ([]DataFederationTenantQueryLimit, *http.Response, error) {
+// @return DataFederationTenantQueryLimit
+func (a *DataFederationApiService) createOneDataFederationQueryLimitExecute(r CreateOneDataFederationQueryLimitApiRequest) (*DataFederationTenantQueryLimit, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodPatch
localVarPostBody interface{}
formFiles []formFile
- localVarReturnValue []DataFederationTenantQueryLimit
+ localVarReturnValue *DataFederationTenantQueryLimit
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "DataFederationApiService.CreateOneDataFederationQueryLimit")
@@ -2040,7 +2040,7 @@ func (a *DataFederationApiService) ReturnFederatedDatabaseQueryLimitWithParams(c
}
}
-func (r ReturnFederatedDatabaseQueryLimitApiRequest) Execute() ([]DataFederationTenantQueryLimit, *http.Response, error) {
+func (r ReturnFederatedDatabaseQueryLimitApiRequest) Execute() (*DataFederationTenantQueryLimit, *http.Response, error) {
return r.ApiService.returnFederatedDatabaseQueryLimitExecute(r)
}
@@ -2067,13 +2067,13 @@ func (a *DataFederationApiService) ReturnFederatedDatabaseQueryLimit(ctx context
// Execute executes the request
//
-// @return []DataFederationTenantQueryLimit
-func (a *DataFederationApiService) returnFederatedDatabaseQueryLimitExecute(r ReturnFederatedDatabaseQueryLimitApiRequest) ([]DataFederationTenantQueryLimit, *http.Response, error) {
+// @return DataFederationTenantQueryLimit
+func (a *DataFederationApiService) returnFederatedDatabaseQueryLimitExecute(r ReturnFederatedDatabaseQueryLimitApiRequest) (*DataFederationTenantQueryLimit, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
- localVarReturnValue []DataFederationTenantQueryLimit
+ localVarReturnValue *DataFederationTenantQueryLimit
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "DataFederationApiService.ReturnFederatedDatabaseQueryLimit")
diff --git a/admin/api_database_users.go b/admin/api_database_users.go
index a5cf8be4..bcf6429a 100644
--- a/admin/api_database_users.go
+++ b/admin/api_database_users.go
@@ -43,8 +43,8 @@ type DatabaseUsersApi interface {
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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.
- @param databaseName Human-readable label that identifies 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, or LDAP, this value should be `$external`. If the user authenticates with SCRAM-SHA, this value should be `admin`.
- @param username Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication: | Authentication Method | Parameter Needed | Parameter Value | username Format | |---|---|---|---| | AWS IAM | awsType | ROLE | ARN | | AWS IAM | awsType | USER | ARN | | x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | SCRAM-SHA | awsType, x509Type, ldapAuthType | NONE | Alphanumeric string |
+ @param databaseName Human-readable label that identifies 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, or LDAP, this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC, this value should be `admin`.
+ @param username Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication: | Authentication Method | Parameter Needed | Parameter Value | username Format | |---|---|---|---| | AWS IAM | awsType | ROLE | ARN | | AWS IAM | awsType | USER | ARN | | x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | OIDC | oidcAuthType | IDP_GROUP | Atlas OIDC IdP Identifier (found in Federation Settings, or contact Support), followed by a '/', followed by the IdP group name | | SCRAM-SHA | awsType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |
@return DeleteDatabaseUserApiRequest
*/
DeleteDatabaseUser(ctx context.Context, groupId string, databaseName string, username string) DeleteDatabaseUserApiRequest
@@ -68,8 +68,8 @@ type DatabaseUsersApi interface {
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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.
- @param databaseName Human-readable label that identifies 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, or LDAP, this value should be `$external`. If the user authenticates with SCRAM-SHA, this value should be `admin`.
- @param username Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication: | Authentication Method | Parameter Needed | Parameter Value | username Format | |---|---|---|---| | AWS IAM | awsType | ROLE | ARN | | AWS IAM | awsType | USER | ARN | | x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | SCRAM-SHA | awsType, x509Type, ldapAuthType | NONE | Alphanumeric string |
+ @param databaseName Human-readable label that identifies 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, or LDAP, this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC, this value should be `admin`.
+ @param username Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication: | Authentication Method | Parameter Needed | Parameter Value | username Format | |---|---|---|---| | AWS IAM | awsType | ROLE | ARN | | AWS IAM | awsType | USER | ARN | | x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | OIDC | oidcAuthType | IDP_GROUP | Atlas OIDC IdP Identifier (found in Federation Settings, or contact Support), followed by a '/', followed by the IdP group name | | SCRAM-SHA | awsType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |
@return GetDatabaseUserApiRequest
*/
GetDatabaseUser(ctx context.Context, groupId string, databaseName string, username string) GetDatabaseUserApiRequest
@@ -116,8 +116,8 @@ type DatabaseUsersApi interface {
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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.
- @param databaseName Human-readable label that identifies 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, or LDAP, this value should be `$external`. If the user authenticates with SCRAM-SHA, this value should be `admin`.
- @param username Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication: | Authentication Method | Parameter Needed | Parameter Value | username Format | |---|---|---|---| | AWS IAM | awsType | ROLE | ARN | | AWS IAM | awsType | USER | ARN | | x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | SCRAM-SHA | awsType, x509Type, ldapAuthType | NONE | Alphanumeric string |
+ @param databaseName Human-readable label that identifies 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, or LDAP, this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC, this value should be `admin`.
+ @param username Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication: | Authentication Method | Parameter Needed | Parameter Value | username Format | |---|---|---|---| | AWS IAM | awsType | ROLE | ARN | | AWS IAM | awsType | USER | ARN | | x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | OIDC | oidcAuthType | IDP_GROUP | Atlas OIDC IdP Identifier (found in Federation Settings, or contact Support), followed by a '/', followed by the IdP group name | | SCRAM-SHA | awsType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |
@return UpdateDatabaseUserApiRequest
*/
UpdateDatabaseUser(ctx context.Context, groupId string, databaseName string, username string, databaseUser *DatabaseUser) UpdateDatabaseUserApiRequest
@@ -312,8 +312,8 @@ Removes one database user from the specified project. To use this resource, the
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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.
- @param databaseName Human-readable label that identifies 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, or LDAP, this value should be `$external`. If the user authenticates with SCRAM-SHA, this value should be `admin`.
- @param username Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication: | Authentication Method | Parameter Needed | Parameter Value | username Format | |---|---|---|---| | AWS IAM | awsType | ROLE | ARN | | AWS IAM | awsType | USER | ARN | | x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | SCRAM-SHA | awsType, x509Type, ldapAuthType | NONE | Alphanumeric string |
+ @param databaseName Human-readable label that identifies 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, or LDAP, this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC, this value should be `admin`.
+ @param username Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication: | Authentication Method | Parameter Needed | Parameter Value | username Format | |---|---|---|---| | AWS IAM | awsType | ROLE | ARN | | AWS IAM | awsType | USER | ARN | | x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | OIDC | oidcAuthType | IDP_GROUP | Atlas OIDC IdP Identifier (found in Federation Settings, or contact Support), followed by a '/', followed by the IdP group name | | SCRAM-SHA | awsType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |
@return DeleteDatabaseUserApiRequest
*/
func (a *DatabaseUsersApiService) DeleteDatabaseUser(ctx context.Context, groupId string, databaseName string, username string) DeleteDatabaseUserApiRequest {
@@ -454,8 +454,8 @@ Returns one database user that belong to the specified project. To use this reso
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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.
- @param databaseName Human-readable label that identifies 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, or LDAP, this value should be `$external`. If the user authenticates with SCRAM-SHA, this value should be `admin`.
- @param username Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication: | Authentication Method | Parameter Needed | Parameter Value | username Format | |---|---|---|---| | AWS IAM | awsType | ROLE | ARN | | AWS IAM | awsType | USER | ARN | | x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | SCRAM-SHA | awsType, x509Type, ldapAuthType | NONE | Alphanumeric string |
+ @param databaseName Human-readable label that identifies 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, or LDAP, this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC, this value should be `admin`.
+ @param username Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication: | Authentication Method | Parameter Needed | Parameter Value | username Format | |---|---|---|---| | AWS IAM | awsType | ROLE | ARN | | AWS IAM | awsType | USER | ARN | | x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | OIDC | oidcAuthType | IDP_GROUP | Atlas OIDC IdP Identifier (found in Federation Settings, or contact Support), followed by a '/', followed by the IdP group name | | SCRAM-SHA | awsType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |
@return GetDatabaseUserApiRequest
*/
func (a *DatabaseUsersApiService) GetDatabaseUser(ctx context.Context, groupId string, databaseName string, username string) GetDatabaseUserApiRequest {
@@ -777,8 +777,8 @@ Updates one database user that belongs to the specified project. To use this res
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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.
- @param databaseName Human-readable label that identifies 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, or LDAP, this value should be `$external`. If the user authenticates with SCRAM-SHA, this value should be `admin`.
- @param username Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication: | Authentication Method | Parameter Needed | Parameter Value | username Format | |---|---|---|---| | AWS IAM | awsType | ROLE | ARN | | AWS IAM | awsType | USER | ARN | | x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | SCRAM-SHA | awsType, x509Type, ldapAuthType | NONE | Alphanumeric string |
+ @param databaseName Human-readable label that identifies 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, or LDAP, this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC, this value should be `admin`.
+ @param username Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication: | Authentication Method | Parameter Needed | Parameter Value | username Format | |---|---|---|---| | AWS IAM | awsType | ROLE | ARN | | AWS IAM | awsType | USER | ARN | | x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | OIDC | oidcAuthType | IDP_GROUP | Atlas OIDC IdP Identifier (found in Federation Settings, or contact Support), followed by a '/', followed by the IdP group name | | SCRAM-SHA | awsType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |
@return UpdateDatabaseUserApiRequest
*/
func (a *DatabaseUsersApiService) UpdateDatabaseUser(ctx context.Context, groupId string, databaseName string, username string, databaseUser *DatabaseUser) UpdateDatabaseUserApiRequest {
diff --git a/admin/api_invoices.go b/admin/api_invoices.go
index 394bea17..5de852e6 100644
--- a/admin/api_invoices.go
+++ b/admin/api_invoices.go
@@ -35,7 +35,7 @@ type InvoicesApi interface {
DownloadInvoiceCSVWithParams(ctx context.Context, args *DownloadInvoiceCSVApiParams) DownloadInvoiceCSVApiRequest
// Interface only available internally
- downloadInvoiceCSVExecute(r DownloadInvoiceCSVApiRequest) (*http.Response, error)
+ downloadInvoiceCSVExecute(r DownloadInvoiceCSVApiRequest) (string, *http.Response, error)
/*
GetInvoice Return One Organization Invoice
@@ -59,7 +59,7 @@ type InvoicesApi interface {
GetInvoiceWithParams(ctx context.Context, args *GetInvoiceApiParams) GetInvoiceApiRequest
// Interface only available internally
- getInvoiceExecute(r GetInvoiceApiRequest) (*Invoice, *http.Response, error)
+ getInvoiceExecute(r GetInvoiceApiRequest) (string, *http.Response, error)
/*
ListInvoices Return All Invoices for One Organization
@@ -132,7 +132,7 @@ func (a *InvoicesApiService) DownloadInvoiceCSVWithParams(ctx context.Context, a
}
}
-func (r DownloadInvoiceCSVApiRequest) Execute() (*http.Response, error) {
+func (r DownloadInvoiceCSVApiRequest) Execute() (string, *http.Response, error) {
return r.ApiService.downloadInvoiceCSVExecute(r)
}
@@ -156,16 +156,19 @@ func (a *InvoicesApiService) DownloadInvoiceCSV(ctx context.Context, orgId strin
}
// Execute executes the request
-func (a *InvoicesApiService) downloadInvoiceCSVExecute(r DownloadInvoiceCSVApiRequest) (*http.Response, error) {
+//
+// @return string
+func (a *InvoicesApiService) downloadInvoiceCSVExecute(r DownloadInvoiceCSVApiRequest) (string, *http.Response, error) {
var (
- localVarHTTPMethod = http.MethodGet
- localVarPostBody interface{}
- formFiles []formFile
+ localVarHTTPMethod = http.MethodGet
+ localVarPostBody interface{}
+ formFiles []formFile
+ localVarReturnValue string
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "InvoicesApiService.DownloadInvoiceCSV")
if err != nil {
- return nil, &GenericOpenAPIError{error: err.Error()}
+ return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv"
@@ -176,10 +179,10 @@ func (a *InvoicesApiService) downloadInvoiceCSVExecute(r DownloadInvoiceCSVApiRe
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
if strlen(r.orgId) < 24 {
- return nil, reportError("orgId must have at least 24 elements")
+ return localVarReturnValue, nil, reportError("orgId must have at least 24 elements")
}
if strlen(r.orgId) > 24 {
- return nil, reportError("orgId must have less than 24 elements")
+ return localVarReturnValue, nil, reportError("orgId must have less than 24 elements")
}
// to determine the Content-Type header
@@ -201,19 +204,19 @@ func (a *InvoicesApiService) downloadInvoiceCSVExecute(r DownloadInvoiceCSVApiRe
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
- return nil, err
+ return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
- return localVarHTTPResponse, err
+ return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
- return localVarHTTPResponse, err
+ return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
@@ -225,14 +228,23 @@ func (a *InvoicesApiService) downloadInvoiceCSVExecute(r DownloadInvoiceCSVApiRe
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
- return localVarHTTPResponse, newErr
+ return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, localVarHTTPMethod, localVarPath, v)
newErr.model = v
- return localVarHTTPResponse, newErr
+ return localVarReturnValue, localVarHTTPResponse, newErr
}
- return localVarHTTPResponse, nil
+ err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
+ if err != nil {
+ newErr := &GenericOpenAPIError{
+ body: localVarBody,
+ error: err.Error(),
+ }
+ return localVarReturnValue, localVarHTTPResponse, newErr
+ }
+
+ return localVarReturnValue, localVarHTTPResponse, nil
}
type GetInvoiceApiRequest struct {
@@ -256,7 +268,7 @@ func (a *InvoicesApiService) GetInvoiceWithParams(ctx context.Context, args *Get
}
}
-func (r GetInvoiceApiRequest) Execute() (*Invoice, *http.Response, error) {
+func (r GetInvoiceApiRequest) Execute() (string, *http.Response, error) {
return r.ApiService.getInvoiceExecute(r)
}
@@ -281,13 +293,13 @@ func (a *InvoicesApiService) GetInvoice(ctx context.Context, orgId string, invoi
// Execute executes the request
//
-// @return Invoice
-func (a *InvoicesApiService) getInvoiceExecute(r GetInvoiceApiRequest) (*Invoice, *http.Response, error) {
+// @return string
+func (a *InvoicesApiService) getInvoiceExecute(r GetInvoiceApiRequest) (string, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
- localVarReturnValue *Invoice
+ localVarReturnValue string
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "InvoicesApiService.GetInvoice")
@@ -325,7 +337,7 @@ func (a *InvoicesApiService) getInvoiceExecute(r GetInvoiceApiRequest) (*Invoice
}
// to determine the Accept header
- localVarHTTPHeaderAccepts := []string{"application/vnd.atlas.2023-01-01+json", "application/json"}
+ localVarHTTPHeaderAccepts := []string{"application/vnd.atlas.2023-01-01+csv", "application/vnd.atlas.2023-01-01+json", "application/json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
diff --git a/admin/api_ldap_configuration.go b/admin/api_ldap_configuration.go
index f7670623..6d95df11 100644
--- a/admin/api_ldap_configuration.go
+++ b/admin/api_ldap_configuration.go
@@ -34,7 +34,7 @@ type LDAPConfigurationApi interface {
DeleteLDAPConfigurationWithParams(ctx context.Context, args *DeleteLDAPConfigurationApiParams) DeleteLDAPConfigurationApiRequest
// Interface only available internally
- deleteLDAPConfigurationExecute(r DeleteLDAPConfigurationApiRequest) (*http.Response, error)
+ deleteLDAPConfigurationExecute(r DeleteLDAPConfigurationApiRequest) (*UserSecurity, *http.Response, error)
/*
GetLDAPConfiguration Return the Current LDAP or X.509 Configuration
@@ -153,7 +153,7 @@ func (a *LDAPConfigurationApiService) DeleteLDAPConfigurationWithParams(ctx cont
}
}
-func (r DeleteLDAPConfigurationApiRequest) Execute() (*http.Response, error) {
+func (r DeleteLDAPConfigurationApiRequest) Execute() (*UserSecurity, *http.Response, error) {
return r.ApiService.deleteLDAPConfigurationExecute(r)
}
@@ -175,16 +175,19 @@ func (a *LDAPConfigurationApiService) DeleteLDAPConfiguration(ctx context.Contex
}
// Execute executes the request
-func (a *LDAPConfigurationApiService) deleteLDAPConfigurationExecute(r DeleteLDAPConfigurationApiRequest) (*http.Response, error) {
+//
+// @return UserSecurity
+func (a *LDAPConfigurationApiService) deleteLDAPConfigurationExecute(r DeleteLDAPConfigurationApiRequest) (*UserSecurity, *http.Response, error) {
var (
- localVarHTTPMethod = http.MethodDelete
- localVarPostBody interface{}
- formFiles []formFile
+ localVarHTTPMethod = http.MethodDelete
+ localVarPostBody interface{}
+ formFiles []formFile
+ localVarReturnValue *UserSecurity
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "LDAPConfigurationApiService.DeleteLDAPConfiguration")
if err != nil {
- return nil, &GenericOpenAPIError{error: err.Error()}
+ return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping"
@@ -194,10 +197,10 @@ func (a *LDAPConfigurationApiService) deleteLDAPConfigurationExecute(r DeleteLDA
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
if strlen(r.groupId) < 24 {
- return nil, reportError("groupId must have at least 24 elements")
+ return localVarReturnValue, nil, reportError("groupId must have at least 24 elements")
}
if strlen(r.groupId) > 24 {
- return nil, reportError("groupId must have less than 24 elements")
+ return localVarReturnValue, nil, reportError("groupId must have less than 24 elements")
}
// to determine the Content-Type header
@@ -219,19 +222,19 @@ func (a *LDAPConfigurationApiService) deleteLDAPConfigurationExecute(r DeleteLDA
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
- return nil, err
+ return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
- return localVarHTTPResponse, err
+ return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
- return localVarHTTPResponse, err
+ return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
@@ -243,14 +246,23 @@ func (a *LDAPConfigurationApiService) deleteLDAPConfigurationExecute(r DeleteLDA
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
- return localVarHTTPResponse, newErr
+ return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, localVarHTTPMethod, localVarPath, v)
newErr.model = v
- return localVarHTTPResponse, newErr
+ return localVarReturnValue, localVarHTTPResponse, newErr
}
- return localVarHTTPResponse, nil
+ err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
+ if err != nil {
+ newErr := &GenericOpenAPIError{
+ body: localVarBody,
+ error: err.Error(),
+ }
+ return localVarReturnValue, localVarHTTPResponse, newErr
+ }
+
+ return localVarReturnValue, localVarHTTPResponse, nil
}
type GetLDAPConfigurationApiRequest struct {
diff --git a/admin/api_maintenance_windows_.go b/admin/api_maintenance_windows_.go
index 20429ca1..984ae86d 100644
--- a/admin/api_maintenance_windows_.go
+++ b/admin/api_maintenance_windows_.go
@@ -80,7 +80,7 @@ type MaintenanceWindowsApi interface {
ResetMaintenanceWindowWithParams(ctx context.Context, args *ResetMaintenanceWindowApiParams) ResetMaintenanceWindowApiRequest
// Interface only available internally
- resetMaintenanceWindowExecute(r ResetMaintenanceWindowApiRequest) (map[string]interface{}, *http.Response, error)
+ resetMaintenanceWindowExecute(r ResetMaintenanceWindowApiRequest) (*http.Response, error)
/*
ToggleMaintenanceAutoDefer Toggle Automatic Deferral of Maintenance for One Project
@@ -398,7 +398,7 @@ func (a *MaintenanceWindowsApiService) ResetMaintenanceWindowWithParams(ctx cont
}
}
-func (r ResetMaintenanceWindowApiRequest) Execute() (map[string]interface{}, *http.Response, error) {
+func (r ResetMaintenanceWindowApiRequest) Execute() (*http.Response, error) {
return r.ApiService.resetMaintenanceWindowExecute(r)
}
@@ -420,19 +420,16 @@ func (a *MaintenanceWindowsApiService) ResetMaintenanceWindow(ctx context.Contex
}
// Execute executes the request
-//
-// @return map[string]interface{}
-func (a *MaintenanceWindowsApiService) resetMaintenanceWindowExecute(r ResetMaintenanceWindowApiRequest) (map[string]interface{}, *http.Response, error) {
+func (a *MaintenanceWindowsApiService) resetMaintenanceWindowExecute(r ResetMaintenanceWindowApiRequest) (*http.Response, error) {
var (
- localVarHTTPMethod = http.MethodDelete
- localVarPostBody interface{}
- formFiles []formFile
- localVarReturnValue map[string]interface{}
+ localVarHTTPMethod = http.MethodDelete
+ localVarPostBody interface{}
+ formFiles []formFile
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "MaintenanceWindowsApiService.ResetMaintenanceWindow")
if err != nil {
- return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
+ return nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/api/atlas/v2/groups/{groupId}/maintenanceWindow"
@@ -442,10 +439,10 @@ func (a *MaintenanceWindowsApiService) resetMaintenanceWindowExecute(r ResetMain
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
if strlen(r.groupId) < 24 {
- return localVarReturnValue, nil, reportError("groupId must have at least 24 elements")
+ return nil, reportError("groupId must have at least 24 elements")
}
if strlen(r.groupId) > 24 {
- return localVarReturnValue, nil, reportError("groupId must have less than 24 elements")
+ return nil, reportError("groupId must have less than 24 elements")
}
// to determine the Content-Type header
@@ -467,19 +464,19 @@ func (a *MaintenanceWindowsApiService) resetMaintenanceWindowExecute(r ResetMain
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
- return localVarReturnValue, nil, err
+ return nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
- return localVarReturnValue, localVarHTTPResponse, err
+ return localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
- return localVarReturnValue, localVarHTTPResponse, err
+ return localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
@@ -491,23 +488,14 @@ func (a *MaintenanceWindowsApiService) resetMaintenanceWindowExecute(r ResetMain
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
- return localVarReturnValue, localVarHTTPResponse, newErr
+ return localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, localVarHTTPMethod, localVarPath, v)
newErr.model = v
- return localVarReturnValue, localVarHTTPResponse, newErr
- }
-
- err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
- if err != nil {
- newErr := &GenericOpenAPIError{
- body: localVarBody,
- error: err.Error(),
- }
- return localVarReturnValue, localVarHTTPResponse, newErr
+ return localVarHTTPResponse, newErr
}
- return localVarReturnValue, localVarHTTPResponse, nil
+ return localVarHTTPResponse, nil
}
type ToggleMaintenanceAutoDeferApiRequest struct {
diff --git a/admin/api_monitoring_and_logs.go b/admin/api_monitoring_and_logs.go
index d50dd210..36074ce6 100644
--- a/admin/api_monitoring_and_logs.go
+++ b/admin/api_monitoring_and_logs.go
@@ -122,19 +122,19 @@ type MonitoringAndLogsApi interface {
getDiskMeasurementsExecute(r GetDiskMeasurementsApiRequest) (*MeasurementsGeneralViewAtlas, *http.Response, error)
/*
- GetHostLogs Download Logs for One Multi-Cloud Cluster Host in One Project
+ GetHostLogs Download Logs for One Cluster Host in One Project
- Returns a compressed (.gz) log file that contains a range of log messages for the specified host for the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Data Access Read Write roles. This resource doesn't require the API Key to have an Access List. Deprecated versions: v2-{2023-01-01}
+ Returns a compressed (.gz) log file that contains a range of log messages for the specified host for the specified project. MongoDB updates process and audit logs from the cluster backend infrastructure every five minutes and contain log data from the previous five minutes. If you poll the API for log files, we recommend polling every five minutes. For example, if the logs are updated at 4:00 UTC and then you poll the API, the API returns log data from the interval between 3:55 UTC and 4:00 UTC. This feature isn't available for `M0` free clusters, `M2`, `M5`, or serverless clusters. To use this resource, the requesting API Key must have the Project Owner or Project Data Access Read/Write roles. This resource doesn't require the API Key to have an Access List. Deprecated versions: v2-{2023-01-01}
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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.
- @param hostName Fully qualified domain name or IP address of the MongoDB host that stores the log files that you want to download.
- @param logName Human-readable label of the log file that you want to return. You can return audit logs only if you enable Database Auditing for the specified project.
+ @param hostName Human-readable label that identifies the host that stores the log files that you want to download.
+ @param logName Human-readable label that identifies the log file that you want to return. To return audit logs, enable *Database Auditing* for the specified project.
@return GetHostLogsApiRequest
*/
GetHostLogs(ctx context.Context, groupId string, hostName string, logName string) GetHostLogsApiRequest
/*
- GetHostLogs Download Logs for One Multi-Cloud Cluster Host in One Project
+ GetHostLogs Download Logs for One Cluster Host in One Project
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@@ -1128,14 +1128,14 @@ func (r GetHostLogsApiRequest) Execute() (*os.File, *http.Response, error) {
}
/*
-GetHostLogs Download Logs for One Multi-Cloud Cluster Host in One Project
+GetHostLogs Download Logs for One Cluster Host in One Project
-Returns a compressed (.gz) log file that contains a range of log messages for the specified host for the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Data Access Read Write roles. This resource doesn't require the API Key to have an Access List. Deprecated versions: v2-{2023-01-01}
+Returns a compressed (.gz) log file that contains a range of log messages for the specified host for the specified project. MongoDB updates process and audit logs from the cluster backend infrastructure every five minutes and contain log data from the previous five minutes. If you poll the API for log files, we recommend polling every five minutes. For example, if the logs are updated at 4:00 UTC and then you poll the API, the API returns log data from the interval between 3:55 UTC and 4:00 UTC. This feature isn't available for `M0` free clusters, `M2`, `M5`, or serverless clusters. To use this resource, the requesting API Key must have the Project Owner or Project Data Access Read/Write roles. This resource doesn't require the API Key to have an Access List. Deprecated versions: v2-{2023-01-01}
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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.
- @param hostName Fully qualified domain name or IP address of the MongoDB host that stores the log files that you want to download.
- @param logName Human-readable label of the log file that you want to return. You can return audit logs only if you enable Database Auditing for the specified project.
+ @param hostName Human-readable label that identifies the host that stores the log files that you want to download.
+ @param logName Human-readable label that identifies the log file that you want to return. To return audit logs, enable *Database Auditing* for the specified project.
@return GetHostLogsApiRequest
*/
func (a *MonitoringAndLogsApiService) GetHostLogs(ctx context.Context, groupId string, hostName string, logName string) GetHostLogsApiRequest {
diff --git a/admin/api_multi_cloud_clusters.go b/admin/api_multi_cloud_clusters.go
index 6d7e02f8..65b073ec 100644
--- a/admin/api_multi_cloud_clusters.go
+++ b/admin/api_multi_cloud_clusters.go
@@ -85,7 +85,7 @@ type MultiCloudClustersApi interface {
getClusterExecute(r GetClusterApiRequest) (*ClusterDescriptionV15, *http.Response, error)
/*
- ListClusters Return All Multi-Cloud Clusters from One Project
+ ListClusters Return All Clusters in One Project
Returns the details for all clusters in the specific project to which you have access. Clusters contain a group of hosts that maintain the same data set. The response includes multi-cloud clusters. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List. This feature is not available for serverless clusters. Deprecated versions: v2-{2023-01-01}
@@ -95,7 +95,7 @@ type MultiCloudClustersApi interface {
*/
ListClusters(ctx context.Context, groupId string) ListClustersApiRequest
/*
- ListClusters Return All Multi-Cloud Clusters from One Project
+ ListClusters Return All Clusters in One Project
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@@ -138,7 +138,7 @@ type MultiCloudClustersApi interface {
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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.
- @param clusterName Human-readable label that identifies the advanced cluster to modify.
+ @param clusterName Human-readable label that identifies the cluster.
@return UpdateClusterApiRequest
*/
UpdateCluster(ctx context.Context, groupId string, clusterName string, clusterDescriptionV15 *ClusterDescriptionV15) UpdateClusterApiRequest
@@ -632,7 +632,7 @@ func (r ListClustersApiRequest) Execute() (*PaginatedClusterDescriptionV15, *htt
}
/*
-ListClusters Return All Multi-Cloud Clusters from One Project
+ListClusters Return All Clusters in One Project
Returns the details for all clusters in the specific project to which you have access. Clusters contain a group of hosts that maintain the same data set. The response includes multi-cloud clusters. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List. This feature is not available for serverless clusters. Deprecated versions: v2-{2023-01-01}
@@ -925,7 +925,7 @@ Updates the details for one cluster in the specified project. Clusters contain a
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId 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.
- @param clusterName Human-readable label that identifies the advanced cluster to modify.
+ @param clusterName Human-readable label that identifies the cluster.
@return UpdateClusterApiRequest
*/
func (a *MultiCloudClustersApiService) UpdateCluster(ctx context.Context, groupId string, clusterName string, clusterDescriptionV15 *ClusterDescriptionV15) UpdateClusterApiRequest {
diff --git a/admin/api_organizations.go b/admin/api_organizations.go
index fed60d36..f69e85f5 100644
--- a/admin/api_organizations.go
+++ b/admin/api_organizations.go
@@ -277,6 +277,30 @@ type OrganizationsApi interface {
// Interface only available internally
listOrganizationsExecute(r ListOrganizationsApiRequest) (*PaginatedOrganization, *http.Response, error)
+ /*
+ RemoveOrganizationUser Remove One MongoDB Cloud User from One Organization
+
+ [experimental] Removes one MongoDB Cloud user from the specified organization. To use this resource, the requesting API Key must have the Organization User Admin role. This resource doesn't require the API Key to have an Access List.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param orgId Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.
+ @param userId Unique 24-hexadecimal digit string that identifies the user to be deleted.
+ @return RemoveOrganizationUserApiRequest
+ */
+ RemoveOrganizationUser(ctx context.Context, orgId string, userId string) RemoveOrganizationUserApiRequest
+ /*
+ RemoveOrganizationUser Remove One MongoDB Cloud User from One Organization
+
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param RemoveOrganizationUserApiParams - Parameters for the request
+ @return RemoveOrganizationUserApiRequest
+ */
+ RemoveOrganizationUserWithParams(ctx context.Context, args *RemoveOrganizationUserApiParams) RemoveOrganizationUserApiRequest
+
+ // Interface only available internally
+ removeOrganizationUserExecute(r RemoveOrganizationUserApiRequest) (map[string]interface{}, *http.Response, error)
+
/*
RenameOrganization Rename One Organization
@@ -2008,6 +2032,148 @@ func (a *OrganizationsApiService) listOrganizationsExecute(r ListOrganizationsAp
return localVarReturnValue, localVarHTTPResponse, nil
}
+type RemoveOrganizationUserApiRequest struct {
+ ctx context.Context
+ ApiService OrganizationsApi
+ orgId string
+ userId string
+}
+
+type RemoveOrganizationUserApiParams struct {
+ OrgId string
+ UserId string
+}
+
+func (a *OrganizationsApiService) RemoveOrganizationUserWithParams(ctx context.Context, args *RemoveOrganizationUserApiParams) RemoveOrganizationUserApiRequest {
+ return RemoveOrganizationUserApiRequest{
+ ApiService: a,
+ ctx: ctx,
+ orgId: args.OrgId,
+ userId: args.UserId,
+ }
+}
+
+func (r RemoveOrganizationUserApiRequest) Execute() (map[string]interface{}, *http.Response, error) {
+ return r.ApiService.removeOrganizationUserExecute(r)
+}
+
+/*
+RemoveOrganizationUser Remove One MongoDB Cloud User from One Organization
+
+[experimental] Removes one MongoDB Cloud user from the specified organization. To use this resource, the requesting API Key must have the Organization User Admin role. This resource doesn't require the API Key to have an Access List.
+
+ @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
+ @param orgId Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.
+ @param userId Unique 24-hexadecimal digit string that identifies the user to be deleted.
+ @return RemoveOrganizationUserApiRequest
+*/
+func (a *OrganizationsApiService) RemoveOrganizationUser(ctx context.Context, orgId string, userId string) RemoveOrganizationUserApiRequest {
+ return RemoveOrganizationUserApiRequest{
+ ApiService: a,
+ ctx: ctx,
+ orgId: orgId,
+ userId: userId,
+ }
+}
+
+// Execute executes the request
+//
+// @return map[string]interface{}
+func (a *OrganizationsApiService) removeOrganizationUserExecute(r RemoveOrganizationUserApiRequest) (map[string]interface{}, *http.Response, error) {
+ var (
+ localVarHTTPMethod = http.MethodDelete
+ localVarPostBody interface{}
+ formFiles []formFile
+ localVarReturnValue map[string]interface{}
+ )
+
+ localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "OrganizationsApiService.RemoveOrganizationUser")
+ if err != nil {
+ return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
+ }
+
+ localVarPath := localBasePath + "/api/atlas/v2/orgs/{orgId}/users/{userId}"
+ localVarPath = strings.Replace(localVarPath, "{"+"orgId"+"}", url.PathEscape(parameterValueToString(r.orgId, "orgId")), -1)
+ localVarPath = strings.Replace(localVarPath, "{"+"userId"+"}", url.PathEscape(parameterValueToString(r.userId, "userId")), -1)
+
+ localVarHeaderParams := make(map[string]string)
+ localVarQueryParams := url.Values{}
+ localVarFormParams := url.Values{}
+ if strlen(r.orgId) < 24 {
+ return localVarReturnValue, nil, reportError("orgId must have at least 24 elements")
+ }
+ if strlen(r.orgId) > 24 {
+ return localVarReturnValue, nil, reportError("orgId must have less than 24 elements")
+ }
+ if strlen(r.userId) < 24 {
+ return localVarReturnValue, nil, reportError("userId must have at least 24 elements")
+ }
+ if strlen(r.userId) > 24 {
+ return localVarReturnValue, nil, reportError("userId must have less than 24 elements")
+ }
+
+ // to determine the Content-Type header
+ localVarHTTPContentTypes := []string{}
+
+ // set Content-Type header
+ localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
+ if localVarHTTPContentType != "" {
+ localVarHeaderParams["Content-Type"] = localVarHTTPContentType
+ }
+
+ // to determine the Accept header
+ localVarHTTPHeaderAccepts := []string{"application/vnd.atlas.2023-01-01+json", "application/json"}
+
+ // set Accept header
+ localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
+ if localVarHTTPHeaderAccept != "" {
+ localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
+ }
+ req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
+ if err != nil {
+ return localVarReturnValue, nil, err
+ }
+
+ localVarHTTPResponse, err := a.client.callAPI(req)
+ if err != nil || localVarHTTPResponse == nil {
+ return localVarReturnValue, localVarHTTPResponse, err
+ }
+
+ localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
+ localVarHTTPResponse.Body.Close()
+ localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
+ if err != nil {
+ return localVarReturnValue, localVarHTTPResponse, err
+ }
+
+ if localVarHTTPResponse.StatusCode >= 300 {
+ newErr := &GenericOpenAPIError{
+ body: localVarBody,
+ error: localVarHTTPResponse.Status,
+ }
+ var v Error
+ err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
+ if err != nil {
+ newErr.error = err.Error()
+ return localVarReturnValue, localVarHTTPResponse, newErr
+ }
+ newErr.error = formatErrorMessage(localVarHTTPResponse.Status, localVarHTTPMethod, localVarPath, v)
+ newErr.model = v
+ return localVarReturnValue, localVarHTTPResponse, newErr
+ }
+
+ err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
+ if err != nil {
+ newErr := &GenericOpenAPIError{
+ body: localVarBody,
+ error: err.Error(),
+ }
+ return localVarReturnValue, localVarHTTPResponse, newErr
+ }
+
+ return localVarReturnValue, localVarHTTPResponse, nil
+}
+
type RenameOrganizationApiRequest struct {
ctx context.Context
ApiService OrganizationsApi
diff --git a/admin/api_programmatic_api_keys.go b/admin/api_programmatic_api_keys.go
index 74a364ec..f519ddfc 100644
--- a/admin/api_programmatic_api_keys.go
+++ b/admin/api_programmatic_api_keys.go
@@ -46,7 +46,7 @@ type ProgrammaticAPIKeysApi interface {
@param orgId Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.
@return CreateApiKeyApiRequest
*/
- CreateApiKey(ctx context.Context, orgId string, createApiKey *CreateApiKey) CreateApiKeyApiRequest
+ CreateApiKey(ctx context.Context, orgId string, createOrganizationApiKey *CreateOrganizationApiKey) CreateApiKeyApiRequest
/*
CreateApiKey Create One Organization API Key
@@ -93,7 +93,7 @@ type ProgrammaticAPIKeysApi interface {
@param groupId 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.
@return CreateProjectApiKeyApiRequest
*/
- CreateProjectApiKey(ctx context.Context, groupId string, createApiKey *CreateApiKey) CreateProjectApiKeyApiRequest
+ CreateProjectApiKey(ctx context.Context, groupId string, createProjectApiKey *CreateProjectApiKey) CreateProjectApiKeyApiRequest
/*
CreateProjectApiKey Create and Assign One Organization API Key to One Project
@@ -309,7 +309,7 @@ type ProgrammaticAPIKeysApi interface {
@param apiUserId Unique 24-hexadecimal digit string that identifies this organization API key you want to update.
@return UpdateApiKeyApiRequest
*/
- UpdateApiKey(ctx context.Context, orgId string, apiUserId string, createApiKey *CreateApiKey) UpdateApiKeyApiRequest
+ UpdateApiKey(ctx context.Context, orgId string, apiUserId string, createOrganizationApiKey *CreateOrganizationApiKey) UpdateApiKeyApiRequest
/*
UpdateApiKey Update One Organization API Key
@@ -333,7 +333,7 @@ type ProgrammaticAPIKeysApi interface {
@param apiUserId Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project.
@return UpdateApiKeyRolesApiRequest
*/
- UpdateApiKeyRoles(ctx context.Context, groupId string, apiUserId string, createApiKey *CreateApiKey) UpdateApiKeyRolesApiRequest
+ UpdateApiKeyRoles(ctx context.Context, groupId string, apiUserId string, createProjectApiKey *CreateProjectApiKey) UpdateApiKeyRolesApiRequest
/*
UpdateApiKeyRoles Update Roles of One Organization API Key to One Project
@@ -503,23 +503,23 @@ func (a *ProgrammaticAPIKeysApiService) addProjectApiKeyExecute(r AddProjectApiK
}
type CreateApiKeyApiRequest struct {
- ctx context.Context
- ApiService ProgrammaticAPIKeysApi
- orgId string
- createApiKey *CreateApiKey
+ ctx context.Context
+ ApiService ProgrammaticAPIKeysApi
+ orgId string
+ createOrganizationApiKey *CreateOrganizationApiKey
}
type CreateApiKeyApiParams struct {
- OrgId string
- CreateApiKey *CreateApiKey
+ OrgId string
+ CreateOrganizationApiKey *CreateOrganizationApiKey
}
func (a *ProgrammaticAPIKeysApiService) CreateApiKeyWithParams(ctx context.Context, args *CreateApiKeyApiParams) CreateApiKeyApiRequest {
return CreateApiKeyApiRequest{
- ApiService: a,
- ctx: ctx,
- orgId: args.OrgId,
- createApiKey: args.CreateApiKey,
+ ApiService: a,
+ ctx: ctx,
+ orgId: args.OrgId,
+ createOrganizationApiKey: args.CreateOrganizationApiKey,
}
}
@@ -536,12 +536,12 @@ Creates one API key for the specified organization. An organization API key gran
@param orgId Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.
@return CreateApiKeyApiRequest
*/
-func (a *ProgrammaticAPIKeysApiService) CreateApiKey(ctx context.Context, orgId string, createApiKey *CreateApiKey) CreateApiKeyApiRequest {
+func (a *ProgrammaticAPIKeysApiService) CreateApiKey(ctx context.Context, orgId string, createOrganizationApiKey *CreateOrganizationApiKey) CreateApiKeyApiRequest {
return CreateApiKeyApiRequest{
- ApiService: a,
- ctx: ctx,
- orgId: orgId,
- createApiKey: createApiKey,
+ ApiService: a,
+ ctx: ctx,
+ orgId: orgId,
+ createOrganizationApiKey: createOrganizationApiKey,
}
}
@@ -573,8 +573,8 @@ func (a *ProgrammaticAPIKeysApiService) createApiKeyExecute(r CreateApiKeyApiReq
if strlen(r.orgId) > 24 {
return localVarReturnValue, nil, reportError("orgId must have less than 24 elements")
}
- if r.createApiKey == nil {
- return localVarReturnValue, nil, reportError("createApiKey is required and must be specified")
+ if r.createOrganizationApiKey == nil {
+ return localVarReturnValue, nil, reportError("createOrganizationApiKey is required and must be specified")
}
// to determine the Content-Type header
@@ -595,7 +595,7 @@ func (a *ProgrammaticAPIKeysApiService) createApiKeyExecute(r CreateApiKeyApiReq
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
// body params
- localVarPostBody = r.createApiKey
+ localVarPostBody = r.createOrganizationApiKey
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
@@ -841,23 +841,23 @@ func (a *ProgrammaticAPIKeysApiService) createApiKeyAccessListExecute(r CreateAp
}
type CreateProjectApiKeyApiRequest struct {
- ctx context.Context
- ApiService ProgrammaticAPIKeysApi
- groupId string
- createApiKey *CreateApiKey
+ ctx context.Context
+ ApiService ProgrammaticAPIKeysApi
+ groupId string
+ createProjectApiKey *CreateProjectApiKey
}
type CreateProjectApiKeyApiParams struct {
- GroupId string
- CreateApiKey *CreateApiKey
+ GroupId string
+ CreateProjectApiKey *CreateProjectApiKey
}
func (a *ProgrammaticAPIKeysApiService) CreateProjectApiKeyWithParams(ctx context.Context, args *CreateProjectApiKeyApiParams) CreateProjectApiKeyApiRequest {
return CreateProjectApiKeyApiRequest{
- ApiService: a,
- ctx: ctx,
- groupId: args.GroupId,
- createApiKey: args.CreateApiKey,
+ ApiService: a,
+ ctx: ctx,
+ groupId: args.GroupId,
+ createProjectApiKey: args.CreateProjectApiKey,
}
}
@@ -874,12 +874,12 @@ Creates and assigns the specified organization API key to the specified project.
@param groupId 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.
@return CreateProjectApiKeyApiRequest
*/
-func (a *ProgrammaticAPIKeysApiService) CreateProjectApiKey(ctx context.Context, groupId string, createApiKey *CreateApiKey) CreateProjectApiKeyApiRequest {
+func (a *ProgrammaticAPIKeysApiService) CreateProjectApiKey(ctx context.Context, groupId string, createProjectApiKey *CreateProjectApiKey) CreateProjectApiKeyApiRequest {
return CreateProjectApiKeyApiRequest{
- ApiService: a,
- ctx: ctx,
- groupId: groupId,
- createApiKey: createApiKey,
+ ApiService: a,
+ ctx: ctx,
+ groupId: groupId,
+ createProjectApiKey: createProjectApiKey,
}
}
@@ -911,8 +911,8 @@ func (a *ProgrammaticAPIKeysApiService) createProjectApiKeyExecute(r CreateProje
if strlen(r.groupId) > 24 {
return localVarReturnValue, nil, reportError("groupId must have less than 24 elements")
}
- if r.createApiKey == nil {
- return localVarReturnValue, nil, reportError("createApiKey is required and must be specified")
+ if r.createProjectApiKey == nil {
+ return localVarReturnValue, nil, reportError("createProjectApiKey is required and must be specified")
}
// to determine the Content-Type header
@@ -933,7 +933,7 @@ func (a *ProgrammaticAPIKeysApiService) createProjectApiKeyExecute(r CreateProje
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
// body params
- localVarPostBody = r.createApiKey
+ localVarPostBody = r.createProjectApiKey
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
@@ -2248,26 +2248,26 @@ func (a *ProgrammaticAPIKeysApiService) removeProjectApiKeyExecute(r RemoveProje
}
type UpdateApiKeyApiRequest struct {
- ctx context.Context
- ApiService ProgrammaticAPIKeysApi
- orgId string
- apiUserId string
- createApiKey *CreateApiKey
+ ctx context.Context
+ ApiService ProgrammaticAPIKeysApi
+ orgId string
+ apiUserId string
+ createOrganizationApiKey *CreateOrganizationApiKey
}
type UpdateApiKeyApiParams struct {
- OrgId string
- ApiUserId string
- CreateApiKey *CreateApiKey
+ OrgId string
+ ApiUserId string
+ CreateOrganizationApiKey *CreateOrganizationApiKey
}
func (a *ProgrammaticAPIKeysApiService) UpdateApiKeyWithParams(ctx context.Context, args *UpdateApiKeyApiParams) UpdateApiKeyApiRequest {
return UpdateApiKeyApiRequest{
- ApiService: a,
- ctx: ctx,
- orgId: args.OrgId,
- apiUserId: args.ApiUserId,
- createApiKey: args.CreateApiKey,
+ ApiService: a,
+ ctx: ctx,
+ orgId: args.OrgId,
+ apiUserId: args.ApiUserId,
+ createOrganizationApiKey: args.CreateOrganizationApiKey,
}
}
@@ -2285,13 +2285,13 @@ Updates one organization API key in the specified organization. The organization
@param apiUserId Unique 24-hexadecimal digit string that identifies this organization API key you want to update.
@return UpdateApiKeyApiRequest
*/
-func (a *ProgrammaticAPIKeysApiService) UpdateApiKey(ctx context.Context, orgId string, apiUserId string, createApiKey *CreateApiKey) UpdateApiKeyApiRequest {
+func (a *ProgrammaticAPIKeysApiService) UpdateApiKey(ctx context.Context, orgId string, apiUserId string, createOrganizationApiKey *CreateOrganizationApiKey) UpdateApiKeyApiRequest {
return UpdateApiKeyApiRequest{
- ApiService: a,
- ctx: ctx,
- orgId: orgId,
- apiUserId: apiUserId,
- createApiKey: createApiKey,
+ ApiService: a,
+ ctx: ctx,
+ orgId: orgId,
+ apiUserId: apiUserId,
+ createOrganizationApiKey: createOrganizationApiKey,
}
}
@@ -2330,8 +2330,8 @@ func (a *ProgrammaticAPIKeysApiService) updateApiKeyExecute(r UpdateApiKeyApiReq
if strlen(r.apiUserId) > 24 {
return localVarReturnValue, nil, reportError("apiUserId must have less than 24 elements")
}
- if r.createApiKey == nil {
- return localVarReturnValue, nil, reportError("createApiKey is required and must be specified")
+ if r.createOrganizationApiKey == nil {
+ return localVarReturnValue, nil, reportError("createOrganizationApiKey is required and must be specified")
}
// to determine the Content-Type header
@@ -2352,7 +2352,7 @@ func (a *ProgrammaticAPIKeysApiService) updateApiKeyExecute(r UpdateApiKeyApiReq
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
// body params
- localVarPostBody = r.createApiKey
+ localVarPostBody = r.createOrganizationApiKey
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
@@ -2399,35 +2399,35 @@ func (a *ProgrammaticAPIKeysApiService) updateApiKeyExecute(r UpdateApiKeyApiReq
}
type UpdateApiKeyRolesApiRequest struct {
- ctx context.Context
- ApiService ProgrammaticAPIKeysApi
- groupId string
- apiUserId string
- createApiKey *CreateApiKey
- pageNum *int
- itemsPerPage *int
- includeCount *bool
+ ctx context.Context
+ ApiService ProgrammaticAPIKeysApi
+ groupId string
+ apiUserId string
+ createProjectApiKey *CreateProjectApiKey
+ pageNum *int
+ itemsPerPage *int
+ includeCount *bool
}
type UpdateApiKeyRolesApiParams struct {
- GroupId string
- ApiUserId string
- CreateApiKey *CreateApiKey
- PageNum *int
- ItemsPerPage *int
- IncludeCount *bool
+ GroupId string
+ ApiUserId string
+ CreateProjectApiKey *CreateProjectApiKey
+ PageNum *int
+ ItemsPerPage *int
+ IncludeCount *bool
}
func (a *ProgrammaticAPIKeysApiService) UpdateApiKeyRolesWithParams(ctx context.Context, args *UpdateApiKeyRolesApiParams) UpdateApiKeyRolesApiRequest {
return UpdateApiKeyRolesApiRequest{
- ApiService: a,
- ctx: ctx,
- groupId: args.GroupId,
- apiUserId: args.ApiUserId,
- createApiKey: args.CreateApiKey,
- pageNum: args.PageNum,
- itemsPerPage: args.ItemsPerPage,
- includeCount: args.IncludeCount,
+ ApiService: a,
+ ctx: ctx,
+ groupId: args.GroupId,
+ apiUserId: args.ApiUserId,
+ createProjectApiKey: args.CreateProjectApiKey,
+ pageNum: args.PageNum,
+ itemsPerPage: args.ItemsPerPage,
+ includeCount: args.IncludeCount,
}
}
@@ -2463,13 +2463,13 @@ Updates the roles of the organization API key that you specify for the project t
@param apiUserId Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project.
@return UpdateApiKeyRolesApiRequest
*/
-func (a *ProgrammaticAPIKeysApiService) UpdateApiKeyRoles(ctx context.Context, groupId string, apiUserId string, createApiKey *CreateApiKey) UpdateApiKeyRolesApiRequest {
+func (a *ProgrammaticAPIKeysApiService) UpdateApiKeyRoles(ctx context.Context, groupId string, apiUserId string, createProjectApiKey *CreateProjectApiKey) UpdateApiKeyRolesApiRequest {
return UpdateApiKeyRolesApiRequest{
- ApiService: a,
- ctx: ctx,
- groupId: groupId,
- apiUserId: apiUserId,
- createApiKey: createApiKey,
+ ApiService: a,
+ ctx: ctx,
+ groupId: groupId,
+ apiUserId: apiUserId,
+ createProjectApiKey: createProjectApiKey,
}
}
@@ -2508,8 +2508,8 @@ func (a *ProgrammaticAPIKeysApiService) updateApiKeyRolesExecute(r UpdateApiKeyR
if strlen(r.apiUserId) > 24 {
return localVarReturnValue, nil, reportError("apiUserId must have less than 24 elements")
}
- if r.createApiKey == nil {
- return localVarReturnValue, nil, reportError("createApiKey is required and must be specified")
+ if r.createProjectApiKey == nil {
+ return localVarReturnValue, nil, reportError("createProjectApiKey is required and must be specified")
}
if r.pageNum != nil {
@@ -2551,7 +2551,7 @@ func (a *ProgrammaticAPIKeysApiService) updateApiKeyRolesExecute(r UpdateApiKeyR
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
// body params
- localVarPostBody = r.createApiKey
+ localVarPostBody = r.createProjectApiKey
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
diff --git a/admin/api_projects.go b/admin/api_projects.go
index 0d17e6d8..9023f2b2 100644
--- a/admin/api_projects.go
+++ b/admin/api_projects.go
@@ -290,7 +290,7 @@ type ProjectsApi interface {
ListProjectLimitsWithParams(ctx context.Context, args *ListProjectLimitsApiParams) ListProjectLimitsApiRequest
// Interface only available internally
- listProjectLimitsExecute(r ListProjectLimitsApiRequest) (*Limit, *http.Response, error)
+ listProjectLimitsExecute(r ListProjectLimitsApiRequest) ([]Limit, *http.Response, error)
/*
ListProjectUsers Return All Users in One Project
@@ -1998,7 +1998,7 @@ func (a *ProjectsApiService) ListProjectLimitsWithParams(ctx context.Context, ar
}
}
-func (r ListProjectLimitsApiRequest) Execute() (*Limit, *http.Response, error) {
+func (r ListProjectLimitsApiRequest) Execute() ([]Limit, *http.Response, error) {
return r.ApiService.listProjectLimitsExecute(r)
}
@@ -2021,13 +2021,13 @@ func (a *ProjectsApiService) ListProjectLimits(ctx context.Context, groupId stri
// Execute executes the request
//
-// @return Limit
-func (a *ProjectsApiService) listProjectLimitsExecute(r ListProjectLimitsApiRequest) (*Limit, *http.Response, error) {
+// @return []Limit
+func (a *ProjectsApiService) listProjectLimitsExecute(r ListProjectLimitsApiRequest) ([]Limit, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
- localVarReturnValue *Limit
+ localVarReturnValue []Limit
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "ProjectsApiService.ListProjectLimits")
diff --git a/admin/api_teams.go b/admin/api_teams.go
index 56de2e75..f7938ce1 100644
--- a/admin/api_teams.go
+++ b/admin/api_teams.go
@@ -247,7 +247,7 @@ type TeamsApi interface {
RemoveProjectTeamWithParams(ctx context.Context, args *RemoveProjectTeamApiParams) RemoveProjectTeamApiRequest
// Interface only available internally
- removeProjectTeamExecute(r RemoveProjectTeamApiRequest) (map[string]interface{}, *http.Response, error)
+ removeProjectTeamExecute(r RemoveProjectTeamApiRequest) (*http.Response, error)
/*
RemoveTeamUser Remove One MongoDB Cloud User from One Team
@@ -1726,7 +1726,7 @@ func (a *TeamsApiService) RemoveProjectTeamWithParams(ctx context.Context, args
}
}
-func (r RemoveProjectTeamApiRequest) Execute() (map[string]interface{}, *http.Response, error) {
+func (r RemoveProjectTeamApiRequest) Execute() (*http.Response, error) {
return r.ApiService.removeProjectTeamExecute(r)
}
@@ -1750,19 +1750,16 @@ func (a *TeamsApiService) RemoveProjectTeam(ctx context.Context, groupId string,
}
// Execute executes the request
-//
-// @return map[string]interface{}
-func (a *TeamsApiService) removeProjectTeamExecute(r RemoveProjectTeamApiRequest) (map[string]interface{}, *http.Response, error) {
+func (a *TeamsApiService) removeProjectTeamExecute(r RemoveProjectTeamApiRequest) (*http.Response, error) {
var (
- localVarHTTPMethod = http.MethodDelete
- localVarPostBody interface{}
- formFiles []formFile
- localVarReturnValue map[string]interface{}
+ localVarHTTPMethod = http.MethodDelete
+ localVarPostBody interface{}
+ formFiles []formFile
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "TeamsApiService.RemoveProjectTeam")
if err != nil {
- return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
+ return nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/api/atlas/v2/groups/{groupId}/teams/{teamId}"
@@ -1773,16 +1770,16 @@ func (a *TeamsApiService) removeProjectTeamExecute(r RemoveProjectTeamApiRequest
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
if strlen(r.groupId) < 24 {
- return localVarReturnValue, nil, reportError("groupId must have at least 24 elements")
+ return nil, reportError("groupId must have at least 24 elements")
}
if strlen(r.groupId) > 24 {
- return localVarReturnValue, nil, reportError("groupId must have less than 24 elements")
+ return nil, reportError("groupId must have less than 24 elements")
}
if strlen(r.teamId) < 24 {
- return localVarReturnValue, nil, reportError("teamId must have at least 24 elements")
+ return nil, reportError("teamId must have at least 24 elements")
}
if strlen(r.teamId) > 24 {
- return localVarReturnValue, nil, reportError("teamId must have less than 24 elements")
+ return nil, reportError("teamId must have less than 24 elements")
}
// to determine the Content-Type header
@@ -1804,19 +1801,19 @@ func (a *TeamsApiService) removeProjectTeamExecute(r RemoveProjectTeamApiRequest
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
- return localVarReturnValue, nil, err
+ return nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
- return localVarReturnValue, localVarHTTPResponse, err
+ return localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
- return localVarReturnValue, localVarHTTPResponse, err
+ return localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
@@ -1828,23 +1825,14 @@ func (a *TeamsApiService) removeProjectTeamExecute(r RemoveProjectTeamApiRequest
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
- return localVarReturnValue, localVarHTTPResponse, newErr
+ return localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, localVarHTTPMethod, localVarPath, v)
newErr.model = v
- return localVarReturnValue, localVarHTTPResponse, newErr
- }
-
- err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
- if err != nil {
- newErr := &GenericOpenAPIError{
- body: localVarBody,
- error: err.Error(),
- }
- return localVarReturnValue, localVarHTTPResponse, newErr
+ return localVarHTTPResponse, newErr
}
- return localVarReturnValue, localVarHTTPResponse, nil
+ return localVarHTTPResponse, nil
}
type RemoveTeamUserApiRequest struct {
diff --git a/admin/api_test_.go b/admin/api_test_.go
deleted file mode 100644
index d779a161..00000000
--- a/admin/api_test_.go
+++ /dev/null
@@ -1,172 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.
-
-package admin
-
-import (
- "bytes"
- "context"
- "io"
- "net/http"
- "net/url"
-)
-
-type TestApi interface {
-
- /*
- VersionedExample Example resource info for versioning of the Atlas API
-
- [experimental] Returns some text dummy data for test purposes. Deprecated versions: v2-{2023-01-01}
-
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @return VersionedExampleApiRequest
- */
- VersionedExample(ctx context.Context) VersionedExampleApiRequest
- /*
- VersionedExample Example resource info for versioning of the Atlas API
-
-
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param VersionedExampleApiParams - Parameters for the request
- @return VersionedExampleApiRequest
- */
- VersionedExampleWithParams(ctx context.Context, args *VersionedExampleApiParams) VersionedExampleApiRequest
-
- // Interface only available internally
- versionedExampleExecute(r VersionedExampleApiRequest) (*ExampleResourceResponseView20230201, *http.Response, error)
-}
-
-// TestApiService TestApi service
-type TestApiService service
-
-type VersionedExampleApiRequest struct {
- ctx context.Context
- ApiService TestApi
- additionalInfo *bool
-}
-
-type VersionedExampleApiParams struct {
- AdditionalInfo *bool
-}
-
-func (a *TestApiService) VersionedExampleWithParams(ctx context.Context, args *VersionedExampleApiParams) VersionedExampleApiRequest {
- return VersionedExampleApiRequest{
- ApiService: a,
- ctx: ctx,
- additionalInfo: args.AdditionalInfo,
- }
-}
-
-func (r VersionedExampleApiRequest) AdditionalInfo(additionalInfo bool) VersionedExampleApiRequest {
- r.additionalInfo = &additionalInfo
- return r
-}
-
-func (r VersionedExampleApiRequest) Execute() (*ExampleResourceResponseView20230201, *http.Response, error) {
- return r.ApiService.versionedExampleExecute(r)
-}
-
-/*
-VersionedExample Example resource info for versioning of the Atlas API
-
-[experimental] Returns some text dummy data for test purposes. Deprecated versions: v2-{2023-01-01}
-
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @return VersionedExampleApiRequest
-*/
-func (a *TestApiService) VersionedExample(ctx context.Context) VersionedExampleApiRequest {
- return VersionedExampleApiRequest{
- ApiService: a,
- ctx: ctx,
- }
-}
-
-// Execute executes the request
-//
-// @return ExampleResourceResponseView20230201
-func (a *TestApiService) versionedExampleExecute(r VersionedExampleApiRequest) (*ExampleResourceResponseView20230201, *http.Response, error) {
- var (
- localVarHTTPMethod = http.MethodGet
- localVarPostBody interface{}
- formFiles []formFile
- localVarReturnValue *ExampleResourceResponseView20230201
- )
-
- localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "TestApiService.VersionedExample")
- if err != nil {
- return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
- }
-
- localVarPath := localBasePath + "/api/atlas/v2/example/info"
-
- localVarHeaderParams := make(map[string]string)
- localVarQueryParams := url.Values{}
- localVarFormParams := url.Values{}
-
- if r.additionalInfo != nil {
- parameterAddToHeaderOrQuery(localVarQueryParams, "additionalInfo", r.additionalInfo, "")
- } else {
- var defaultValue bool = false
- r.additionalInfo = &defaultValue
- parameterAddToHeaderOrQuery(localVarQueryParams, "additionalInfo", r.additionalInfo, "")
- }
- // to determine the Content-Type header
- localVarHTTPContentTypes := []string{}
-
- // set Content-Type header
- localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
- if localVarHTTPContentType != "" {
- localVarHeaderParams["Content-Type"] = localVarHTTPContentType
- }
-
- // to determine the Accept header
- localVarHTTPHeaderAccepts := []string{"application/vnd.atlas.2023-02-01+json", "application/json"}
-
- // set Accept header
- localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
- if localVarHTTPHeaderAccept != "" {
- localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
- }
- req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
- if err != nil {
- return localVarReturnValue, nil, err
- }
-
- localVarHTTPResponse, err := a.client.callAPI(req)
- if err != nil || localVarHTTPResponse == nil {
- return localVarReturnValue, localVarHTTPResponse, err
- }
-
- localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
- localVarHTTPResponse.Body.Close()
- localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
- if err != nil {
- return localVarReturnValue, localVarHTTPResponse, err
- }
-
- if localVarHTTPResponse.StatusCode >= 300 {
- newErr := &GenericOpenAPIError{
- body: localVarBody,
- error: localVarHTTPResponse.Status,
- }
- var v Error
- err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
- if err != nil {
- newErr.error = err.Error()
- return localVarReturnValue, localVarHTTPResponse, newErr
- }
- newErr.error = formatErrorMessage(localVarHTTPResponse.Status, localVarHTTPMethod, localVarPath, v)
- newErr.model = v
- return localVarReturnValue, localVarHTTPResponse, newErr
- }
-
- err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
- if err != nil {
- newErr := &GenericOpenAPIError{
- body: localVarBody,
- error: err.Error(),
- }
- return localVarReturnValue, localVarHTTPResponse, newErr
- }
-
- return localVarReturnValue, localVarHTTPResponse, nil
-}
diff --git a/admin/atlas_client.go b/admin/atlas_client.go
index 5ea772a2..5992c99a 100644
--- a/admin/atlas_client.go
+++ b/admin/atlas_client.go
@@ -1,5 +1,5 @@
package admin // import "go.mongodb.org/atlas-sdk/admin"
-// Autogenerated based on OpenAPI Version: 2.0~b0d2861b4b
+// Autogenerated based on OpenAPI Version: 2.0~1056ca6d98
import (
"errors"
diff --git a/admin/client.go b/admin/client.go
index 0a19e447..81f8cea6 100644
--- a/admin/client.go
+++ b/admin/client.go
@@ -32,7 +32,7 @@ var (
queryDescape = strings.NewReplacer("%5B", "[", "%5D", "]")
)
-// APIClient manages communication with the MongoDB Atlas Administration API API v2.0~b0d2861b4b
+// APIClient manages communication with the MongoDB Atlas Administration API API v2.0~1056ca6d98
// In most cases there should be only one, shared, APIClient.
type APIClient struct {
cfg *Configuration
@@ -124,8 +124,6 @@ type APIClient struct {
TeamsApi TeamsApi
- TestApi TestApi
-
ThirdPartyIntegrationsApi ThirdPartyIntegrationsApi
X509AuthenticationApi X509AuthenticationApi
@@ -189,7 +187,6 @@ func NewAPIClient(cfg *Configuration) *APIClient {
c.SharedTierRestoreJobsApi = (*SharedTierRestoreJobsApiService)(&c.common)
c.SharedTierSnapshotsApi = (*SharedTierSnapshotsApiService)(&c.common)
c.TeamsApi = (*TeamsApiService)(&c.common)
- c.TestApi = (*TestApiService)(&c.common)
c.ThirdPartyIntegrationsApi = (*ThirdPartyIntegrationsApiService)(&c.common)
c.X509AuthenticationApi = (*X509AuthenticationApiService)(&c.common)
diff --git a/admin/model_cluster_description_v15.go b/admin/model_cluster_description_v15.go
index 806ac675..4e8e07b6 100644
--- a/admin/model_cluster_description_v15.go
+++ b/admin/model_cluster_description_v15.go
@@ -48,7 +48,7 @@ type ClusterDescriptionV15 struct {
RootCertType *string `json:"rootCertType,omitempty"`
// Human-readable label that indicates the current operating condition of this cluster.
StateName *string `json:"stateName,omitempty"`
- // Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster.
+ // List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.
Tags []Tag `json:"tags,omitempty"`
// Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster.
TerminationProtectionEnabled *bool `json:"terminationProtectionEnabled,omitempty"`
diff --git a/admin/model_create_organization_api_key.go b/admin/model_create_organization_api_key.go
new file mode 100644
index 00000000..4fe94b57
--- /dev/null
+++ b/admin/model_create_organization_api_key.go
@@ -0,0 +1,153 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.
+
+package admin
+
+import (
+ "encoding/json"
+)
+
+// checks if the CreateOrganizationApiKey type satisfies the MappedNullable interface at compile time
+var _ MappedNullable = &CreateOrganizationApiKey{}
+
+// CreateOrganizationApiKey struct for CreateOrganizationApiKey
+type CreateOrganizationApiKey struct {
+ // Purpose or explanation provided when someone created this organization API key.
+ Desc *string `json:"desc,omitempty"`
+ // List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this organization.
+ Roles []string `json:"roles,omitempty"`
+}
+
+// NewCreateOrganizationApiKey instantiates a new CreateOrganizationApiKey object
+// This constructor will assign default values to properties that have it defined,
+// and makes sure properties required by API are set, but the set of arguments
+// will change when the set of required properties is changed
+func NewCreateOrganizationApiKey() *CreateOrganizationApiKey {
+ this := CreateOrganizationApiKey{}
+ return &this
+}
+
+// NewCreateOrganizationApiKeyWithDefaults instantiates a new CreateOrganizationApiKey object
+// This constructor will only assign default values to properties that have it defined,
+// but it doesn't guarantee that properties required by API are set
+func NewCreateOrganizationApiKeyWithDefaults() *CreateOrganizationApiKey {
+ this := CreateOrganizationApiKey{}
+ return &this
+}
+
+// GetDesc returns the Desc field value if set, zero value otherwise.
+func (o *CreateOrganizationApiKey) GetDesc() string {
+ if o == nil || IsNil(o.Desc) {
+ var ret string
+ return ret
+ }
+ return *o.Desc
+}
+
+// GetDescOk returns a tuple with the Desc field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *CreateOrganizationApiKey) GetDescOk() (*string, bool) {
+ if o == nil || IsNil(o.Desc) {
+ return nil, false
+ }
+ return o.Desc, true
+}
+
+// HasDesc returns a boolean if a field has been set.
+func (o *CreateOrganizationApiKey) HasDesc() bool {
+ if o != nil && !IsNil(o.Desc) {
+ return true
+ }
+
+ return false
+}
+
+// SetDesc gets a reference to the given string and assigns it to the Desc field.
+func (o *CreateOrganizationApiKey) SetDesc(v string) {
+ o.Desc = &v
+}
+
+// GetRoles returns the Roles field value if set, zero value otherwise.
+func (o *CreateOrganizationApiKey) GetRoles() []string {
+ if o == nil || IsNil(o.Roles) {
+ var ret []string
+ return ret
+ }
+ return o.Roles
+}
+
+// GetRolesOk returns a tuple with the Roles field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *CreateOrganizationApiKey) GetRolesOk() ([]string, bool) {
+ if o == nil || IsNil(o.Roles) {
+ return nil, false
+ }
+ return o.Roles, true
+}
+
+// HasRoles returns a boolean if a field has been set.
+func (o *CreateOrganizationApiKey) HasRoles() bool {
+ if o != nil && !IsNil(o.Roles) {
+ return true
+ }
+
+ return false
+}
+
+// SetRoles gets a reference to the given []string and assigns it to the Roles field.
+func (o *CreateOrganizationApiKey) SetRoles(v []string) {
+ o.Roles = v
+}
+
+func (o CreateOrganizationApiKey) MarshalJSONWithoutReadOnly() ([]byte, error) {
+ toSerialize, err := o.ToMap()
+ if err != nil {
+ return []byte{}, err
+ }
+ return json.Marshal(toSerialize)
+}
+func (o CreateOrganizationApiKey) ToMap() (map[string]interface{}, error) {
+ toSerialize := map[string]interface{}{}
+ if !IsNil(o.Desc) {
+ toSerialize["desc"] = o.Desc
+ }
+ if !IsNil(o.Roles) {
+ toSerialize["roles"] = o.Roles
+ }
+ return toSerialize, nil
+}
+
+type NullableCreateOrganizationApiKey struct {
+ value *CreateOrganizationApiKey
+ isSet bool
+}
+
+func (v NullableCreateOrganizationApiKey) Get() *CreateOrganizationApiKey {
+ return v.value
+}
+
+func (v *NullableCreateOrganizationApiKey) Set(val *CreateOrganizationApiKey) {
+ v.value = val
+ v.isSet = true
+}
+
+func (v NullableCreateOrganizationApiKey) IsSet() bool {
+ return v.isSet
+}
+
+func (v *NullableCreateOrganizationApiKey) Unset() {
+ v.value = nil
+ v.isSet = false
+}
+
+func NewNullableCreateOrganizationApiKey(val *CreateOrganizationApiKey) *NullableCreateOrganizationApiKey {
+ return &NullableCreateOrganizationApiKey{value: val, isSet: true}
+}
+
+func (v NullableCreateOrganizationApiKey) MarshalJSON() ([]byte, error) {
+ return json.Marshal(v.value)
+}
+
+func (v *NullableCreateOrganizationApiKey) UnmarshalJSON(src []byte) error {
+ v.isSet = true
+ return json.Unmarshal(src, &v.value)
+}
diff --git a/admin/model_create_organization_request.go b/admin/model_create_organization_request.go
index 0f52677b..25d905cc 100644
--- a/admin/model_create_organization_request.go
+++ b/admin/model_create_organization_request.go
@@ -11,10 +11,12 @@ var _ MappedNullable = &CreateOrganizationRequest{}
// CreateOrganizationRequest struct for CreateOrganizationRequest
type CreateOrganizationRequest struct {
- ApiKey *CreateApiKey `json:"apiKey,omitempty"`
+ ApiKey *CreateOrganizationApiKey `json:"apiKey,omitempty"`
+ // Unique 24-hexadecimal digit string that identifies the federation to link the newly created organization to. If specified, the proposed Organization Owner of the new organization must have the Organization Owner role in an organization associated with the federation.
+ FederationSettingsId *string `json:"federationSettingsId,omitempty"`
// Human-readable label that identifies the organization.
Name string `json:"name"`
- // Unique 24-hexadecimal digit string that identifies the Atlas user that you want to assign the Organization Owner role. This user must be a member of the same organization as the calling API key. This is only required when authenticating with Programmatic API Keys.
+ // Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user that you want to assign the Organization Owner role. This user must be a member of the same organization as the calling API key. If you provide `federationSettingsId`, this user must instead have the Organization Owner role on an organization in the specified federation. This parameter is required only when you authenticate with Programmatic API Keys.
OrgOwnerId *string `json:"orgOwnerId,omitempty"`
}
@@ -37,9 +39,9 @@ func NewCreateOrganizationRequestWithDefaults() *CreateOrganizationRequest {
}
// GetApiKey returns the ApiKey field value if set, zero value otherwise.
-func (o *CreateOrganizationRequest) GetApiKey() CreateApiKey {
+func (o *CreateOrganizationRequest) GetApiKey() CreateOrganizationApiKey {
if o == nil || IsNil(o.ApiKey) {
- var ret CreateApiKey
+ var ret CreateOrganizationApiKey
return ret
}
return *o.ApiKey
@@ -47,7 +49,7 @@ func (o *CreateOrganizationRequest) GetApiKey() CreateApiKey {
// GetApiKeyOk returns a tuple with the ApiKey field value if set, nil otherwise
// and a boolean to check if the value has been set.
-func (o *CreateOrganizationRequest) GetApiKeyOk() (*CreateApiKey, bool) {
+func (o *CreateOrganizationRequest) GetApiKeyOk() (*CreateOrganizationApiKey, bool) {
if o == nil || IsNil(o.ApiKey) {
return nil, false
}
@@ -63,11 +65,43 @@ func (o *CreateOrganizationRequest) HasApiKey() bool {
return false
}
-// SetApiKey gets a reference to the given CreateApiKey and assigns it to the ApiKey field.
-func (o *CreateOrganizationRequest) SetApiKey(v CreateApiKey) {
+// SetApiKey gets a reference to the given CreateOrganizationApiKey and assigns it to the ApiKey field.
+func (o *CreateOrganizationRequest) SetApiKey(v CreateOrganizationApiKey) {
o.ApiKey = &v
}
+// GetFederationSettingsId returns the FederationSettingsId field value if set, zero value otherwise.
+func (o *CreateOrganizationRequest) GetFederationSettingsId() string {
+ if o == nil || IsNil(o.FederationSettingsId) {
+ var ret string
+ return ret
+ }
+ return *o.FederationSettingsId
+}
+
+// GetFederationSettingsIdOk returns a tuple with the FederationSettingsId field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *CreateOrganizationRequest) GetFederationSettingsIdOk() (*string, bool) {
+ if o == nil || IsNil(o.FederationSettingsId) {
+ return nil, false
+ }
+ return o.FederationSettingsId, true
+}
+
+// HasFederationSettingsId returns a boolean if a field has been set.
+func (o *CreateOrganizationRequest) HasFederationSettingsId() bool {
+ if o != nil && !IsNil(o.FederationSettingsId) {
+ return true
+ }
+
+ return false
+}
+
+// SetFederationSettingsId gets a reference to the given string and assigns it to the FederationSettingsId field.
+func (o *CreateOrganizationRequest) SetFederationSettingsId(v string) {
+ o.FederationSettingsId = &v
+}
+
// GetName returns the Name field value
func (o *CreateOrganizationRequest) GetName() string {
if o == nil {
@@ -136,6 +170,9 @@ func (o CreateOrganizationRequest) ToMap() (map[string]interface{}, error) {
if !IsNil(o.ApiKey) {
toSerialize["apiKey"] = o.ApiKey
}
+ if !IsNil(o.FederationSettingsId) {
+ toSerialize["federationSettingsId"] = o.FederationSettingsId
+ }
toSerialize["name"] = o.Name
if !IsNil(o.OrgOwnerId) {
toSerialize["orgOwnerId"] = o.OrgOwnerId
diff --git a/admin/model_create_organization_response.go b/admin/model_create_organization_response.go
index 68bc6d71..13302213 100644
--- a/admin/model_create_organization_response.go
+++ b/admin/model_create_organization_response.go
@@ -12,7 +12,9 @@ var _ MappedNullable = &CreateOrganizationResponse{}
// CreateOrganizationResponse struct for CreateOrganizationResponse
type CreateOrganizationResponse struct {
ApiKey *ApiUser `json:"apiKey,omitempty"`
- // Unique 24-hexadecimal digit string that identifies the Atlas user that you want to assign the Organization Owner role.
+ // Unique 24-hexadecimal digit string that identifies the federation that you linked the newly created organization to.
+ FederationSettingsId *string `json:"federationSettingsId,omitempty"`
+ // Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user that you assigned the Organization Owner role in the new organization.
OrgOwnerId *string `json:"orgOwnerId,omitempty"`
Organization *Organization `json:"organization,omitempty"`
}
@@ -66,6 +68,38 @@ func (o *CreateOrganizationResponse) SetApiKey(v ApiUser) {
o.ApiKey = &v
}
+// GetFederationSettingsId returns the FederationSettingsId field value if set, zero value otherwise.
+func (o *CreateOrganizationResponse) GetFederationSettingsId() string {
+ if o == nil || IsNil(o.FederationSettingsId) {
+ var ret string
+ return ret
+ }
+ return *o.FederationSettingsId
+}
+
+// GetFederationSettingsIdOk returns a tuple with the FederationSettingsId field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *CreateOrganizationResponse) GetFederationSettingsIdOk() (*string, bool) {
+ if o == nil || IsNil(o.FederationSettingsId) {
+ return nil, false
+ }
+ return o.FederationSettingsId, true
+}
+
+// HasFederationSettingsId returns a boolean if a field has been set.
+func (o *CreateOrganizationResponse) HasFederationSettingsId() bool {
+ if o != nil && !IsNil(o.FederationSettingsId) {
+ return true
+ }
+
+ return false
+}
+
+// SetFederationSettingsId gets a reference to the given string and assigns it to the FederationSettingsId field.
+func (o *CreateOrganizationResponse) SetFederationSettingsId(v string) {
+ o.FederationSettingsId = &v
+}
+
// GetOrgOwnerId returns the OrgOwnerId field value if set, zero value otherwise.
func (o *CreateOrganizationResponse) GetOrgOwnerId() string {
if o == nil || IsNil(o.OrgOwnerId) {
diff --git a/admin/model_create_api_key.go b/admin/model_create_project_api_key.go
similarity index 57%
rename from admin/model_create_api_key.go
rename to admin/model_create_project_api_key.go
index 6d471471..9ef2da18 100644
--- a/admin/model_create_api_key.go
+++ b/admin/model_create_project_api_key.go
@@ -6,36 +6,36 @@ import (
"encoding/json"
)
-// checks if the CreateApiKey type satisfies the MappedNullable interface at compile time
-var _ MappedNullable = &CreateApiKey{}
+// checks if the CreateProjectApiKey type satisfies the MappedNullable interface at compile time
+var _ MappedNullable = &CreateProjectApiKey{}
-// CreateApiKey struct for CreateApiKey
-type CreateApiKey struct {
- // Purpose or explanation provided when someone created this organization API key.
+// CreateProjectApiKey struct for CreateProjectApiKey
+type CreateProjectApiKey struct {
+ // Purpose or explanation provided when someone created this project API key.
Desc *string `json:"desc,omitempty"`
- // List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this organization or project.
+ // List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this project.
Roles []string `json:"roles,omitempty"`
}
-// NewCreateApiKey instantiates a new CreateApiKey object
+// NewCreateProjectApiKey instantiates a new CreateProjectApiKey object
// This constructor will assign default values to properties that have it defined,
// and makes sure properties required by API are set, but the set of arguments
// will change when the set of required properties is changed
-func NewCreateApiKey() *CreateApiKey {
- this := CreateApiKey{}
+func NewCreateProjectApiKey() *CreateProjectApiKey {
+ this := CreateProjectApiKey{}
return &this
}
-// NewCreateApiKeyWithDefaults instantiates a new CreateApiKey object
+// NewCreateProjectApiKeyWithDefaults instantiates a new CreateProjectApiKey object
// This constructor will only assign default values to properties that have it defined,
// but it doesn't guarantee that properties required by API are set
-func NewCreateApiKeyWithDefaults() *CreateApiKey {
- this := CreateApiKey{}
+func NewCreateProjectApiKeyWithDefaults() *CreateProjectApiKey {
+ this := CreateProjectApiKey{}
return &this
}
// GetDesc returns the Desc field value if set, zero value otherwise.
-func (o *CreateApiKey) GetDesc() string {
+func (o *CreateProjectApiKey) GetDesc() string {
if o == nil || IsNil(o.Desc) {
var ret string
return ret
@@ -45,7 +45,7 @@ func (o *CreateApiKey) GetDesc() string {
// GetDescOk returns a tuple with the Desc field value if set, nil otherwise
// and a boolean to check if the value has been set.
-func (o *CreateApiKey) GetDescOk() (*string, bool) {
+func (o *CreateProjectApiKey) GetDescOk() (*string, bool) {
if o == nil || IsNil(o.Desc) {
return nil, false
}
@@ -53,7 +53,7 @@ func (o *CreateApiKey) GetDescOk() (*string, bool) {
}
// HasDesc returns a boolean if a field has been set.
-func (o *CreateApiKey) HasDesc() bool {
+func (o *CreateProjectApiKey) HasDesc() bool {
if o != nil && !IsNil(o.Desc) {
return true
}
@@ -62,12 +62,12 @@ func (o *CreateApiKey) HasDesc() bool {
}
// SetDesc gets a reference to the given string and assigns it to the Desc field.
-func (o *CreateApiKey) SetDesc(v string) {
+func (o *CreateProjectApiKey) SetDesc(v string) {
o.Desc = &v
}
// GetRoles returns the Roles field value if set, zero value otherwise.
-func (o *CreateApiKey) GetRoles() []string {
+func (o *CreateProjectApiKey) GetRoles() []string {
if o == nil || IsNil(o.Roles) {
var ret []string
return ret
@@ -77,7 +77,7 @@ func (o *CreateApiKey) GetRoles() []string {
// GetRolesOk returns a tuple with the Roles field value if set, nil otherwise
// and a boolean to check if the value has been set.
-func (o *CreateApiKey) GetRolesOk() ([]string, bool) {
+func (o *CreateProjectApiKey) GetRolesOk() ([]string, bool) {
if o == nil || IsNil(o.Roles) {
return nil, false
}
@@ -85,7 +85,7 @@ func (o *CreateApiKey) GetRolesOk() ([]string, bool) {
}
// HasRoles returns a boolean if a field has been set.
-func (o *CreateApiKey) HasRoles() bool {
+func (o *CreateProjectApiKey) HasRoles() bool {
if o != nil && !IsNil(o.Roles) {
return true
}
@@ -94,18 +94,18 @@ func (o *CreateApiKey) HasRoles() bool {
}
// SetRoles gets a reference to the given []string and assigns it to the Roles field.
-func (o *CreateApiKey) SetRoles(v []string) {
+func (o *CreateProjectApiKey) SetRoles(v []string) {
o.Roles = v
}
-func (o CreateApiKey) MarshalJSONWithoutReadOnly() ([]byte, error) {
+func (o CreateProjectApiKey) MarshalJSONWithoutReadOnly() ([]byte, error) {
toSerialize, err := o.ToMap()
if err != nil {
return []byte{}, err
}
return json.Marshal(toSerialize)
}
-func (o CreateApiKey) ToMap() (map[string]interface{}, error) {
+func (o CreateProjectApiKey) ToMap() (map[string]interface{}, error) {
toSerialize := map[string]interface{}{}
if !IsNil(o.Desc) {
toSerialize["desc"] = o.Desc
@@ -116,38 +116,38 @@ func (o CreateApiKey) ToMap() (map[string]interface{}, error) {
return toSerialize, nil
}
-type NullableCreateApiKey struct {
- value *CreateApiKey
+type NullableCreateProjectApiKey struct {
+ value *CreateProjectApiKey
isSet bool
}
-func (v NullableCreateApiKey) Get() *CreateApiKey {
+func (v NullableCreateProjectApiKey) Get() *CreateProjectApiKey {
return v.value
}
-func (v *NullableCreateApiKey) Set(val *CreateApiKey) {
+func (v *NullableCreateProjectApiKey) Set(val *CreateProjectApiKey) {
v.value = val
v.isSet = true
}
-func (v NullableCreateApiKey) IsSet() bool {
+func (v NullableCreateProjectApiKey) IsSet() bool {
return v.isSet
}
-func (v *NullableCreateApiKey) Unset() {
+func (v *NullableCreateProjectApiKey) Unset() {
v.value = nil
v.isSet = false
}
-func NewNullableCreateApiKey(val *CreateApiKey) *NullableCreateApiKey {
- return &NullableCreateApiKey{value: val, isSet: true}
+func NewNullableCreateProjectApiKey(val *CreateProjectApiKey) *NullableCreateProjectApiKey {
+ return &NullableCreateProjectApiKey{value: val, isSet: true}
}
-func (v NullableCreateApiKey) MarshalJSON() ([]byte, error) {
+func (v NullableCreateProjectApiKey) MarshalJSON() ([]byte, error) {
return json.Marshal(v.value)
}
-func (v *NullableCreateApiKey) UnmarshalJSON(src []byte) error {
+func (v *NullableCreateProjectApiKey) UnmarshalJSON(src []byte) error {
v.isSet = true
return json.Unmarshal(src, &v.value)
}
diff --git a/admin/model_database_user.go b/admin/model_database_user.go
index 934e9a51..5b008575 100644
--- a/admin/model_database_user.go
+++ b/admin/model_database_user.go
@@ -26,13 +26,15 @@ type DatabaseUser struct {
LdapAuthType *string `json:"ldapAuthType,omitempty"`
// List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.
Links []Link `json:"links,omitempty"`
+ // Human-readable label that indicates whether the new database user authenticates with OIDC federated authentication. To create a federated authentication user, specify the value of IDP_GROUP for this field.
+ OidcAuthType *string `json:"oidcAuthType,omitempty"`
// Alphanumeric string that authenticates this database user against the database specified in `databaseName`. To authenticate with SCRAM-SHA, you must specify this parameter. This parameter doesn't appear in this response.
Password *string `json:"password,omitempty"`
// List that provides the pairings of one role with one applicable database.
Roles []Role `json:"roles,omitempty"`
// List that contains clusters and MongoDB Atlas Data Lakes that this database user can access. If omitted, MongoDB Cloud grants the database user access to all the clusters and MongoDB Atlas Data Lakes in the project.
Scopes []UserScope `json:"scopes,omitempty"`
- // Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication: | Authentication Method | Parameter Needed | Parameter Value | username Format | |---|---|---|---| | AWS IAM | awsType | ROLE | ARN | | AWS IAM | awsType | USER | ARN | | x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | SCRAM-SHA | awsType, x509Type, ldapAuthType | NONE | Alphanumeric string |
+ // Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication: | Authentication Method | Parameter Needed | Parameter Value | username Format | |---|---|---|---| | AWS IAM | awsType | ROLE | ARN | | AWS IAM | awsType | USER | ARN | | x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | OIDC | oidcAuthType | IDP_GROUP | Atlas OIDC IdP Identifier (found in Federation Settings, or contact Support), followed by a '/', followed by the IdP group name | | SCRAM-SHA | awsType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |
Username string `json:"username"`
// X.509 method that MongoDB Cloud uses to authenticate the database user. - For application-managed X.509, specify `MANAGED`. - For self-managed X.509, specify `CUSTOMER`. Users created with the `CUSTOMER` method require a Common Name (CN) in the **username** parameter. You must create externally authenticated users on the `$external` database.
X509Type *string `json:"x509Type,omitempty"`
@@ -50,6 +52,8 @@ func NewDatabaseUser(databaseName string, groupId string, username string) *Data
this.GroupId = groupId
var ldapAuthType string = "NONE"
this.LdapAuthType = &ldapAuthType
+ var oidcAuthType string = "NONE"
+ this.OidcAuthType = &oidcAuthType
this.Username = username
var x509Type string = "NONE"
this.X509Type = &x509Type
@@ -67,6 +71,8 @@ func NewDatabaseUserWithDefaults() *DatabaseUser {
this.DatabaseName = databaseName
var ldapAuthType string = "NONE"
this.LdapAuthType = &ldapAuthType
+ var oidcAuthType string = "NONE"
+ this.OidcAuthType = &oidcAuthType
var x509Type string = "NONE"
this.X509Type = &x509Type
return &this
@@ -280,6 +286,38 @@ func (o *DatabaseUser) SetLinks(v []Link) {
o.Links = v
}
+// GetOidcAuthType returns the OidcAuthType field value if set, zero value otherwise.
+func (o *DatabaseUser) GetOidcAuthType() string {
+ if o == nil || IsNil(o.OidcAuthType) {
+ var ret string
+ return ret
+ }
+ return *o.OidcAuthType
+}
+
+// GetOidcAuthTypeOk returns a tuple with the OidcAuthType field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *DatabaseUser) GetOidcAuthTypeOk() (*string, bool) {
+ if o == nil || IsNil(o.OidcAuthType) {
+ return nil, false
+ }
+ return o.OidcAuthType, true
+}
+
+// HasOidcAuthType returns a boolean if a field has been set.
+func (o *DatabaseUser) HasOidcAuthType() bool {
+ if o != nil && !IsNil(o.OidcAuthType) {
+ return true
+ }
+
+ return false
+}
+
+// SetOidcAuthType gets a reference to the given string and assigns it to the OidcAuthType field.
+func (o *DatabaseUser) SetOidcAuthType(v string) {
+ o.OidcAuthType = &v
+}
+
// GetPassword returns the Password field value if set, zero value otherwise.
func (o *DatabaseUser) GetPassword() string {
if o == nil || IsNil(o.Password) {
@@ -455,6 +493,9 @@ func (o DatabaseUser) ToMap() (map[string]interface{}, error) {
if !IsNil(o.LdapAuthType) {
toSerialize["ldapAuthType"] = o.LdapAuthType
}
+ if !IsNil(o.OidcAuthType) {
+ toSerialize["oidcAuthType"] = o.OidcAuthType
+ }
if !IsNil(o.Password) {
toSerialize["password"] = o.Password
}
diff --git a/admin/model_disk_backup_sharded_cluster_snapshot_member.go b/admin/model_disk_backup_sharded_cluster_snapshot_member.go
index 3d88384c..a574c47e 100644
--- a/admin/model_disk_backup_sharded_cluster_snapshot_member.go
+++ b/admin/model_disk_backup_sharded_cluster_snapshot_member.go
@@ -9,7 +9,7 @@ import (
// checks if the DiskBackupShardedClusterSnapshotMember type satisfies the MappedNullable interface at compile time
var _ MappedNullable = &DiskBackupShardedClusterSnapshotMember{}
-// DiskBackupShardedClusterSnapshotMember List that includes the snapshots and the cloud provider that stores the snapshots. The resource returns this parameter when `\"type\" : \"SHARDED_CLUSTER\"`.
+// DiskBackupShardedClusterSnapshotMember struct for DiskBackupShardedClusterSnapshotMember
type DiskBackupShardedClusterSnapshotMember struct {
// Human-readable label that identifies the cloud provider that stores this snapshot. The resource returns this parameter when `\"type\": \"replicaSet\"`.
CloudProvider string `json:"cloudProvider"`
diff --git a/admin/model_dls_ingestion_sink.go b/admin/model_dls_ingestion_sink.go
index addb0bff..4611f830 100644
--- a/admin/model_dls_ingestion_sink.go
+++ b/admin/model_dls_ingestion_sink.go
@@ -184,9 +184,6 @@ func (o DLSIngestionSink) ToMap() (map[string]interface{}, error) {
if !IsNil(o.PartitionFields) {
toSerialize["partitionFields"] = o.PartitionFields
}
- if !IsNil(o.Type) {
- toSerialize["type"] = o.Type
- }
return toSerialize, nil
}
diff --git a/admin/model_example_resource_response_view20230201.go b/admin/model_example_resource_response_view20230201.go
deleted file mode 100644
index a5a763ce..00000000
--- a/admin/model_example_resource_response_view20230201.go
+++ /dev/null
@@ -1,215 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.
-
-package admin
-
-import (
- "encoding/json"
-)
-
-// checks if the ExampleResourceResponseView20230201 type satisfies the MappedNullable interface at compile time
-var _ MappedNullable = &ExampleResourceResponseView20230201{}
-
-// ExampleResourceResponseView20230201 struct for ExampleResourceResponseView20230201
-type ExampleResourceResponseView20230201 struct {
- // Dummy additional field added to the response.
- AdditionalInfo *string `json:"additionalInfo,omitempty"`
- // Array that contains the dummy metadata.
- Data []string `json:"data,omitempty"`
- // Dummy description added as response.
- Description string `json:"description"`
- // List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.
- Links []Link `json:"links,omitempty"`
-}
-
-// NewExampleResourceResponseView20230201 instantiates a new ExampleResourceResponseView20230201 object
-// This constructor will assign default values to properties that have it defined,
-// and makes sure properties required by API are set, but the set of arguments
-// will change when the set of required properties is changed
-func NewExampleResourceResponseView20230201(description string) *ExampleResourceResponseView20230201 {
- this := ExampleResourceResponseView20230201{}
- this.Description = description
- return &this
-}
-
-// NewExampleResourceResponseView20230201WithDefaults instantiates a new ExampleResourceResponseView20230201 object
-// This constructor will only assign default values to properties that have it defined,
-// but it doesn't guarantee that properties required by API are set
-func NewExampleResourceResponseView20230201WithDefaults() *ExampleResourceResponseView20230201 {
- this := ExampleResourceResponseView20230201{}
- return &this
-}
-
-// GetAdditionalInfo returns the AdditionalInfo field value if set, zero value otherwise.
-func (o *ExampleResourceResponseView20230201) GetAdditionalInfo() string {
- if o == nil || IsNil(o.AdditionalInfo) {
- var ret string
- return ret
- }
- return *o.AdditionalInfo
-}
-
-// GetAdditionalInfoOk returns a tuple with the AdditionalInfo field value if set, nil otherwise
-// and a boolean to check if the value has been set.
-func (o *ExampleResourceResponseView20230201) GetAdditionalInfoOk() (*string, bool) {
- if o == nil || IsNil(o.AdditionalInfo) {
- return nil, false
- }
- return o.AdditionalInfo, true
-}
-
-// HasAdditionalInfo returns a boolean if a field has been set.
-func (o *ExampleResourceResponseView20230201) HasAdditionalInfo() bool {
- if o != nil && !IsNil(o.AdditionalInfo) {
- return true
- }
-
- return false
-}
-
-// SetAdditionalInfo gets a reference to the given string and assigns it to the AdditionalInfo field.
-func (o *ExampleResourceResponseView20230201) SetAdditionalInfo(v string) {
- o.AdditionalInfo = &v
-}
-
-// GetData returns the Data field value if set, zero value otherwise.
-func (o *ExampleResourceResponseView20230201) GetData() []string {
- if o == nil || IsNil(o.Data) {
- var ret []string
- return ret
- }
- return o.Data
-}
-
-// GetDataOk returns a tuple with the Data field value if set, nil otherwise
-// and a boolean to check if the value has been set.
-func (o *ExampleResourceResponseView20230201) GetDataOk() ([]string, bool) {
- if o == nil || IsNil(o.Data) {
- return nil, false
- }
- return o.Data, true
-}
-
-// HasData returns a boolean if a field has been set.
-func (o *ExampleResourceResponseView20230201) HasData() bool {
- if o != nil && !IsNil(o.Data) {
- return true
- }
-
- return false
-}
-
-// SetData gets a reference to the given []string and assigns it to the Data field.
-func (o *ExampleResourceResponseView20230201) SetData(v []string) {
- o.Data = v
-}
-
-// GetDescription returns the Description field value
-func (o *ExampleResourceResponseView20230201) GetDescription() string {
- if o == nil {
- var ret string
- return ret
- }
-
- return o.Description
-}
-
-// GetDescriptionOk returns a tuple with the Description field value
-// and a boolean to check if the value has been set.
-func (o *ExampleResourceResponseView20230201) GetDescriptionOk() (*string, bool) {
- if o == nil {
- return nil, false
- }
- return &o.Description, true
-}
-
-// SetDescription sets field value
-func (o *ExampleResourceResponseView20230201) SetDescription(v string) {
- o.Description = v
-}
-
-// GetLinks returns the Links field value if set, zero value otherwise.
-func (o *ExampleResourceResponseView20230201) GetLinks() []Link {
- if o == nil || IsNil(o.Links) {
- var ret []Link
- return ret
- }
- return o.Links
-}
-
-// GetLinksOk returns a tuple with the Links field value if set, nil otherwise
-// and a boolean to check if the value has been set.
-func (o *ExampleResourceResponseView20230201) GetLinksOk() ([]Link, bool) {
- if o == nil || IsNil(o.Links) {
- return nil, false
- }
- return o.Links, true
-}
-
-// HasLinks returns a boolean if a field has been set.
-func (o *ExampleResourceResponseView20230201) HasLinks() bool {
- if o != nil && !IsNil(o.Links) {
- return true
- }
-
- return false
-}
-
-// SetLinks gets a reference to the given []Link and assigns it to the Links field.
-func (o *ExampleResourceResponseView20230201) SetLinks(v []Link) {
- o.Links = v
-}
-
-func (o ExampleResourceResponseView20230201) MarshalJSONWithoutReadOnly() ([]byte, error) {
- toSerialize, err := o.ToMap()
- if err != nil {
- return []byte{}, err
- }
- return json.Marshal(toSerialize)
-}
-func (o ExampleResourceResponseView20230201) ToMap() (map[string]interface{}, error) {
- toSerialize := map[string]interface{}{}
- if !IsNil(o.AdditionalInfo) {
- toSerialize["additionalInfo"] = o.AdditionalInfo
- }
- if !IsNil(o.Data) {
- toSerialize["data"] = o.Data
- }
- toSerialize["description"] = o.Description
- return toSerialize, nil
-}
-
-type NullableExampleResourceResponseView20230201 struct {
- value *ExampleResourceResponseView20230201
- isSet bool
-}
-
-func (v NullableExampleResourceResponseView20230201) Get() *ExampleResourceResponseView20230201 {
- return v.value
-}
-
-func (v *NullableExampleResourceResponseView20230201) Set(val *ExampleResourceResponseView20230201) {
- v.value = val
- v.isSet = true
-}
-
-func (v NullableExampleResourceResponseView20230201) IsSet() bool {
- return v.isSet
-}
-
-func (v *NullableExampleResourceResponseView20230201) Unset() {
- v.value = nil
- v.isSet = false
-}
-
-func NewNullableExampleResourceResponseView20230201(val *ExampleResourceResponseView20230201) *NullableExampleResourceResponseView20230201 {
- return &NullableExampleResourceResponseView20230201{value: val, isSet: true}
-}
-
-func (v NullableExampleResourceResponseView20230201) MarshalJSON() ([]byte, error) {
- return json.Marshal(v.value)
-}
-
-func (v *NullableExampleResourceResponseView20230201) UnmarshalJSON(src []byte) error {
- v.isSet = true
- return json.Unmarshal(src, &v.value)
-}
diff --git a/admin/model_legacy_cluster_description.go b/admin/model_legacy_cluster_description.go
index 6b05e506..f2ea28c5 100644
--- a/admin/model_legacy_cluster_description.go
+++ b/admin/model_legacy_cluster_description.go
@@ -58,7 +58,6 @@ type LegacyClusterDescription struct {
// Deprecated
ReplicationFactor *int `json:"replicationFactor,omitempty"`
// Physical location where MongoDB Cloud provisions cluster nodes.
- // Deprecated
ReplicationSpec *map[string]RegionSpec `json:"replicationSpec,omitempty"`
// List of settings that configure your cluster regions. - For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes. - For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.
ReplicationSpecs []LegacyReplicationSpec `json:"replicationSpecs,omitempty"`
@@ -68,7 +67,7 @@ type LegacyClusterDescription struct {
SrvAddress *string `json:"srvAddress,omitempty"`
// Human-readable label that indicates the current operating condition of the cluster.
StateName *string `json:"stateName,omitempty"`
- // Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster.
+ // List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.
Tags []Tag `json:"tags,omitempty"`
// Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster.
TerminationProtectionEnabled *bool `json:"terminationProtectionEnabled,omitempty"`
@@ -889,7 +888,6 @@ func (o *LegacyClusterDescription) SetReplicationFactor(v int) {
}
// GetReplicationSpec returns the ReplicationSpec field value if set, zero value otherwise.
-// Deprecated
func (o *LegacyClusterDescription) GetReplicationSpec() map[string]RegionSpec {
if o == nil || IsNil(o.ReplicationSpec) {
var ret map[string]RegionSpec
@@ -900,7 +898,6 @@ func (o *LegacyClusterDescription) GetReplicationSpec() map[string]RegionSpec {
// GetReplicationSpecOk returns a tuple with the ReplicationSpec field value if set, nil otherwise
// and a boolean to check if the value has been set.
-// Deprecated
func (o *LegacyClusterDescription) GetReplicationSpecOk() (*map[string]RegionSpec, bool) {
if o == nil || IsNil(o.ReplicationSpec) {
return nil, false
@@ -918,7 +915,6 @@ func (o *LegacyClusterDescription) HasReplicationSpec() bool {
}
// SetReplicationSpec gets a reference to the given map[string]RegionSpec and assigns it to the ReplicationSpec field.
-// Deprecated
func (o *LegacyClusterDescription) SetReplicationSpec(v map[string]RegionSpec) {
o.ReplicationSpec = &v
}
diff --git a/admin/model_notification_view_for_nds_group.go b/admin/model_notification_view_for_nds_group.go
index 9b9c3719..b5472f14 100644
--- a/admin/model_notification_view_for_nds_group.go
+++ b/admin/model_notification_view_for_nds_group.go
@@ -19,6 +19,8 @@ type NotificationViewForNdsGroup struct {
DelayMin *int `json:"delayMin,omitempty"`
// Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert. PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
IntervalMin *int `json:"intervalMin,omitempty"`
+ // The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
+ NotifierId *string `json:"notifierId,omitempty"`
// Human-readable label that displays the alert notification type.
TypeName *string `json:"typeName,omitempty"`
// Email address to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"EMAIL\"`. You don’t need to set this value to send emails to individual or groups of MongoDB Cloud users including: - specific MongoDB Cloud users (`\"notifications.[n].typeName\" : \"USER\"`) - MongoDB Cloud users with specific project roles (`\"notifications.[n].typeName\" : \"GROUP\"`) - MongoDB Cloud users with specific organization roles (`\"notifications.[n].typeName\" : \"ORG\"`) - MongoDB Cloud teams (`\"notifications.[n].typeName\" : \"TEAM\"`) To send emails to one MongoDB Cloud user or grouping of users, set the `notifications.[n].emailEnabled` parameter.
@@ -222,6 +224,38 @@ func (o *NotificationViewForNdsGroup) SetIntervalMin(v int) {
o.IntervalMin = &v
}
+// GetNotifierId returns the NotifierId field value if set, zero value otherwise.
+func (o *NotificationViewForNdsGroup) GetNotifierId() string {
+ if o == nil || IsNil(o.NotifierId) {
+ var ret string
+ return ret
+ }
+ return *o.NotifierId
+}
+
+// GetNotifierIdOk returns a tuple with the NotifierId field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *NotificationViewForNdsGroup) GetNotifierIdOk() (*string, bool) {
+ if o == nil || IsNil(o.NotifierId) {
+ return nil, false
+ }
+ return o.NotifierId, true
+}
+
+// HasNotifierId returns a boolean if a field has been set.
+func (o *NotificationViewForNdsGroup) HasNotifierId() bool {
+ if o != nil && !IsNil(o.NotifierId) {
+ return true
+ }
+
+ return false
+}
+
+// SetNotifierId gets a reference to the given string and assigns it to the NotifierId field.
+func (o *NotificationViewForNdsGroup) SetNotifierId(v string) {
+ o.NotifierId = &v
+}
+
// GetTypeName returns the TypeName field value if set, zero value otherwise.
func (o *NotificationViewForNdsGroup) GetTypeName() string {
if o == nil || IsNil(o.TypeName) {
@@ -947,6 +981,9 @@ func (o NotificationViewForNdsGroup) ToMap() (map[string]interface{}, error) {
if !IsNil(o.IntervalMin) {
toSerialize["intervalMin"] = o.IntervalMin
}
+ if !IsNil(o.NotifierId) {
+ toSerialize["notifierId"] = o.NotifierId
+ }
if !IsNil(o.TypeName) {
toSerialize["typeName"] = o.TypeName
}
diff --git a/admin/model_serverless_instance_description.go b/admin/model_serverless_instance_description.go
index a7a2b283..8f2a6ca6 100644
--- a/admin/model_serverless_instance_description.go
+++ b/admin/model_serverless_instance_description.go
@@ -29,7 +29,8 @@ type ServerlessInstanceDescription struct {
ServerlessBackupOptions *ServerlessBackupOptions `json:"serverlessBackupOptions,omitempty"`
// Human-readable label that indicates the current operating condition of the serverless instance.
StateName *string `json:"stateName,omitempty"`
- Tags []Tag `json:"tags,omitempty"`
+ // List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.
+ Tags []Tag `json:"tags,omitempty"`
// Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance.
TerminationProtectionEnabled *bool `json:"terminationProtectionEnabled,omitempty"`
}
diff --git a/admin/model_serverless_instance_description_create.go b/admin/model_serverless_instance_description_create.go
index aa398948..a7b83194 100644
--- a/admin/model_serverless_instance_description_create.go
+++ b/admin/model_serverless_instance_description_create.go
@@ -17,6 +17,8 @@ type ServerlessInstanceDescriptionCreate struct {
ServerlessBackupOptions *ServerlessBackupOptions `json:"serverlessBackupOptions,omitempty"`
// Human-readable label that indicates the current operating condition of the serverless instance.
StateName *string `json:"stateName,omitempty"`
+ // List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.
+ Tags []Tag `json:"tags,omitempty"`
// Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance.
TerminationProtectionEnabled *bool `json:"terminationProtectionEnabled,omitempty"`
}
@@ -156,6 +158,38 @@ func (o *ServerlessInstanceDescriptionCreate) SetStateName(v string) {
o.StateName = &v
}
+// GetTags returns the Tags field value if set, zero value otherwise.
+func (o *ServerlessInstanceDescriptionCreate) GetTags() []Tag {
+ if o == nil || IsNil(o.Tags) {
+ var ret []Tag
+ return ret
+ }
+ return o.Tags
+}
+
+// GetTagsOk returns a tuple with the Tags field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *ServerlessInstanceDescriptionCreate) GetTagsOk() ([]Tag, bool) {
+ if o == nil || IsNil(o.Tags) {
+ return nil, false
+ }
+ return o.Tags, true
+}
+
+// HasTags returns a boolean if a field has been set.
+func (o *ServerlessInstanceDescriptionCreate) HasTags() bool {
+ if o != nil && !IsNil(o.Tags) {
+ return true
+ }
+
+ return false
+}
+
+// SetTags gets a reference to the given []Tag and assigns it to the Tags field.
+func (o *ServerlessInstanceDescriptionCreate) SetTags(v []Tag) {
+ o.Tags = v
+}
+
// GetTerminationProtectionEnabled returns the TerminationProtectionEnabled field value if set, zero value otherwise.
func (o *ServerlessInstanceDescriptionCreate) GetTerminationProtectionEnabled() bool {
if o == nil || IsNil(o.TerminationProtectionEnabled) {
@@ -202,6 +236,9 @@ func (o ServerlessInstanceDescriptionCreate) ToMap() (map[string]interface{}, er
if !IsNil(o.ServerlessBackupOptions) {
toSerialize["serverlessBackupOptions"] = o.ServerlessBackupOptions
}
+ if !IsNil(o.Tags) {
+ toSerialize["tags"] = o.Tags
+ }
if !IsNil(o.TerminationProtectionEnabled) {
toSerialize["terminationProtectionEnabled"] = o.TerminationProtectionEnabled
}
diff --git a/admin/model_serverless_instance_description_update.go b/admin/model_serverless_instance_description_update.go
index cb320372..7248f796 100644
--- a/admin/model_serverless_instance_description_update.go
+++ b/admin/model_serverless_instance_description_update.go
@@ -12,6 +12,8 @@ var _ MappedNullable = &ServerlessInstanceDescriptionUpdate{}
// ServerlessInstanceDescriptionUpdate Settings that you can update when you request a serverless cluster update.
type ServerlessInstanceDescriptionUpdate struct {
ServerlessBackupOptions *ServerlessBackupOptions `json:"serverlessBackupOptions,omitempty"`
+ // List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.
+ Tags []Tag `json:"tags,omitempty"`
// Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance.
TerminationProtectionEnabled *bool `json:"terminationProtectionEnabled,omitempty"`
}
@@ -69,6 +71,38 @@ func (o *ServerlessInstanceDescriptionUpdate) SetServerlessBackupOptions(v Serve
o.ServerlessBackupOptions = &v
}
+// GetTags returns the Tags field value if set, zero value otherwise.
+func (o *ServerlessInstanceDescriptionUpdate) GetTags() []Tag {
+ if o == nil || IsNil(o.Tags) {
+ var ret []Tag
+ return ret
+ }
+ return o.Tags
+}
+
+// GetTagsOk returns a tuple with the Tags field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *ServerlessInstanceDescriptionUpdate) GetTagsOk() ([]Tag, bool) {
+ if o == nil || IsNil(o.Tags) {
+ return nil, false
+ }
+ return o.Tags, true
+}
+
+// HasTags returns a boolean if a field has been set.
+func (o *ServerlessInstanceDescriptionUpdate) HasTags() bool {
+ if o != nil && !IsNil(o.Tags) {
+ return true
+ }
+
+ return false
+}
+
+// SetTags gets a reference to the given []Tag and assigns it to the Tags field.
+func (o *ServerlessInstanceDescriptionUpdate) SetTags(v []Tag) {
+ o.Tags = v
+}
+
// GetTerminationProtectionEnabled returns the TerminationProtectionEnabled field value if set, zero value otherwise.
func (o *ServerlessInstanceDescriptionUpdate) GetTerminationProtectionEnabled() bool {
if o == nil || IsNil(o.TerminationProtectionEnabled) {
@@ -113,6 +147,9 @@ func (o ServerlessInstanceDescriptionUpdate) ToMap() (map[string]interface{}, er
if !IsNil(o.ServerlessBackupOptions) {
toSerialize["serverlessBackupOptions"] = o.ServerlessBackupOptions
}
+ if !IsNil(o.Tags) {
+ toSerialize["tags"] = o.Tags
+ }
if !IsNil(o.TerminationProtectionEnabled) {
toSerialize["terminationProtectionEnabled"] = o.TerminationProtectionEnabled
}
diff --git a/admin/model_tag.go b/admin/model_tag.go
index 56da1591..d805c9bf 100644
--- a/admin/model_tag.go
+++ b/admin/model_tag.go
@@ -9,11 +9,11 @@ import (
// checks if the Tag type satisfies the MappedNullable interface at compile time
var _ MappedNullable = &Tag{}
-// Tag A key-value pair that tags and categorizes a MongoDB Cloud org, project, or cluster
+// Tag Key-value pair that tags and categorizes a MongoDB Cloud organization, project, or cluster. For example, `environment : production`.
type Tag struct {
- // Key applied to the tag.
+ // Constant that defines the set of the tag. For example, `environment` in the `environment : production` tag.
Key *string `json:"key,omitempty"`
- // Value applied to the tag.
+ // Variable that belongs to the set of the tag. For example, `production` in the `environment : production` tag.
Value *string `json:"value,omitempty"`
}
diff --git a/docs/doc_last_reference.md b/docs/doc_last_reference.md
index 7d2eb695..91e5f3a8 100644
--- a/docs/doc_last_reference.md
+++ b/docs/doc_last_reference.md
@@ -178,7 +178,7 @@ Class | Method | HTTP request | Description | Stability level
*MonitoringAndLogsApi* | [GetDatabase](./docs/MonitoringAndLogsApi.md#getdatabase) | **Get** /api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName} | Return One Database for a MongoDB Process | Experimental
*MonitoringAndLogsApi* | [GetDatabaseMeasurements](./docs/MonitoringAndLogsApi.md#getdatabasemeasurements) | **Get** /api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements | Return Measurements of One Database for One MongoDB Process | Stable
*MonitoringAndLogsApi* | [GetDiskMeasurements](./docs/MonitoringAndLogsApi.md#getdiskmeasurements) | **Get** /api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements | Return Measurements of One Disk for One MongoDB Process | Stable
-*MonitoringAndLogsApi* | [GetHostLogs](./docs/MonitoringAndLogsApi.md#gethostlogs) | **Get** /api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz | Download Logs for One Multi-Cloud Cluster Host in One Project | Stable
+*MonitoringAndLogsApi* | [GetHostLogs](./docs/MonitoringAndLogsApi.md#gethostlogs) | **Get** /api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz | Download Logs for One Cluster Host in One Project | Stable
*MonitoringAndLogsApi* | [GetHostMeasurements](./docs/MonitoringAndLogsApi.md#gethostmeasurements) | **Get** /api/atlas/v2/groups/{groupId}/processes/{processId}/measurements | Return Measurements for One MongoDB Process | Stable
*MonitoringAndLogsApi* | [GetIndexMetrics](./docs/MonitoringAndLogsApi.md#getindexmetrics) | **Get** /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements | Return Atlas Search Metrics for One Index in One Specified Namespace | Experimental
*MonitoringAndLogsApi* | [GetMeasurements](./docs/MonitoringAndLogsApi.md#getmeasurements) | **Get** /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements | Return Atlas Search Hardware and Status Metrics | Experimental
@@ -191,7 +191,7 @@ Class | Method | HTTP request | Description | Stability level
*MultiCloudClustersApi* | [CreateCluster](./docs/MultiCloudClustersApi.md#createcluster) | **Post** /api/atlas/v2/groups/{groupId}/clusters | Create One Multi-Cloud Cluster from One Project | Stable
*MultiCloudClustersApi* | [DeleteCluster](./docs/MultiCloudClustersApi.md#deletecluster) | **Delete** /api/atlas/v2/groups/{groupId}/clusters/{clusterName} | Remove One Multi-Cloud Cluster from One Project | Stable
*MultiCloudClustersApi* | [GetCluster](./docs/MultiCloudClustersApi.md#getcluster) | **Get** /api/atlas/v2/groups/{groupId}/clusters/{clusterName} | Return One Multi-Cloud Cluster from One Project | Stable
-*MultiCloudClustersApi* | [ListClusters](./docs/MultiCloudClustersApi.md#listclusters) | **Get** /api/atlas/v2/groups/{groupId}/clusters | Return All Multi-Cloud Clusters from One Project | Stable
+*MultiCloudClustersApi* | [ListClusters](./docs/MultiCloudClustersApi.md#listclusters) | **Get** /api/atlas/v2/groups/{groupId}/clusters | Return All Clusters in One Project | Stable
*MultiCloudClustersApi* | [TestFailover](./docs/MultiCloudClustersApi.md#testfailover) | **Post** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries | Test Failover for One Multi-Cloud Cluster | Stable
*MultiCloudClustersApi* | [UpdateCluster](./docs/MultiCloudClustersApi.md#updatecluster) | **Patch** /api/atlas/v2/groups/{groupId}/clusters/{clusterName} | Modify One Multi-Cloud Cluster from One Project | Stable
*NetworkPeeringApi* | [CreatePeeringConnection](./docs/NetworkPeeringApi.md#createpeeringconnection) | **Post** /api/atlas/v2/groups/{groupId}/peers | Create One New Network Peering Connection | Stable
@@ -224,6 +224,7 @@ Class | Method | HTTP request | Description | Stability level
*OrganizationsApi* | [ListOrganizationProjects](./docs/OrganizationsApi.md#listorganizationprojects) | **Get** /api/atlas/v2/orgs/{orgId}/groups | Return One or More Projects in One Organization | Stable
*OrganizationsApi* | [ListOrganizationUsers](./docs/OrganizationsApi.md#listorganizationusers) | **Get** /api/atlas/v2/orgs/{orgId}/users | Return All MongoDB Cloud Users in One Organization | Stable
*OrganizationsApi* | [ListOrganizations](./docs/OrganizationsApi.md#listorganizations) | **Get** /api/atlas/v2/orgs | Return All Organizations | Stable
+*OrganizationsApi* | [RemoveOrganizationUser](./docs/OrganizationsApi.md#removeorganizationuser) | **Delete** /api/atlas/v2/orgs/{orgId}/users/{userId} | Remove One MongoDB Cloud User from One Organization | Experimental
*OrganizationsApi* | [RenameOrganization](./docs/OrganizationsApi.md#renameorganization) | **Patch** /api/atlas/v2/orgs/{orgId} | Rename One Organization | Experimental
*OrganizationsApi* | [UpdateOrganizationInvitation](./docs/OrganizationsApi.md#updateorganizationinvitation) | **Patch** /api/atlas/v2/orgs/{orgId}/invites | Update One Organization Invitation | Stable
*OrganizationsApi* | [UpdateOrganizationInvitationById](./docs/OrganizationsApi.md#updateorganizationinvitationbyid) | **Patch** /api/atlas/v2/orgs/{orgId}/invites/{invitationId} | Update One Organization Invitation by Invitation ID | Stable
@@ -312,7 +313,6 @@ Class | Method | HTTP request | Description | Stability level
*TeamsApi* | [RemoveTeamUser](./docs/TeamsApi.md#removeteamuser) | **Delete** /api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId} | Remove One MongoDB Cloud User from One Team | Stable
*TeamsApi* | [RenameTeam](./docs/TeamsApi.md#renameteam) | **Patch** /api/atlas/v2/orgs/{orgId}/teams/{teamId} | Rename One Team | Experimental
*TeamsApi* | [UpdateTeamRoles](./docs/TeamsApi.md#updateteamroles) | **Patch** /api/atlas/v2/groups/{groupId}/teams/{teamId} | Update Team Roles in One Project | Stable
-*TestApi* | [VersionedExample](./docs/TestApi.md#versionedexample) | **Get** /api/atlas/v2/example/info | Example resource info for versioning of the Atlas API | Experimental
*ThirdPartyIntegrationsApi* | [CreateThirdPartyIntegration](./docs/ThirdPartyIntegrationsApi.md#createthirdpartyintegration) | **Post** /api/atlas/v2/groups/{groupId}/integrations/{integrationType} | Configure One Third-Party Service Integration | Stable
*ThirdPartyIntegrationsApi* | [DeleteThirdPartyIntegration](./docs/ThirdPartyIntegrationsApi.md#deletethirdpartyintegration) | **Delete** /api/atlas/v2/groups/{groupId}/integrations/{integrationType} | Remove One Third-Party Service Integration | Stable
*ThirdPartyIntegrationsApi* | [GetThirdPartyIntegration](./docs/ThirdPartyIntegrationsApi.md#getthirdpartyintegration) | **Get** /api/atlas/v2/groups/{groupId}/integrations/{integrationType} | Return One Third-Party Service Integration | Stable
@@ -384,14 +384,15 @@ Class | Method | HTTP request | Description | Stability level
- [ConnectedOrgConfig](./docs/ConnectedOrgConfig.md)
- [ContainerPeer](./docs/ContainerPeer.md)
- [CreateAWSEndpointRequest](./docs/CreateAWSEndpointRequest.md)
- - [CreateApiKey](./docs/CreateApiKey.md)
- [CreateAzureEndpointRequest](./docs/CreateAzureEndpointRequest.md)
- [CreateEndpointRequest](./docs/CreateEndpointRequest.md)
- [CreateEndpointServiceRequest](./docs/CreateEndpointServiceRequest.md)
- [CreateGCPEndpointGroupRequest](./docs/CreateGCPEndpointGroupRequest.md)
- [CreateGCPForwardingRuleRequest](./docs/CreateGCPForwardingRuleRequest.md)
+ - [CreateOrganizationApiKey](./docs/CreateOrganizationApiKey.md)
- [CreateOrganizationRequest](./docs/CreateOrganizationRequest.md)
- [CreateOrganizationResponse](./docs/CreateOrganizationResponse.md)
+ - [CreateProjectApiKey](./docs/CreateProjectApiKey.md)
- [Criteria](./docs/Criteria.md)
- [CustomCriteria](./docs/CustomCriteria.md)
- [CustomDBRole](./docs/CustomDBRole.md)
@@ -449,7 +450,6 @@ Class | Method | HTTP request | Description | Stability level
- [Error](./docs/Error.md)
- [EventViewForNdsGroup](./docs/EventViewForNdsGroup.md)
- [EventViewForOrg](./docs/EventViewForOrg.md)
- - [ExampleResourceResponseView20230201](./docs/ExampleResourceResponseView20230201.md)
- [ExportStatus](./docs/ExportStatus.md)
- [FTSAnalyzers](./docs/FTSAnalyzers.md)
- [FTSAnalyzersCharFiltersInner](./docs/FTSAnalyzersCharFiltersInner.md)
diff --git a/docs/docs/ClusterDescriptionV15.md b/docs/docs/ClusterDescriptionV15.md
index b60a1b22..22963428 100644
--- a/docs/docs/ClusterDescriptionV15.md
+++ b/docs/docs/ClusterDescriptionV15.md
@@ -23,7 +23,7 @@ Name | Type | Description | Notes
**ReplicationSpecs** | Pointer to [**[]ReplicationSpec**](ReplicationSpec.md) | List of settings that configure your cluster regions. For Global Clusters, each object in the array represents a zone where your clusters nodes deploy. For non-Global sharded clusters and replica sets, this array has one object representing where your clusters nodes deploy. | [optional]
**RootCertType** | Pointer to **string** | Root Certificate Authority that MongoDB Cloud cluster uses. MongoDB Cloud supports Internet Security Research Group. | [optional] [default to "ISRGROOTX1"]
**StateName** | Pointer to **string** | Human-readable label that indicates the current operating condition of this cluster. | [optional] [readonly]
-**Tags** | Pointer to [**[]Tag**](Tag.md) | Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. | [optional]
+**Tags** | Pointer to [**[]Tag**](Tag.md) | List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. | [optional]
**TerminationProtectionEnabled** | Pointer to **bool** | Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster. | [optional] [default to false]
**VersionReleaseSystem** | Pointer to **string** | Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**. | [optional] [default to "LTS"]
diff --git a/docs/docs/CreateOrganizationApiKey.md b/docs/docs/CreateOrganizationApiKey.md
new file mode 100644
index 00000000..c145189e
--- /dev/null
+++ b/docs/docs/CreateOrganizationApiKey.md
@@ -0,0 +1,82 @@
+# CreateOrganizationApiKey
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Desc** | Pointer to **string** | Purpose or explanation provided when someone created this organization API key. | [optional]
+**Roles** | Pointer to **[]string** | List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this organization. | [optional]
+
+## Methods
+
+### NewCreateOrganizationApiKey
+
+`func NewCreateOrganizationApiKey() *CreateOrganizationApiKey`
+
+NewCreateOrganizationApiKey instantiates a new CreateOrganizationApiKey object
+This constructor will assign default values to properties that have it defined,
+and makes sure properties required by API are set, but the set of arguments
+will change when the set of required properties is changed
+
+### NewCreateOrganizationApiKeyWithDefaults
+
+`func NewCreateOrganizationApiKeyWithDefaults() *CreateOrganizationApiKey`
+
+NewCreateOrganizationApiKeyWithDefaults instantiates a new CreateOrganizationApiKey object
+This constructor will only assign default values to properties that have it defined,
+but it doesn't guarantee that properties required by API are set
+
+### GetDesc
+
+`func (o *CreateOrganizationApiKey) GetDesc() string`
+
+GetDesc returns the Desc field if non-nil, zero value otherwise.
+
+### GetDescOk
+
+`func (o *CreateOrganizationApiKey) GetDescOk() (*string, bool)`
+
+GetDescOk returns a tuple with the Desc field if it's non-nil, zero value otherwise
+and a boolean to check if the value has been set.
+
+### SetDesc
+
+`func (o *CreateOrganizationApiKey) SetDesc(v string)`
+
+SetDesc sets Desc field to given value.
+
+### HasDesc
+
+`func (o *CreateOrganizationApiKey) HasDesc() bool`
+
+HasDesc returns a boolean if a field has been set.
+
+### GetRoles
+
+`func (o *CreateOrganizationApiKey) GetRoles() []string`
+
+GetRoles returns the Roles field if non-nil, zero value otherwise.
+
+### GetRolesOk
+
+`func (o *CreateOrganizationApiKey) GetRolesOk() (*[]string, bool)`
+
+GetRolesOk returns a tuple with the Roles field if it's non-nil, zero value otherwise
+and a boolean to check if the value has been set.
+
+### SetRoles
+
+`func (o *CreateOrganizationApiKey) SetRoles(v []string)`
+
+SetRoles sets Roles field to given value.
+
+### HasRoles
+
+`func (o *CreateOrganizationApiKey) HasRoles() bool`
+
+HasRoles returns a boolean if a field has been set.
+
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/docs/CreateOrganizationRequest.md b/docs/docs/CreateOrganizationRequest.md
index d8384f07..6e115c7a 100644
--- a/docs/docs/CreateOrganizationRequest.md
+++ b/docs/docs/CreateOrganizationRequest.md
@@ -4,9 +4,10 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**ApiKey** | Pointer to [**CreateApiKey**](CreateApiKey.md) | | [optional]
+**ApiKey** | Pointer to [**CreateOrganizationApiKey**](CreateOrganizationApiKey.md) | | [optional]
+**FederationSettingsId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the federation to link the newly created organization to. If specified, the proposed Organization Owner of the new organization must have the Organization Owner role in an organization associated with the federation. | [optional]
**Name** | **string** | Human-readable label that identifies the organization. |
-**OrgOwnerId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the Atlas user that you want to assign the Organization Owner role. This user must be a member of the same organization as the calling API key. This is only required when authenticating with Programmatic API Keys. | [optional]
+**OrgOwnerId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user that you want to assign the Organization Owner role. This user must be a member of the same organization as the calling API key. If you provide `federationSettingsId`, this user must instead have the Organization Owner role on an organization in the specified federation. This parameter is required only when you authenticate with Programmatic API Keys. | [optional]
## Methods
@@ -29,20 +30,20 @@ but it doesn't guarantee that properties required by API are set
### GetApiKey
-`func (o *CreateOrganizationRequest) GetApiKey() CreateApiKey`
+`func (o *CreateOrganizationRequest) GetApiKey() CreateOrganizationApiKey`
GetApiKey returns the ApiKey field if non-nil, zero value otherwise.
### GetApiKeyOk
-`func (o *CreateOrganizationRequest) GetApiKeyOk() (*CreateApiKey, bool)`
+`func (o *CreateOrganizationRequest) GetApiKeyOk() (*CreateOrganizationApiKey, bool)`
GetApiKeyOk returns a tuple with the ApiKey field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetApiKey
-`func (o *CreateOrganizationRequest) SetApiKey(v CreateApiKey)`
+`func (o *CreateOrganizationRequest) SetApiKey(v CreateOrganizationApiKey)`
SetApiKey sets ApiKey field to given value.
@@ -52,6 +53,31 @@ SetApiKey sets ApiKey field to given value.
HasApiKey returns a boolean if a field has been set.
+### GetFederationSettingsId
+
+`func (o *CreateOrganizationRequest) GetFederationSettingsId() string`
+
+GetFederationSettingsId returns the FederationSettingsId field if non-nil, zero value otherwise.
+
+### GetFederationSettingsIdOk
+
+`func (o *CreateOrganizationRequest) GetFederationSettingsIdOk() (*string, bool)`
+
+GetFederationSettingsIdOk returns a tuple with the FederationSettingsId field if it's non-nil, zero value otherwise
+and a boolean to check if the value has been set.
+
+### SetFederationSettingsId
+
+`func (o *CreateOrganizationRequest) SetFederationSettingsId(v string)`
+
+SetFederationSettingsId sets FederationSettingsId field to given value.
+
+### HasFederationSettingsId
+
+`func (o *CreateOrganizationRequest) HasFederationSettingsId() bool`
+
+HasFederationSettingsId returns a boolean if a field has been set.
+
### GetName
`func (o *CreateOrganizationRequest) GetName() string`
diff --git a/docs/docs/CreateOrganizationResponse.md b/docs/docs/CreateOrganizationResponse.md
index 1d7ac5c4..3bf9dfb1 100644
--- a/docs/docs/CreateOrganizationResponse.md
+++ b/docs/docs/CreateOrganizationResponse.md
@@ -5,7 +5,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ApiKey** | Pointer to [**ApiUser**](ApiUser.md) | | [optional]
-**OrgOwnerId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the Atlas user that you want to assign the Organization Owner role. | [optional] [readonly]
+**FederationSettingsId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the federation that you linked the newly created organization to. | [optional] [readonly]
+**OrgOwnerId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user that you assigned the Organization Owner role in the new organization. | [optional] [readonly]
**Organization** | Pointer to [**Organization**](Organization.md) | | [optional]
## Methods
@@ -52,6 +53,31 @@ SetApiKey sets ApiKey field to given value.
HasApiKey returns a boolean if a field has been set.
+### GetFederationSettingsId
+
+`func (o *CreateOrganizationResponse) GetFederationSettingsId() string`
+
+GetFederationSettingsId returns the FederationSettingsId field if non-nil, zero value otherwise.
+
+### GetFederationSettingsIdOk
+
+`func (o *CreateOrganizationResponse) GetFederationSettingsIdOk() (*string, bool)`
+
+GetFederationSettingsIdOk returns a tuple with the FederationSettingsId field if it's non-nil, zero value otherwise
+and a boolean to check if the value has been set.
+
+### SetFederationSettingsId
+
+`func (o *CreateOrganizationResponse) SetFederationSettingsId(v string)`
+
+SetFederationSettingsId sets FederationSettingsId field to given value.
+
+### HasFederationSettingsId
+
+`func (o *CreateOrganizationResponse) HasFederationSettingsId() bool`
+
+HasFederationSettingsId returns a boolean if a field has been set.
+
### GetOrgOwnerId
`func (o *CreateOrganizationResponse) GetOrgOwnerId() string`
diff --git a/docs/docs/CreateApiKey.md b/docs/docs/CreateProjectApiKey.md
similarity index 63%
rename from docs/docs/CreateApiKey.md
rename to docs/docs/CreateProjectApiKey.md
index 015a37f9..3658ab1d 100644
--- a/docs/docs/CreateApiKey.md
+++ b/docs/docs/CreateProjectApiKey.md
@@ -1,78 +1,78 @@
-# CreateApiKey
+# CreateProjectApiKey
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**Desc** | Pointer to **string** | Purpose or explanation provided when someone created this organization API key. | [optional]
-**Roles** | Pointer to **[]string** | List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this organization or project. | [optional]
+**Desc** | Pointer to **string** | Purpose or explanation provided when someone created this project API key. | [optional]
+**Roles** | Pointer to **[]string** | List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this project. | [optional]
## Methods
-### NewCreateApiKey
+### NewCreateProjectApiKey
-`func NewCreateApiKey() *CreateApiKey`
+`func NewCreateProjectApiKey() *CreateProjectApiKey`
-NewCreateApiKey instantiates a new CreateApiKey object
+NewCreateProjectApiKey instantiates a new CreateProjectApiKey object
This constructor will assign default values to properties that have it defined,
and makes sure properties required by API are set, but the set of arguments
will change when the set of required properties is changed
-### NewCreateApiKeyWithDefaults
+### NewCreateProjectApiKeyWithDefaults
-`func NewCreateApiKeyWithDefaults() *CreateApiKey`
+`func NewCreateProjectApiKeyWithDefaults() *CreateProjectApiKey`
-NewCreateApiKeyWithDefaults instantiates a new CreateApiKey object
+NewCreateProjectApiKeyWithDefaults instantiates a new CreateProjectApiKey object
This constructor will only assign default values to properties that have it defined,
but it doesn't guarantee that properties required by API are set
### GetDesc
-`func (o *CreateApiKey) GetDesc() string`
+`func (o *CreateProjectApiKey) GetDesc() string`
GetDesc returns the Desc field if non-nil, zero value otherwise.
### GetDescOk
-`func (o *CreateApiKey) GetDescOk() (*string, bool)`
+`func (o *CreateProjectApiKey) GetDescOk() (*string, bool)`
GetDescOk returns a tuple with the Desc field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetDesc
-`func (o *CreateApiKey) SetDesc(v string)`
+`func (o *CreateProjectApiKey) SetDesc(v string)`
SetDesc sets Desc field to given value.
### HasDesc
-`func (o *CreateApiKey) HasDesc() bool`
+`func (o *CreateProjectApiKey) HasDesc() bool`
HasDesc returns a boolean if a field has been set.
### GetRoles
-`func (o *CreateApiKey) GetRoles() []string`
+`func (o *CreateProjectApiKey) GetRoles() []string`
GetRoles returns the Roles field if non-nil, zero value otherwise.
### GetRolesOk
-`func (o *CreateApiKey) GetRolesOk() (*[]string, bool)`
+`func (o *CreateProjectApiKey) GetRolesOk() (*[]string, bool)`
GetRolesOk returns a tuple with the Roles field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetRoles
-`func (o *CreateApiKey) SetRoles(v []string)`
+`func (o *CreateProjectApiKey) SetRoles(v []string)`
SetRoles sets Roles field to given value.
### HasRoles
-`func (o *CreateApiKey) HasRoles() bool`
+`func (o *CreateProjectApiKey) HasRoles() bool`
HasRoles returns a boolean if a field has been set.
diff --git a/docs/docs/DLSIngestionSink.md b/docs/docs/DLSIngestionSink.md
index 0b6edc9a..ad8911a0 100644
--- a/docs/docs/DLSIngestionSink.md
+++ b/docs/docs/DLSIngestionSink.md
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
**MetadataProvider** | Pointer to **string** | Target cloud provider for this Data Lake Pipeline. | [optional]
**MetadataRegion** | Pointer to **string** | Target cloud provider region for this Data Lake Pipeline. | [optional]
**PartitionFields** | Pointer to [**[]PartitionField**](PartitionField.md) | Ordered fields used to physically organize data in the destination. | [optional]
-**Type** | Pointer to **string** | Type of ingestion destination of this Data Lake Pipeline. | [optional]
+**Type** | Pointer to **string** | Type of ingestion destination of this Data Lake Pipeline. | [optional] [readonly]
## Methods
diff --git a/docs/docs/DataFederationApi.md b/docs/docs/DataFederationApi.md
index 9d3e0eb2..6701f64b 100644
--- a/docs/docs/DataFederationApi.md
+++ b/docs/docs/DataFederationApi.md
@@ -180,7 +180,7 @@ Name | Type | Description | Notes
## CreateOneDataFederationQueryLimit
-> []DataFederationTenantQueryLimit CreateOneDataFederationQueryLimit(ctx, groupId, tenantName, limitName, dataFederationTenantQueryLimit DataFederationTenantQueryLimit).Execute()
+> DataFederationTenantQueryLimit CreateOneDataFederationQueryLimit(ctx, groupId, tenantName, limitName, dataFederationTenantQueryLimit DataFederationTenantQueryLimit).Execute()
Configure One Query Limit for One Federated Database Instance
@@ -220,7 +220,7 @@ func main() {
apiError := admin.AsError(err)
fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError)
}
- // response from `CreateOneDataFederationQueryLimit`: []DataFederationTenantQueryLimit
+ // response from `CreateOneDataFederationQueryLimit`: DataFederationTenantQueryLimit
fmt.Fprintf(os.Stdout, "Response from `DataFederationApi.CreateOneDataFederationQueryLimit`: %v\n", resp)
}
```
@@ -249,7 +249,7 @@ Name | Type | Description | Notes
### Return type
-[**[]DataFederationTenantQueryLimit**](DataFederationTenantQueryLimit.md)
+[**DataFederationTenantQueryLimit**](DataFederationTenantQueryLimit.md)
### Authorization
[DigestAuth](../README.md#Authentication)
@@ -908,7 +908,7 @@ Name | Type | Description | Notes
## ReturnFederatedDatabaseQueryLimit
-> []DataFederationTenantQueryLimit ReturnFederatedDatabaseQueryLimit(ctx, groupId, tenantName, limitName).Execute()
+> DataFederationTenantQueryLimit ReturnFederatedDatabaseQueryLimit(ctx, groupId, tenantName, limitName).Execute()
Return One Federated Database Instance Query Limit for One Project
@@ -947,7 +947,7 @@ func main() {
apiError := admin.AsError(err)
fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError)
}
- // response from `ReturnFederatedDatabaseQueryLimit`: []DataFederationTenantQueryLimit
+ // response from `ReturnFederatedDatabaseQueryLimit`: DataFederationTenantQueryLimit
fmt.Fprintf(os.Stdout, "Response from `DataFederationApi.ReturnFederatedDatabaseQueryLimit`: %v\n", resp)
}
```
@@ -975,7 +975,7 @@ Name | Type | Description | Notes
### Return type
-[**[]DataFederationTenantQueryLimit**](DataFederationTenantQueryLimit.md)
+[**DataFederationTenantQueryLimit**](DataFederationTenantQueryLimit.md)
### Authorization
[DigestAuth](../README.md#Authentication)
diff --git a/docs/docs/DatabaseUser.md b/docs/docs/DatabaseUser.md
index b051f3b1..a0a78b68 100644
--- a/docs/docs/DatabaseUser.md
+++ b/docs/docs/DatabaseUser.md
@@ -11,10 +11,11 @@ Name | Type | Description | Notes
**Labels** | Pointer to [**[]NDSLabel**](NDSLabel.md) | List that contains the key-value pairs for tagging and categorizing the MongoDB database user. The labels that you define do not appear in the console. | [optional]
**LdapAuthType** | Pointer to **string** | Part of the Lightweight Directory Access Protocol (LDAP) record that the database uses to authenticate this database user on the LDAP host. | [optional] [default to "NONE"]
**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly]
+**OidcAuthType** | Pointer to **string** | Human-readable label that indicates whether the new database user authenticates with OIDC federated authentication. To create a federated authentication user, specify the value of IDP_GROUP for this field. | [optional] [default to "NONE"]
**Password** | Pointer to **string** | Alphanumeric string that authenticates this database user against the database specified in `databaseName`. To authenticate with SCRAM-SHA, you must specify this parameter. This parameter doesn't appear in this response. | [optional]
**Roles** | Pointer to [**[]Role**](Role.md) | List that provides the pairings of one role with one applicable database. | [optional]
**Scopes** | Pointer to [**[]UserScope**](UserScope.md) | List that contains clusters and MongoDB Atlas Data Lakes that this database user can access. If omitted, MongoDB Cloud grants the database user access to all the clusters and MongoDB Atlas Data Lakes in the project. | [optional]
-**Username** | **string** | Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication: | Authentication Method | Parameter Needed | Parameter Value | username Format | |---|---|---|---| | AWS IAM | awsType | ROLE | <abbr title=\"Amazon Resource Name\">ARN</abbr> | | AWS IAM | awsType | USER | <abbr title=\"Amazon Resource Name\">ARN</abbr> | | x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | SCRAM-SHA | awsType, x509Type, ldapAuthType | NONE | Alphanumeric string | |
+**Username** | **string** | Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication: | Authentication Method | Parameter Needed | Parameter Value | username Format | |---|---|---|---| | AWS IAM | awsType | ROLE | <abbr title=\"Amazon Resource Name\">ARN</abbr> | | AWS IAM | awsType | USER | <abbr title=\"Amazon Resource Name\">ARN</abbr> | | x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | OIDC | oidcAuthType | IDP_GROUP | Atlas OIDC IdP Identifier (found in Federation Settings, or contact Support), followed by a '/', followed by the IdP group name | | SCRAM-SHA | awsType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string | |
**X509Type** | Pointer to **string** | X.509 method that MongoDB Cloud uses to authenticate the database user. - For application-managed X.509, specify `MANAGED`. - For self-managed X.509, specify `CUSTOMER`. Users created with the `CUSTOMER` method require a Common Name (CN) in the **username** parameter. You must create externally authenticated users on the `$external` database. | [optional] [default to "NONE"]
## Methods
@@ -201,6 +202,31 @@ SetLinks sets Links field to given value.
HasLinks returns a boolean if a field has been set.
+### GetOidcAuthType
+
+`func (o *DatabaseUser) GetOidcAuthType() string`
+
+GetOidcAuthType returns the OidcAuthType field if non-nil, zero value otherwise.
+
+### GetOidcAuthTypeOk
+
+`func (o *DatabaseUser) GetOidcAuthTypeOk() (*string, bool)`
+
+GetOidcAuthTypeOk returns a tuple with the OidcAuthType field if it's non-nil, zero value otherwise
+and a boolean to check if the value has been set.
+
+### SetOidcAuthType
+
+`func (o *DatabaseUser) SetOidcAuthType(v string)`
+
+SetOidcAuthType sets OidcAuthType field to given value.
+
+### HasOidcAuthType
+
+`func (o *DatabaseUser) HasOidcAuthType() bool`
+
+HasOidcAuthType returns a boolean if a field has been set.
+
### GetPassword
`func (o *DatabaseUser) GetPassword() string`
diff --git a/docs/docs/DatabaseUsersApi.md b/docs/docs/DatabaseUsersApi.md
index 7589ce41..523a1359 100644
--- a/docs/docs/DatabaseUsersApi.md
+++ b/docs/docs/DatabaseUsersApi.md
@@ -115,7 +115,7 @@ func main() {
groupId := "32b6e34b3d91647abb20e7b8" // string |
databaseName := "databaseName_example" // string |
- username := "SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs orx.509 or LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM" // string |
+ username := "SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName" // string |
resp, r, err := sdk.DatabaseUsersApi.DeleteDatabaseUser(context.Background(), groupId, databaseName, username).Execute()
if err != nil {
@@ -135,8 +135,8 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**groupId** | **string** | 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. |
-**databaseName** | **string** | Human-readable label that identifies 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, or LDAP, this value should be `$external`. If the user authenticates with SCRAM-SHA, this value should be `admin`. |
-**username** | **string** | Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication: | Authentication Method | Parameter Needed | Parameter Value | username Format | |---|---|---|---| | AWS IAM | awsType | ROLE | <abbr title=\"Amazon Resource Name\">ARN</abbr> | | AWS IAM | awsType | USER | <abbr title=\"Amazon Resource Name\">ARN</abbr> | | x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | SCRAM-SHA | awsType, x509Type, ldapAuthType | NONE | Alphanumeric string | |
+**databaseName** | **string** | Human-readable label that identifies 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, or LDAP, this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC, this value should be `admin`. |
+**username** | **string** | Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication: | Authentication Method | Parameter Needed | Parameter Value | username Format | |---|---|---|---| | AWS IAM | awsType | ROLE | <abbr title=\"Amazon Resource Name\">ARN</abbr> | | AWS IAM | awsType | USER | <abbr title=\"Amazon Resource Name\">ARN</abbr> | | x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | OIDC | oidcAuthType | IDP_GROUP | Atlas OIDC IdP Identifier (found in Federation Settings, or contact Support), followed by a '/', followed by the IdP group name | | SCRAM-SHA | awsType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string | |
### Other Parameters
@@ -194,7 +194,7 @@ func main() {
groupId := "32b6e34b3d91647abb20e7b8" // string |
databaseName := "databaseName_example" // string |
- username := "SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs orx.509 or LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM" // string |
+ username := "SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName" // string |
resp, r, err := sdk.DatabaseUsersApi.GetDatabaseUser(context.Background(), groupId, databaseName, username).Execute()
if err != nil {
@@ -214,8 +214,8 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**groupId** | **string** | 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. |
-**databaseName** | **string** | Human-readable label that identifies 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, or LDAP, this value should be `$external`. If the user authenticates with SCRAM-SHA, this value should be `admin`. |
-**username** | **string** | Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication: | Authentication Method | Parameter Needed | Parameter Value | username Format | |---|---|---|---| | AWS IAM | awsType | ROLE | <abbr title=\"Amazon Resource Name\">ARN</abbr> | | AWS IAM | awsType | USER | <abbr title=\"Amazon Resource Name\">ARN</abbr> | | x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | SCRAM-SHA | awsType, x509Type, ldapAuthType | NONE | Alphanumeric string | |
+**databaseName** | **string** | Human-readable label that identifies 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, or LDAP, this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC, this value should be `admin`. |
+**username** | **string** | Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication: | Authentication Method | Parameter Needed | Parameter Value | username Format | |---|---|---|---| | AWS IAM | awsType | ROLE | <abbr title=\"Amazon Resource Name\">ARN</abbr> | | AWS IAM | awsType | USER | <abbr title=\"Amazon Resource Name\">ARN</abbr> | | x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | OIDC | oidcAuthType | IDP_GROUP | Atlas OIDC IdP Identifier (found in Federation Settings, or contact Support), followed by a '/', followed by the IdP group name | | SCRAM-SHA | awsType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string | |
### Other Parameters
@@ -352,7 +352,7 @@ func main() {
groupId := "32b6e34b3d91647abb20e7b8" // string |
databaseName := "databaseName_example" // string |
- username := "SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs orx.509 or LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM" // string |
+ username := "SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName" // string |
databaseUser := *openapiclient.NewDatabaseUser("DatabaseName_example", "32b6e34b3d91647abb20e7b8", "Username_example") // DatabaseUser |
resp, r, err := sdk.DatabaseUsersApi.UpdateDatabaseUser(context.Background(), groupId, databaseName, username, &databaseUser).Execute()
@@ -373,8 +373,8 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**groupId** | **string** | 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. |
-**databaseName** | **string** | Human-readable label that identifies 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, or LDAP, this value should be `$external`. If the user authenticates with SCRAM-SHA, this value should be `admin`. |
-**username** | **string** | Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication: | Authentication Method | Parameter Needed | Parameter Value | username Format | |---|---|---|---| | AWS IAM | awsType | ROLE | <abbr title=\"Amazon Resource Name\">ARN</abbr> | | AWS IAM | awsType | USER | <abbr title=\"Amazon Resource Name\">ARN</abbr> | | x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | SCRAM-SHA | awsType, x509Type, ldapAuthType | NONE | Alphanumeric string | |
+**databaseName** | **string** | Human-readable label that identifies 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, or LDAP, this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC, this value should be `admin`. |
+**username** | **string** | Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication: | Authentication Method | Parameter Needed | Parameter Value | username Format | |---|---|---|---| | AWS IAM | awsType | ROLE | <abbr title=\"Amazon Resource Name\">ARN</abbr> | | AWS IAM | awsType | USER | <abbr title=\"Amazon Resource Name\">ARN</abbr> | | x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | OIDC | oidcAuthType | IDP_GROUP | Atlas OIDC IdP Identifier (found in Federation Settings, or contact Support), followed by a '/', followed by the IdP group name | | SCRAM-SHA | awsType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string | |
### Other Parameters
diff --git a/docs/docs/ExampleResourceResponseView20230201.md b/docs/docs/ExampleResourceResponseView20230201.md
deleted file mode 100644
index 735b09df..00000000
--- a/docs/docs/ExampleResourceResponseView20230201.md
+++ /dev/null
@@ -1,129 +0,0 @@
-# ExampleResourceResponseView20230201
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**AdditionalInfo** | Pointer to **string** | Dummy additional field added to the response. | [optional]
-**Data** | Pointer to **[]string** | Array that contains the dummy metadata. | [optional]
-**Description** | **string** | Dummy description added as response. |
-**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly]
-
-## Methods
-
-### NewExampleResourceResponseView20230201
-
-`func NewExampleResourceResponseView20230201(description string, ) *ExampleResourceResponseView20230201`
-
-NewExampleResourceResponseView20230201 instantiates a new ExampleResourceResponseView20230201 object
-This constructor will assign default values to properties that have it defined,
-and makes sure properties required by API are set, but the set of arguments
-will change when the set of required properties is changed
-
-### NewExampleResourceResponseView20230201WithDefaults
-
-`func NewExampleResourceResponseView20230201WithDefaults() *ExampleResourceResponseView20230201`
-
-NewExampleResourceResponseView20230201WithDefaults instantiates a new ExampleResourceResponseView20230201 object
-This constructor will only assign default values to properties that have it defined,
-but it doesn't guarantee that properties required by API are set
-
-### GetAdditionalInfo
-
-`func (o *ExampleResourceResponseView20230201) GetAdditionalInfo() string`
-
-GetAdditionalInfo returns the AdditionalInfo field if non-nil, zero value otherwise.
-
-### GetAdditionalInfoOk
-
-`func (o *ExampleResourceResponseView20230201) GetAdditionalInfoOk() (*string, bool)`
-
-GetAdditionalInfoOk returns a tuple with the AdditionalInfo field if it's non-nil, zero value otherwise
-and a boolean to check if the value has been set.
-
-### SetAdditionalInfo
-
-`func (o *ExampleResourceResponseView20230201) SetAdditionalInfo(v string)`
-
-SetAdditionalInfo sets AdditionalInfo field to given value.
-
-### HasAdditionalInfo
-
-`func (o *ExampleResourceResponseView20230201) HasAdditionalInfo() bool`
-
-HasAdditionalInfo returns a boolean if a field has been set.
-
-### GetData
-
-`func (o *ExampleResourceResponseView20230201) GetData() []string`
-
-GetData returns the Data field if non-nil, zero value otherwise.
-
-### GetDataOk
-
-`func (o *ExampleResourceResponseView20230201) GetDataOk() (*[]string, bool)`
-
-GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise
-and a boolean to check if the value has been set.
-
-### SetData
-
-`func (o *ExampleResourceResponseView20230201) SetData(v []string)`
-
-SetData sets Data field to given value.
-
-### HasData
-
-`func (o *ExampleResourceResponseView20230201) HasData() bool`
-
-HasData returns a boolean if a field has been set.
-
-### GetDescription
-
-`func (o *ExampleResourceResponseView20230201) GetDescription() string`
-
-GetDescription returns the Description field if non-nil, zero value otherwise.
-
-### GetDescriptionOk
-
-`func (o *ExampleResourceResponseView20230201) GetDescriptionOk() (*string, bool)`
-
-GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise
-and a boolean to check if the value has been set.
-
-### SetDescription
-
-`func (o *ExampleResourceResponseView20230201) SetDescription(v string)`
-
-SetDescription sets Description field to given value.
-
-
-### GetLinks
-
-`func (o *ExampleResourceResponseView20230201) GetLinks() []Link`
-
-GetLinks returns the Links field if non-nil, zero value otherwise.
-
-### GetLinksOk
-
-`func (o *ExampleResourceResponseView20230201) GetLinksOk() (*[]Link, bool)`
-
-GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise
-and a boolean to check if the value has been set.
-
-### SetLinks
-
-`func (o *ExampleResourceResponseView20230201) SetLinks(v []Link)`
-
-SetLinks sets Links field to given value.
-
-### HasLinks
-
-`func (o *ExampleResourceResponseView20230201) HasLinks() bool`
-
-HasLinks returns a boolean if a field has been set.
-
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
-
-
diff --git a/docs/docs/IngestionSink.md b/docs/docs/IngestionSink.md
index 9925b991..403b9dc5 100644
--- a/docs/docs/IngestionSink.md
+++ b/docs/docs/IngestionSink.md
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
**MetadataProvider** | Pointer to **string** | Target cloud provider for this Data Lake Pipeline. | [optional]
**MetadataRegion** | Pointer to **string** | Target cloud provider region for this Data Lake Pipeline. | [optional]
**PartitionFields** | Pointer to [**[]PartitionField**](PartitionField.md) | Ordered fields used to physically organize data in the destination. | [optional]
-**Type** | Pointer to **string** | Type of ingestion destination of this Data Lake Pipeline. | [optional]
+**Type** | Pointer to **string** | Type of ingestion destination of this Data Lake Pipeline. | [optional] [readonly]
## Methods
diff --git a/docs/docs/InvoicesApi.md b/docs/docs/InvoicesApi.md
index 491b8270..00fc40b7 100644
--- a/docs/docs/InvoicesApi.md
+++ b/docs/docs/InvoicesApi.md
@@ -13,7 +13,7 @@ Method | HTTP request | Description
## DownloadInvoiceCSV
-> DownloadInvoiceCSV(ctx, orgId, invoiceId).Execute()
+> string DownloadInvoiceCSV(ctx, orgId, invoiceId).Execute()
Return One Organization Invoice as CSV
@@ -45,12 +45,14 @@ func main() {
orgId := "4888442a3354817a7320eb61" // string |
invoiceId := "invoiceId_example" // string |
- r, err := sdk.InvoicesApi.DownloadInvoiceCSV(context.Background(), orgId, invoiceId).Execute()
+ resp, r, err := sdk.InvoicesApi.DownloadInvoiceCSV(context.Background(), orgId, invoiceId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `InvoicesApi.DownloadInvoiceCSV``: %v\n", err)
apiError := admin.AsError(err)
fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError)
}
+ // response from `DownloadInvoiceCSV`: string
+ fmt.Fprintf(os.Stdout, "Response from `InvoicesApi.DownloadInvoiceCSV`: %v\n", resp)
}
```
@@ -75,7 +77,7 @@ Name | Type | Description | Notes
### Return type
- (empty response body)
+**string**
### Authorization
[DigestAuth](../README.md#Authentication)
@@ -92,7 +94,7 @@ Name | Type | Description | Notes
## GetInvoice
-> Invoice GetInvoice(ctx, orgId, invoiceId).Execute()
+> string GetInvoice(ctx, orgId, invoiceId).Execute()
Return One Organization Invoice
@@ -130,7 +132,7 @@ func main() {
apiError := admin.AsError(err)
fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError)
}
- // response from `GetInvoice`: Invoice
+ // response from `GetInvoice`: string
fmt.Fprintf(os.Stdout, "Response from `InvoicesApi.GetInvoice`: %v\n", resp)
}
```
@@ -156,7 +158,7 @@ Name | Type | Description | Notes
### Return type
-[**Invoice**](Invoice.md)
+**string**
### Authorization
[DigestAuth](../README.md#Authentication)
@@ -164,7 +166,7 @@ Name | Type | Description | Notes
### HTTP request headers
- **Content-Type**: Not defined
-- **Accept**: application/vnd.atlas.2023-01-01+json, application/json
+- **Accept**: application/vnd.atlas.2023-01-01+csv, application/vnd.atlas.2023-01-01+json, application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
diff --git a/docs/docs/LDAPConfigurationApi.md b/docs/docs/LDAPConfigurationApi.md
index 7e8354a1..46158813 100644
--- a/docs/docs/LDAPConfigurationApi.md
+++ b/docs/docs/LDAPConfigurationApi.md
@@ -14,7 +14,7 @@ Method | HTTP request | Description
## DeleteLDAPConfiguration
-> DeleteLDAPConfiguration(ctx, groupId).Execute()
+> UserSecurity DeleteLDAPConfiguration(ctx, groupId).Execute()
Remove the Current LDAP User to DN Mapping
@@ -45,12 +45,14 @@ func main() {
groupId := "32b6e34b3d91647abb20e7b8" // string |
- r, err := sdk.LDAPConfigurationApi.DeleteLDAPConfiguration(context.Background(), groupId).Execute()
+ resp, r, err := sdk.LDAPConfigurationApi.DeleteLDAPConfiguration(context.Background(), groupId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `LDAPConfigurationApi.DeleteLDAPConfiguration``: %v\n", err)
apiError := admin.AsError(err)
fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError)
}
+ // response from `DeleteLDAPConfiguration`: UserSecurity
+ fmt.Fprintf(os.Stdout, "Response from `LDAPConfigurationApi.DeleteLDAPConfiguration`: %v\n", resp)
}
```
@@ -73,7 +75,7 @@ Name | Type | Description | Notes
### Return type
- (empty response body)
+[**UserSecurity**](UserSecurity.md)
### Authorization
[DigestAuth](../README.md#Authentication)
diff --git a/docs/docs/LegacyClusterDescription.md b/docs/docs/LegacyClusterDescription.md
index 8dfe58db..f5782339 100644
--- a/docs/docs/LegacyClusterDescription.md
+++ b/docs/docs/LegacyClusterDescription.md
@@ -33,7 +33,7 @@ Name | Type | Description | Notes
**RootCertType** | Pointer to **string** | Root Certificate Authority that MongoDB Atlas clusters uses. MongoDB Cloud supports Internet Security Research Group. | [optional] [default to "ISRGROOTX1"]
**SrvAddress** | Pointer to **string** | Connection string that you can use to connect to the cluster. The `+srv` modifier forces the connection to use Transport Layer Security (TLS). The `mongoURI` parameter lists additional options. | [optional] [readonly]
**StateName** | Pointer to **string** | Human-readable label that indicates the current operating condition of the cluster. | [optional] [readonly]
-**Tags** | Pointer to [**[]Tag**](Tag.md) | Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. | [optional]
+**Tags** | Pointer to [**[]Tag**](Tag.md) | List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. | [optional]
**TerminationProtectionEnabled** | Pointer to **bool** | Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster. | [optional] [default to false]
**VersionReleaseSystem** | Pointer to **string** | Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**. | [optional] [default to "LTS"]
diff --git a/docs/docs/MaintenanceWindowsApi.md b/docs/docs/MaintenanceWindowsApi.md
index 32adc98a..10ffe17a 100644
--- a/docs/docs/MaintenanceWindowsApi.md
+++ b/docs/docs/MaintenanceWindowsApi.md
@@ -158,7 +158,7 @@ Name | Type | Description | Notes
## ResetMaintenanceWindow
-> map[string]interface{} ResetMaintenanceWindow(ctx, groupId).Execute()
+> ResetMaintenanceWindow(ctx, groupId).Execute()
Reset One Maintenance Window for One Project
@@ -184,14 +184,12 @@ func main() {
groupId := "32b6e34b3d91647abb20e7b8" // string |
- resp, r, err := sdk.MaintenanceWindowsApi.ResetMaintenanceWindow(context.Background(), groupId).Execute()
+ r, err := sdk.MaintenanceWindowsApi.ResetMaintenanceWindow(context.Background(), groupId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `MaintenanceWindowsApi.ResetMaintenanceWindow``: %v\n", err)
apiError := admin.AsError(err)
fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError)
}
- // response from `ResetMaintenanceWindow`: map[string]interface{}
- fmt.Fprintf(os.Stdout, "Response from `MaintenanceWindowsApi.ResetMaintenanceWindow`: %v\n", resp)
}
```
@@ -214,7 +212,7 @@ Name | Type | Description | Notes
### Return type
-**map[string]interface{}**
+ (empty response body)
### Authorization
[DigestAuth](../README.md#Authentication)
diff --git a/docs/docs/MonitoringAndLogsApi.md b/docs/docs/MonitoringAndLogsApi.md
index e2b58e87..05a98375 100644
--- a/docs/docs/MonitoringAndLogsApi.md
+++ b/docs/docs/MonitoringAndLogsApi.md
@@ -8,7 +8,7 @@ Method | HTTP request | Description
[**GetDatabase**](MonitoringAndLogsApi.md#GetDatabase) | **Get** /api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName} | Return One Database for a MongoDB Process
[**GetDatabaseMeasurements**](MonitoringAndLogsApi.md#GetDatabaseMeasurements) | **Get** /api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements | Return Measurements of One Database for One MongoDB Process
[**GetDiskMeasurements**](MonitoringAndLogsApi.md#GetDiskMeasurements) | **Get** /api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements | Return Measurements of One Disk for One MongoDB Process
-[**GetHostLogs**](MonitoringAndLogsApi.md#GetHostLogs) | **Get** /api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz | Download Logs for One Multi-Cloud Cluster Host in One Project
+[**GetHostLogs**](MonitoringAndLogsApi.md#GetHostLogs) | **Get** /api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz | Download Logs for One Cluster Host in One Project
[**GetHostMeasurements**](MonitoringAndLogsApi.md#GetHostMeasurements) | **Get** /api/atlas/v2/groups/{groupId}/processes/{processId}/measurements | Return Measurements for One MongoDB Process
[**GetIndexMetrics**](MonitoringAndLogsApi.md#GetIndexMetrics) | **Get** /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements | Return Atlas Search Metrics for One Index in One Specified Namespace
[**GetMeasurements**](MonitoringAndLogsApi.md#GetMeasurements) | **Get** /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements | Return Atlas Search Hardware and Status Metrics
@@ -363,7 +363,7 @@ Name | Type | Description | Notes
> *os.File GetHostLogs(ctx, groupId, hostName, logName).EndDate(endDate).StartDate(startDate).Execute()
-Download Logs for One Multi-Cloud Cluster Host in One Project
+Download Logs for One Cluster Host in One Project
### Example
@@ -409,8 +409,8 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**groupId** | **string** | 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. |
-**hostName** | **string** | Fully qualified domain name or IP address of the MongoDB host that stores the log files that you want to download. |
-**logName** | **string** | Human-readable label of the log file that you want to return. You can return audit logs only if you enable Database Auditing for the specified project. |
+**hostName** | **string** | Human-readable label that identifies the host that stores the log files that you want to download. |
+**logName** | **string** | Human-readable label that identifies the log file that you want to return. To return audit logs, enable *Database Auditing* for the specified project. |
### Other Parameters
diff --git a/docs/docs/MultiCloudClustersApi.md b/docs/docs/MultiCloudClustersApi.md
index 99e4392e..7609da9e 100644
--- a/docs/docs/MultiCloudClustersApi.md
+++ b/docs/docs/MultiCloudClustersApi.md
@@ -7,7 +7,7 @@ Method | HTTP request | Description
[**CreateCluster**](MultiCloudClustersApi.md#CreateCluster) | **Post** /api/atlas/v2/groups/{groupId}/clusters | Create One Multi-Cloud Cluster from One Project
[**DeleteCluster**](MultiCloudClustersApi.md#DeleteCluster) | **Delete** /api/atlas/v2/groups/{groupId}/clusters/{clusterName} | Remove One Multi-Cloud Cluster from One Project
[**GetCluster**](MultiCloudClustersApi.md#GetCluster) | **Get** /api/atlas/v2/groups/{groupId}/clusters/{clusterName} | Return One Multi-Cloud Cluster from One Project
-[**ListClusters**](MultiCloudClustersApi.md#ListClusters) | **Get** /api/atlas/v2/groups/{groupId}/clusters | Return All Multi-Cloud Clusters from One Project
+[**ListClusters**](MultiCloudClustersApi.md#ListClusters) | **Get** /api/atlas/v2/groups/{groupId}/clusters | Return All Clusters in One Project
[**TestFailover**](MultiCloudClustersApi.md#TestFailover) | **Post** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries | Test Failover for One Multi-Cloud Cluster
[**UpdateCluster**](MultiCloudClustersApi.md#UpdateCluster) | **Patch** /api/atlas/v2/groups/{groupId}/clusters/{clusterName} | Modify One Multi-Cloud Cluster from One Project
@@ -244,7 +244,7 @@ Name | Type | Description | Notes
> PaginatedClusterDescriptionV15 ListClusters(ctx, groupId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute()
-Return All Multi-Cloud Clusters from One Project
+Return All Clusters in One Project
### Example
@@ -441,7 +441,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**groupId** | **string** | 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. |
-**clusterName** | **string** | Human-readable label that identifies the advanced cluster to modify. |
+**clusterName** | **string** | Human-readable label that identifies the cluster. |
### Other Parameters
diff --git a/docs/docs/NotificationViewForNdsGroup.md b/docs/docs/NotificationViewForNdsGroup.md
index 3f08d3d3..caeaea9e 100644
--- a/docs/docs/NotificationViewForNdsGroup.md
+++ b/docs/docs/NotificationViewForNdsGroup.md
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
**DatadogRegion** | Pointer to **string** | Datadog region that indicates which API Uniform Resource Locator (URL) to use. The resource requires this parameter when `\"notifications.[n].typeName\" : \"DATADOG\"`. To learn more about Datadog's regions, see <a href=\"https://docs.datadoghq.com/getting_started/site/\" target=\"_blank\" rel=\"noopener noreferrer\">Datadog Sites</a>. | [optional] [default to "US"]
**DelayMin** | Pointer to **int** | Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. | [optional]
**IntervalMin** | Pointer to **int** | Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert. PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services. | [optional]
+**NotifierId** | Pointer to **string** | The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials. | [optional]
**TypeName** | Pointer to **string** | Human-readable label that displays the alert notification type. | [optional]
**EmailAddress** | Pointer to **string** | Email address to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"EMAIL\"`. You don’t need to set this value to send emails to individual or groups of MongoDB Cloud users including: - specific MongoDB Cloud users (`\"notifications.[n].typeName\" : \"USER\"`) - MongoDB Cloud users with specific project roles (`\"notifications.[n].typeName\" : \"GROUP\"`) - MongoDB Cloud users with specific organization roles (`\"notifications.[n].typeName\" : \"ORG\"`) - MongoDB Cloud teams (`\"notifications.[n].typeName\" : \"TEAM\"`) To send emails to one MongoDB Cloud user or grouping of users, set the `notifications.[n].emailEnabled` parameter. | [optional]
**EmailEnabled** | Pointer to **bool** | Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set: - `\"notifications.[n].typeName\" : \"ORG\"` - `\"notifications.[n].typeName\" : \"GROUP\"` - `\"notifications.[n].typeName\" : \"USER\"` | [optional]
@@ -150,6 +151,31 @@ SetIntervalMin sets IntervalMin field to given value.
HasIntervalMin returns a boolean if a field has been set.
+### GetNotifierId
+
+`func (o *NotificationViewForNdsGroup) GetNotifierId() string`
+
+GetNotifierId returns the NotifierId field if non-nil, zero value otherwise.
+
+### GetNotifierIdOk
+
+`func (o *NotificationViewForNdsGroup) GetNotifierIdOk() (*string, bool)`
+
+GetNotifierIdOk returns a tuple with the NotifierId field if it's non-nil, zero value otherwise
+and a boolean to check if the value has been set.
+
+### SetNotifierId
+
+`func (o *NotificationViewForNdsGroup) SetNotifierId(v string)`
+
+SetNotifierId sets NotifierId field to given value.
+
+### HasNotifierId
+
+`func (o *NotificationViewForNdsGroup) HasNotifierId() bool`
+
+HasNotifierId returns a boolean if a field has been set.
+
### GetTypeName
`func (o *NotificationViewForNdsGroup) GetTypeName() string`
diff --git a/docs/docs/OrganizationsApi.md b/docs/docs/OrganizationsApi.md
index 89960133..a4503df1 100644
--- a/docs/docs/OrganizationsApi.md
+++ b/docs/docs/OrganizationsApi.md
@@ -15,6 +15,7 @@ Method | HTTP request | Description
[**ListOrganizationProjects**](OrganizationsApi.md#ListOrganizationProjects) | **Get** /api/atlas/v2/orgs/{orgId}/groups | Return One or More Projects in One Organization
[**ListOrganizationUsers**](OrganizationsApi.md#ListOrganizationUsers) | **Get** /api/atlas/v2/orgs/{orgId}/users | Return All MongoDB Cloud Users in One Organization
[**ListOrganizations**](OrganizationsApi.md#ListOrganizations) | **Get** /api/atlas/v2/orgs | Return All Organizations
+[**RemoveOrganizationUser**](OrganizationsApi.md#RemoveOrganizationUser) | **Delete** /api/atlas/v2/orgs/{orgId}/users/{userId} | Remove One MongoDB Cloud User from One Organization
[**RenameOrganization**](OrganizationsApi.md#RenameOrganization) | **Patch** /api/atlas/v2/orgs/{orgId} | Rename One Organization
[**UpdateOrganizationInvitation**](OrganizationsApi.md#UpdateOrganizationInvitation) | **Patch** /api/atlas/v2/orgs/{orgId}/invites | Update One Organization Invitation
[**UpdateOrganizationInvitationById**](OrganizationsApi.md#UpdateOrganizationInvitationById) | **Patch** /api/atlas/v2/orgs/{orgId}/invites/{invitationId} | Update One Organization Invitation by Invitation ID
@@ -852,6 +853,87 @@ Name | Type | Description | Notes
[[Back to README]](../README.md)
+## RemoveOrganizationUser
+
+> map[string]interface{} RemoveOrganizationUser(ctx, orgId, userId).Execute()
+
+Remove One MongoDB Cloud User from One Organization
+
+
+## Experimental
+
+This operation is marked as experimental. It might be changed in the future without compatibility guarantees.
+For more information see [ExperimentalMethods](../doc_1_concepts.md#experimental-methods)
+
+### Example
+
+```go
+package main
+
+import (
+ "context"
+ "fmt"
+ "os"
+
+ "go.mongodb.org/atlas-sdk/admin"
+)
+
+func main() {
+ apiKey := os.Getenv("MONGODB_ATLAS_PUBLIC_KEY")
+ apiSecret := os.Getenv("MONGODB_ATLAS_PRIVATE_KEY")
+
+ sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret))
+
+ orgId := "4888442a3354817a7320eb61" // string |
+ userId := "userId_example" // string |
+
+ resp, r, err := sdk.OrganizationsApi.RemoveOrganizationUser(context.Background(), orgId, userId).Execute()
+ if err != nil {
+ fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsApi.RemoveOrganizationUser``: %v\n", err)
+ apiError := admin.AsError(err)
+ fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError)
+ }
+ // response from `RemoveOrganizationUser`: map[string]interface{}
+ fmt.Fprintf(os.Stdout, "Response from `OrganizationsApi.RemoveOrganizationUser`: %v\n", resp)
+}
+```
+
+### Path Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
+**orgId** | **string** | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. |
+**userId** | **string** | Unique 24-hexadecimal digit string that identifies the user to be deleted. |
+
+### Other Parameters
+
+Other parameters are passed through a pointer to a apiRemoveOrganizationUserRequest struct via the builder pattern
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+
+
+
+### Return type
+
+**map[string]interface{}**
+
+### Authorization
+[DigestAuth](../README.md#Authentication)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.atlas.2023-01-01+json, application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
+[[Back to Model list]](../README.md#documentation-for-models)
+[[Back to README]](../README.md)
+
+
## RenameOrganization
> Organization RenameOrganization(ctx, orgId, organization Organization).Execute()
diff --git a/docs/docs/ProgrammaticAPIKeysApi.md b/docs/docs/ProgrammaticAPIKeysApi.md
index 1aa147cd..e5c31529 100644
--- a/docs/docs/ProgrammaticAPIKeysApi.md
+++ b/docs/docs/ProgrammaticAPIKeysApi.md
@@ -106,7 +106,7 @@ Name | Type | Description | Notes
## CreateApiKey
-> ApiUser CreateApiKey(ctx, orgId, createApiKey CreateApiKey).Execute()
+> ApiUser CreateApiKey(ctx, orgId, createOrganizationApiKey CreateOrganizationApiKey).Execute()
Create One Organization API Key
@@ -131,9 +131,9 @@ func main() {
sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret))
orgId := "4888442a3354817a7320eb61" // string |
- createApiKey := *openapiclient.NewCreateApiKey() // CreateApiKey |
+ createOrganizationApiKey := *openapiclient.NewCreateOrganizationApiKey() // CreateOrganizationApiKey |
- resp, r, err := sdk.ProgrammaticAPIKeysApi.CreateApiKey(context.Background(), orgId, &createApiKey).Execute()
+ resp, r, err := sdk.ProgrammaticAPIKeysApi.CreateApiKey(context.Background(), orgId, &createOrganizationApiKey).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProgrammaticAPIKeysApi.CreateApiKey``: %v\n", err)
apiError := admin.AsError(err)
@@ -160,7 +160,7 @@ Other parameters are passed through a pointer to a apiCreateApiKeyRequest struct
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **createApiKey** | [**CreateApiKey**](CreateApiKey.md) | Organization API Key to be created. This request requires both body parameters. |
+ **createOrganizationApiKey** | [**CreateOrganizationApiKey**](CreateOrganizationApiKey.md) | Organization API Key to be created. This request requires both body parameters. |
### Return type
@@ -265,7 +265,7 @@ Name | Type | Description | Notes
## CreateProjectApiKey
-> ApiUser CreateProjectApiKey(ctx, groupId, createApiKey CreateApiKey).Execute()
+> ApiUser CreateProjectApiKey(ctx, groupId, createProjectApiKey CreateProjectApiKey).Execute()
Create and Assign One Organization API Key to One Project
@@ -290,9 +290,9 @@ func main() {
sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret))
groupId := "32b6e34b3d91647abb20e7b8" // string |
- createApiKey := *openapiclient.NewCreateApiKey() // CreateApiKey |
+ createProjectApiKey := *openapiclient.NewCreateProjectApiKey() // CreateProjectApiKey |
- resp, r, err := sdk.ProgrammaticAPIKeysApi.CreateProjectApiKey(context.Background(), groupId, &createApiKey).Execute()
+ resp, r, err := sdk.ProgrammaticAPIKeysApi.CreateProjectApiKey(context.Background(), groupId, &createProjectApiKey).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProgrammaticAPIKeysApi.CreateProjectApiKey``: %v\n", err)
apiError := admin.AsError(err)
@@ -319,7 +319,7 @@ Other parameters are passed through a pointer to a apiCreateProjectApiKeyRequest
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **createApiKey** | [**CreateApiKey**](CreateApiKey.md) | Organization API key to be created and assigned to the specified project. This request requires both body parameters. |
+ **createProjectApiKey** | [**CreateProjectApiKey**](CreateProjectApiKey.md) | Organization API key to be created and assigned to the specified project. This request requires both body parameters. |
### Return type
@@ -971,7 +971,7 @@ Name | Type | Description | Notes
## UpdateApiKey
-> ApiUser UpdateApiKey(ctx, orgId, apiUserId, createApiKey CreateApiKey).Execute()
+> ApiUser UpdateApiKey(ctx, orgId, apiUserId, createOrganizationApiKey CreateOrganizationApiKey).Execute()
Update One Organization API Key
@@ -997,9 +997,9 @@ func main() {
orgId := "4888442a3354817a7320eb61" // string |
apiUserId := "apiUserId_example" // string |
- createApiKey := *openapiclient.NewCreateApiKey() // CreateApiKey |
+ createOrganizationApiKey := *openapiclient.NewCreateOrganizationApiKey() // CreateOrganizationApiKey |
- resp, r, err := sdk.ProgrammaticAPIKeysApi.UpdateApiKey(context.Background(), orgId, apiUserId, &createApiKey).Execute()
+ resp, r, err := sdk.ProgrammaticAPIKeysApi.UpdateApiKey(context.Background(), orgId, apiUserId, &createOrganizationApiKey).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProgrammaticAPIKeysApi.UpdateApiKey``: %v\n", err)
apiError := admin.AsError(err)
@@ -1028,7 +1028,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **createApiKey** | [**CreateApiKey**](CreateApiKey.md) | Organization API key to be updated. This request requires a minimum of one of the two body parameters. |
+ **createOrganizationApiKey** | [**CreateOrganizationApiKey**](CreateOrganizationApiKey.md) | Organization API key to be updated. This request requires a minimum of one of the two body parameters. |
### Return type
@@ -1049,7 +1049,7 @@ Name | Type | Description | Notes
## UpdateApiKeyRoles
-> ApiUser UpdateApiKeyRoles(ctx, groupId, apiUserId, createApiKey CreateApiKey).PageNum(pageNum).ItemsPerPage(itemsPerPage).IncludeCount(includeCount).Execute()
+> ApiUser UpdateApiKeyRoles(ctx, groupId, apiUserId, createProjectApiKey CreateProjectApiKey).PageNum(pageNum).ItemsPerPage(itemsPerPage).IncludeCount(includeCount).Execute()
Update Roles of One Organization API Key to One Project
@@ -1075,12 +1075,12 @@ func main() {
groupId := "32b6e34b3d91647abb20e7b8" // string |
apiUserId := "apiUserId_example" // string |
- createApiKey := *openapiclient.NewCreateApiKey() // CreateApiKey |
+ createProjectApiKey := *openapiclient.NewCreateProjectApiKey() // CreateProjectApiKey |
pageNum := int(1) // int | (optional) (default to 1)
itemsPerPage := int(100) // int | (optional) (default to 100)
includeCount := true // bool | (optional) (default to true)
- resp, r, err := sdk.ProgrammaticAPIKeysApi.UpdateApiKeyRoles(context.Background(), groupId, apiUserId, &createApiKey).PageNum(pageNum).ItemsPerPage(itemsPerPage).IncludeCount(includeCount).Execute()
+ resp, r, err := sdk.ProgrammaticAPIKeysApi.UpdateApiKeyRoles(context.Background(), groupId, apiUserId, &createProjectApiKey).PageNum(pageNum).ItemsPerPage(itemsPerPage).IncludeCount(includeCount).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProgrammaticAPIKeysApi.UpdateApiKeyRoles``: %v\n", err)
apiError := admin.AsError(err)
@@ -1109,7 +1109,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **createApiKey** | [**CreateApiKey**](CreateApiKey.md) | Organization API Key to be updated. This request requires a minimum of one of the two body parameters. |
+ **createProjectApiKey** | [**CreateProjectApiKey**](CreateProjectApiKey.md) | Organization API Key to be updated. This request requires a minimum of one of the two body parameters. |
**pageNum** | **int** | Number of the page that displays the current set of the total objects that the response returns. | [default to 1]
**itemsPerPage** | **int** | Number of items that the response returns per page. | [default to 100]
**includeCount** | **bool** | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. | [default to true]
diff --git a/docs/docs/ProjectsApi.md b/docs/docs/ProjectsApi.md
index b301b3cf..e3282ff3 100644
--- a/docs/docs/ProjectsApi.md
+++ b/docs/docs/ProjectsApi.md
@@ -856,7 +856,7 @@ Name | Type | Description | Notes
## ListProjectLimits
-> Limit ListProjectLimits(ctx, groupId).Execute()
+> []Limit ListProjectLimits(ctx, groupId).Execute()
Return All Limits for One Project
@@ -893,7 +893,7 @@ func main() {
apiError := admin.AsError(err)
fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError)
}
- // response from `ListProjectLimits`: Limit
+ // response from `ListProjectLimits`: []Limit
fmt.Fprintf(os.Stdout, "Response from `ProjectsApi.ListProjectLimits`: %v\n", resp)
}
```
@@ -917,7 +917,7 @@ Name | Type | Description | Notes
### Return type
-[**Limit**](Limit.md)
+[**[]Limit**](Limit.md)
### Authorization
[DigestAuth](../README.md#Authentication)
diff --git a/docs/docs/ServerlessInstanceDescription.md b/docs/docs/ServerlessInstanceDescription.md
index cfe54afd..d49cc691 100644
--- a/docs/docs/ServerlessInstanceDescription.md
+++ b/docs/docs/ServerlessInstanceDescription.md
@@ -14,7 +14,7 @@ Name | Type | Description | Notes
**ProviderSettings** | [**ServerlessProviderSettings**](ServerlessProviderSettings.md) | |
**ServerlessBackupOptions** | Pointer to [**ServerlessBackupOptions**](ServerlessBackupOptions.md) | | [optional]
**StateName** | Pointer to **string** | Human-readable label that indicates the current operating condition of the serverless instance. | [optional] [readonly]
-**Tags** | Pointer to [**[]Tag**](Tag.md) | | [optional]
+**Tags** | Pointer to [**[]Tag**](Tag.md) | List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance. | [optional]
**TerminationProtectionEnabled** | Pointer to **bool** | Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance. | [optional] [default to false]
## Methods
diff --git a/docs/docs/ServerlessInstanceDescriptionCreate.md b/docs/docs/ServerlessInstanceDescriptionCreate.md
index 2e51915e..10542ce3 100644
--- a/docs/docs/ServerlessInstanceDescriptionCreate.md
+++ b/docs/docs/ServerlessInstanceDescriptionCreate.md
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
**ProviderSettings** | [**ServerlessProviderSettings**](ServerlessProviderSettings.md) | |
**ServerlessBackupOptions** | Pointer to [**ServerlessBackupOptions**](ServerlessBackupOptions.md) | | [optional]
**StateName** | Pointer to **string** | Human-readable label that indicates the current operating condition of the serverless instance. | [optional] [readonly]
+**Tags** | Pointer to [**[]Tag**](Tag.md) | List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance. | [optional]
**TerminationProtectionEnabled** | Pointer to **bool** | Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance. | [optional] [default to false]
## Methods
@@ -119,6 +120,31 @@ SetStateName sets StateName field to given value.
HasStateName returns a boolean if a field has been set.
+### GetTags
+
+`func (o *ServerlessInstanceDescriptionCreate) GetTags() []Tag`
+
+GetTags returns the Tags field if non-nil, zero value otherwise.
+
+### GetTagsOk
+
+`func (o *ServerlessInstanceDescriptionCreate) GetTagsOk() (*[]Tag, bool)`
+
+GetTagsOk returns a tuple with the Tags field if it's non-nil, zero value otherwise
+and a boolean to check if the value has been set.
+
+### SetTags
+
+`func (o *ServerlessInstanceDescriptionCreate) SetTags(v []Tag)`
+
+SetTags sets Tags field to given value.
+
+### HasTags
+
+`func (o *ServerlessInstanceDescriptionCreate) HasTags() bool`
+
+HasTags returns a boolean if a field has been set.
+
### GetTerminationProtectionEnabled
`func (o *ServerlessInstanceDescriptionCreate) GetTerminationProtectionEnabled() bool`
diff --git a/docs/docs/ServerlessInstanceDescriptionUpdate.md b/docs/docs/ServerlessInstanceDescriptionUpdate.md
index 4c7fa582..a89b323d 100644
--- a/docs/docs/ServerlessInstanceDescriptionUpdate.md
+++ b/docs/docs/ServerlessInstanceDescriptionUpdate.md
@@ -5,6 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ServerlessBackupOptions** | Pointer to [**ServerlessBackupOptions**](ServerlessBackupOptions.md) | | [optional]
+**Tags** | Pointer to [**[]Tag**](Tag.md) | List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance. | [optional]
**TerminationProtectionEnabled** | Pointer to **bool** | Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance. | [optional] [default to false]
## Methods
@@ -51,6 +52,31 @@ SetServerlessBackupOptions sets ServerlessBackupOptions field to given value.
HasServerlessBackupOptions returns a boolean if a field has been set.
+### GetTags
+
+`func (o *ServerlessInstanceDescriptionUpdate) GetTags() []Tag`
+
+GetTags returns the Tags field if non-nil, zero value otherwise.
+
+### GetTagsOk
+
+`func (o *ServerlessInstanceDescriptionUpdate) GetTagsOk() (*[]Tag, bool)`
+
+GetTagsOk returns a tuple with the Tags field if it's non-nil, zero value otherwise
+and a boolean to check if the value has been set.
+
+### SetTags
+
+`func (o *ServerlessInstanceDescriptionUpdate) SetTags(v []Tag)`
+
+SetTags sets Tags field to given value.
+
+### HasTags
+
+`func (o *ServerlessInstanceDescriptionUpdate) HasTags() bool`
+
+HasTags returns a boolean if a field has been set.
+
### GetTerminationProtectionEnabled
`func (o *ServerlessInstanceDescriptionUpdate) GetTerminationProtectionEnabled() bool`
diff --git a/docs/docs/Tag.md b/docs/docs/Tag.md
index 2da91fe3..b85087f7 100644
--- a/docs/docs/Tag.md
+++ b/docs/docs/Tag.md
@@ -4,8 +4,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**Key** | Pointer to **string** | Key applied to the tag. | [optional]
-**Value** | Pointer to **string** | Value applied to the tag. | [optional]
+**Key** | Pointer to **string** | Constant that defines the set of the tag. For example, `environment` in the `environment : production` tag. | [optional]
+**Value** | Pointer to **string** | Variable that belongs to the set of the tag. For example, `production` in the `environment : production` tag. | [optional]
## Methods
diff --git a/docs/docs/TeamsApi.md b/docs/docs/TeamsApi.md
index f7e96827..c6f007aa 100644
--- a/docs/docs/TeamsApi.md
+++ b/docs/docs/TeamsApi.md
@@ -716,7 +716,7 @@ Name | Type | Description | Notes
## RemoveProjectTeam
-> map[string]interface{} RemoveProjectTeam(ctx, groupId, teamId).Execute()
+> RemoveProjectTeam(ctx, groupId, teamId).Execute()
Remove One Team from One Project
@@ -743,14 +743,12 @@ func main() {
groupId := "32b6e34b3d91647abb20e7b8" // string |
teamId := "teamId_example" // string |
- resp, r, err := sdk.TeamsApi.RemoveProjectTeam(context.Background(), groupId, teamId).Execute()
+ r, err := sdk.TeamsApi.RemoveProjectTeam(context.Background(), groupId, teamId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TeamsApi.RemoveProjectTeam``: %v\n", err)
apiError := admin.AsError(err)
fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError)
}
- // response from `RemoveProjectTeam`: map[string]interface{}
- fmt.Fprintf(os.Stdout, "Response from `TeamsApi.RemoveProjectTeam`: %v\n", resp)
}
```
@@ -775,7 +773,7 @@ Name | Type | Description | Notes
### Return type
-**map[string]interface{}**
+ (empty response body)
### Authorization
[DigestAuth](../README.md#Authentication)
diff --git a/docs/docs/TestApi.md b/docs/docs/TestApi.md
deleted file mode 100644
index 7926c7c2..00000000
--- a/docs/docs/TestApi.md
+++ /dev/null
@@ -1,83 +0,0 @@
-# \TestApi
-
-All URIs are relative to *https://cloud.mongodb.com*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**VersionedExample**](TestApi.md#VersionedExample) | **Get** /api/atlas/v2/example/info | Example resource info for versioning of the Atlas API
-
-
-
-## VersionedExample
-
-> ExampleResourceResponseView20230201 VersionedExample(ctx).AdditionalInfo(additionalInfo).Execute()
-
-Example resource info for versioning of the Atlas API
-
-
-## Experimental
-
-This operation is marked as experimental. It might be changed in the future without compatibility guarantees.
-For more information see [ExperimentalMethods](../doc_1_concepts.md#experimental-methods)
-
-### Example
-
-```go
-package main
-
-import (
- "context"
- "fmt"
- "os"
-
- "go.mongodb.org/atlas-sdk/admin"
-)
-
-func main() {
- apiKey := os.Getenv("MONGODB_ATLAS_PUBLIC_KEY")
- apiSecret := os.Getenv("MONGODB_ATLAS_PRIVATE_KEY")
-
- sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret))
-
- additionalInfo := true // bool | (optional) (default to false)
-
- resp, r, err := sdk.TestApi.VersionedExample(context.Background()).AdditionalInfo(additionalInfo).Execute()
- if err != nil {
- fmt.Fprintf(os.Stderr, "Error when calling `TestApi.VersionedExample``: %v\n", err)
- apiError := admin.AsError(err)
- fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError)
- }
- // response from `VersionedExample`: ExampleResourceResponseView20230201
- fmt.Fprintf(os.Stdout, "Response from `TestApi.VersionedExample`: %v\n", resp)
-}
-```
-
-### Path Parameters
-
-
-
-### Other Parameters
-
-Other parameters are passed through a pointer to a apiVersionedExampleRequest struct via the builder pattern
-
-
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
- **additionalInfo** | **bool** | | [default to false]
-
-### Return type
-
-[**ExampleResourceResponseView20230201**](ExampleResourceResponseView20230201.md)
-
-### Authorization
-[DigestAuth](../README.md#Authentication)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/vnd.atlas.2023-02-01+json, application/json
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
-[[Back to Model list]](../README.md#documentation-for-models)
-[[Back to README]](../README.md)
-
diff --git a/openapi/atlas-api-transformed.yaml b/openapi/atlas-api-transformed.yaml
index abdf5c76..ca1b5d75 100644
--- a/openapi/atlas-api-transformed.yaml
+++ b/openapi/atlas-api-transformed.yaml
@@ -8,7 +8,13 @@ info:
The Atlas Administration API uses HTTP Digest Authentication to authenticate requests. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request. For example, to [return database access history](#tag/Access-Tracking/operation/listAccessLogsByClusterName) with [cURL](https://en.wikipedia.org/wiki/CURL), run the following command in the terminal:
- `curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest "https://cloud.mongodb.com/api/atlas/v2.0/groups/{groupId}/dbAccessHistory/clusters/{clusterName}"`
+ ```
+
+ curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \
+ --digest \
+ --header "Accept: application/vnd.atlas.2023-02-01+json" \
+ GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true"
+ ```
To learn more, see [Get Started with the Atlas Administration API](https://www.mongodb.com/docs/atlas/configure-api-access/). For support, see [MongoDB Support](https://www.mongodb.com/support/get-started).
@@ -17,8 +23,8 @@ info:
url: https://creativecommons.org/licenses/by-nc-sa/3.0/us/
termsOfService: https://www.mongodb.com/mongodb-management-service-terms-and-conditions
title: MongoDB Atlas Administration API
- version: 2.0~b0d2861b4b
- x-xgen-sha: b0d2861b4bfc9f349f9e26e3ed2d70c43c950779
+ version: 2.0~1056ca6d98
+ x-xgen-sha: 1056ca6d981acf30dfc69b4c7a2a67a43a2939fe
servers:
- url: https://cloud.mongodb.com
tags:
@@ -201,8 +207,6 @@ tags:
name: Shared-Tier Snapshots
- description: Returns, adds, edits, or removes teams.
name: Teams
- - description: Atlas test endpoints.
- name: Test
- description: >-
Returns, adds, edits, and removes third-party service integration
configurations. MongoDB Cloud sends alerts to each third-party service
@@ -306,35 +310,6 @@ paths:
tags:
- Clusters
x-xgen-experimental: true
- /api/atlas/v2/example/info:
- get:
- description: "Returns some text dummy data for test purposes. Deprecated
- versions: v2-{2023-01-01}"
- operationId: versionedExample
- parameters:
- - in: query
- name: additionalInfo
- schema:
- type: boolean
- default: false
- responses:
- "200":
- content:
- application/vnd.atlas.2023-02-01+json:
- schema:
- $ref: "#/components/schemas/ExampleResourceResponseView20230201"
- x-xgen-version: 2023-02-01
- description: OK
- "401":
- $ref: "#/components/responses/unauthorized"
- "500":
- $ref: "#/components/responses/internalServerError"
- security:
- - DigestAuth: []
- summary: Example resource info for versioning of the Atlas API
- tags:
- - Test
- x-xgen-experimental: true
"/api/atlas/v2/federationSettings/{federationSettingsId}":
delete:
description: "Deletes the federation settings instance and all associated data,
@@ -426,7 +401,7 @@ paths:
schema:
$ref: "#/components/schemas/noBody"
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"400":
$ref: "#/components/responses/badRequest"
"401":
@@ -1019,7 +994,7 @@ paths:
schema:
$ref: "#/components/schemas/noBody"
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"400":
$ref: "#/components/responses/badRequest"
"409":
@@ -1248,7 +1223,7 @@ paths:
schema:
$ref: "#/components/schemas/noBody"
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"403":
$ref: "#/components/responses/forbidden"
"404":
@@ -1913,7 +1888,7 @@ paths:
content:
application/vnd.atlas.2023-01-01+json:
schema:
- $ref: "#/components/schemas/CreateApiKey"
+ $ref: "#/components/schemas/CreateProjectApiKey"
description: Organization API key to be created and assigned to the specified
project. This request requires both body parameters.
required: true
@@ -1962,7 +1937,7 @@ paths:
schema:
$ref: "#/components/schemas/noBody"
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"400":
$ref: "#/components/responses/badRequest"
"401":
@@ -2000,7 +1975,7 @@ paths:
content:
application/vnd.atlas.2023-01-01+json:
schema:
- $ref: "#/components/schemas/CreateApiKey"
+ $ref: "#/components/schemas/CreateProjectApiKey"
description: Organization API Key to be updated. This request requires a minimum
of one of the two body parameters.
required: true
@@ -2288,7 +2263,7 @@ paths:
schema:
$ref: "#/components/schemas/noBody"
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"400":
$ref: "#/components/responses/badRequest"
"401":
@@ -2628,7 +2603,7 @@ paths:
$ref: "#/components/responses/internalServerError"
security:
- DigestAuth: []
- summary: Return All Multi-Cloud Clusters from One Project
+ summary: Return All Clusters in One Project
tags:
- Multi-Cloud Clusters
post:
@@ -2909,11 +2884,11 @@ paths:
schema:
type: boolean
responses:
- "204":
+ "202":
content:
application/vnd.atlas.2023-02-01+json:
x-xgen-version: 2023-02-01
- description: Endpoint does not return a response body.
+ description: Accepted
"400":
$ref: "#/components/responses/badRequest"
"401":
@@ -2958,6 +2933,10 @@ paths:
description: OK
"401":
$ref: "#/components/responses/unauthorized"
+ "404":
+ $ref: "#/components/responses/notFound"
+ "409":
+ $ref: "#/components/responses/conflict"
"500":
$ref: "#/components/responses/internalServerError"
security:
@@ -2980,7 +2959,7 @@ paths:
operationId: updateCluster
parameters:
- $ref: "#/components/parameters/groupId"
- - description: Human-readable label that identifies the advanced cluster to modify.
+ - description: Human-readable label that identifies the cluster.
in: path
name: clusterName
required: true
@@ -3270,7 +3249,7 @@ paths:
schema:
$ref: "#/components/schemas/noBody"
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"400":
$ref: "#/components/responses/badRequest"
"405":
@@ -3570,7 +3549,7 @@ paths:
schema:
$ref: "#/components/schemas/noBody"
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"404":
$ref: "#/components/responses/notFound"
"500":
@@ -3700,7 +3679,7 @@ paths:
schema:
$ref: "#/components/schemas/noBody"
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"400":
$ref: "#/components/responses/badRequest"
"404":
@@ -4327,7 +4306,7 @@ paths:
schema:
$ref: "#/components/schemas/noBody"
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"400":
$ref: "#/components/responses/badRequest"
"404":
@@ -4462,6 +4441,9 @@ paths:
requesting API Key must have the Project Read Only role. This resource
doesn't require the API Key to have an Access List. Deprecated versions:
v2-{2023-01-01}"
+ externalDocs:
+ description: Global Clusters
+ url: https://www.mongodb.com/docs/atlas/global-clusters/
operationId: getManagedNamespace
parameters:
- $ref: "#/components/parameters/groupId"
@@ -4482,6 +4464,8 @@ paths:
$ref: "#/components/schemas/GeoSharding"
x-xgen-version: 2023-02-01
description: OK
+ "401":
+ $ref: "#/components/responses/unauthorized"
"500":
$ref: "#/components/responses/internalServerError"
security:
@@ -4498,6 +4482,9 @@ paths:
the closest geographical zone. To use this resource, the requesting API
Key must have the Project Owner role. This resource doesn't require the
API Key to have an Access List. Deprecated versions: v2-{2023-01-01}"
+ externalDocs:
+ description: Global Clusters
+ url: https://www.mongodb.com/docs/atlas/global-clusters/
operationId: deleteAllCustomZoneMappings
parameters:
- $ref: "#/components/parameters/groupId"
@@ -4536,6 +4523,9 @@ paths:
API Key must have the Project Owner role. This resource doesn't require
the API Key to have an Access List. Deprecated versions:
v2-{2023-01-01}"
+ externalDocs:
+ description: Global Clusters
+ url: https://www.mongodb.com/docs/atlas/global-clusters/
operationId: createCustomZoneMapping
parameters:
- $ref: "#/components/parameters/groupId"
@@ -4565,6 +4555,8 @@ paths:
description: OK
"400":
$ref: "#/components/responses/badRequest"
+ "401":
+ $ref: "#/components/responses/unauthorized"
"500":
$ref: "#/components/responses/internalServerError"
security:
@@ -4582,6 +4574,9 @@ paths:
the requesting API Key must have the Project Data Access Admin role.
This resource doesn't require the API Key to have an Access List.
Deprecated versions: v2-{2023-01-01}"
+ externalDocs:
+ description: Global Clusters
+ url: https://www.mongodb.com/docs/atlas/global-clusters/
operationId: deleteManagedNamespace
parameters:
- description: Human-readable label that identifies this advanced cluster.
@@ -4616,6 +4611,8 @@ paths:
description: OK
"400":
$ref: "#/components/responses/badRequest"
+ "401":
+ $ref: "#/components/responses/unauthorized"
"500":
$ref: "#/components/responses/internalServerError"
security:
@@ -4631,6 +4628,9 @@ paths:
requesting API Key must have the Project Data Access Admin role. This
resource doesn't require the API Key to have an Access List. Deprecated
versions: v2-{2023-01-01}"
+ externalDocs:
+ description: Global Clusters
+ url: https://www.mongodb.com/docs/atlas/global-clusters/
operationId: createManagedNamespace
parameters:
- $ref: "#/components/parameters/groupId"
@@ -4660,6 +4660,8 @@ paths:
description: OK
"400":
$ref: "#/components/responses/badRequest"
+ "401":
+ $ref: "#/components/responses/unauthorized"
"405":
$ref: "#/components/responses/methodNotAllowed"
"500":
@@ -4703,11 +4705,11 @@ paths:
description: Rolling index to create on the specified cluster.
required: true
responses:
- "204":
+ "202":
content:
application/vnd.atlas.2023-01-01+json:
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: Accepted
"400":
$ref: "#/components/responses/badRequest"
"404":
@@ -4932,7 +4934,7 @@ paths:
schema:
$ref: "#/components/schemas/noBody"
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"401":
$ref: "#/components/responses/unauthorized"
"404":
@@ -5305,11 +5307,11 @@ paths:
minLength: 1
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
responses:
- "204":
+ "200":
content:
application/vnd.atlas.2023-02-01+json:
x-xgen-version: 2023-02-01
- description: Endpoint does not return a response body.
+ description: OK
"401":
$ref: "#/components/responses/unauthorized"
"500":
@@ -5676,7 +5678,7 @@ paths:
schema:
$ref: "#/components/schemas/noBody"
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"400":
$ref: "#/components/responses/badRequest"
"401":
@@ -5845,28 +5847,39 @@ paths:
"/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz":
get:
description: "Returns a compressed (.gz) log file that contains a range of log
- messages for the specified host for the specified project. To use this
- resource, the requesting API Key must have the Project Owner or Project
- Data Access Read Write roles. This resource doesn't require the API Key
- to have an Access List. Deprecated versions: v2-{2023-01-01}"
+ messages for the specified host for the specified project. MongoDB
+ updates process and audit logs from the cluster backend infrastructure
+ every five minutes and contain log data from the previous five minutes.
+ If you poll the API for log files, we recommend polling every five
+ minutes. For example, if the logs are updated at 4:00 UTC and then you
+ poll the API, the API returns log data from the interval between 3:55
+ UTC and 4:00 UTC. This feature isn't available for `M0` free clusters,
+ `M2`, `M5`, or serverless clusters. To use this resource, the requesting
+ API Key must have the Project Owner or Project Data Access Read/Write
+ roles. This resource doesn't require the API Key to have an Access List.
+ Deprecated versions: v2-{2023-01-01}"
operationId: getHostLogs
parameters:
- $ref: "#/components/parameters/groupId"
- - description: Fully qualified domain name or IP address of the MongoDB host that
- stores the log files that you want to download.
+ - description: Human-readable label that identifies the host that stores the log
+ files that you want to download.
in: path
name: hostName
required: true
schema:
type: string
- - description: Human-readable label of the log file that you want to return. You
- can return audit logs only if you enable Database Auditing for the
+ pattern: ^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\.){1,10}[a-z]+)?$
+ - description: Human-readable label that identifies the log file that you want to
+ return. To return audit logs, enable *Database Auditing* for the
specified project.
in: path
name: logName
required: true
schema:
type: string
+ externalDocs:
+ description: Set up Database Auditing
+ url: https://docs.atlas.mongodb.com/database-auditing/
- description: Date and time when the period specifies the inclusive ending point
for the range of log messages to retrieve. This parameter expresses
its value in the number of seconds that have elapsed since the UNIX
@@ -5912,7 +5925,7 @@ paths:
$ref: "#/components/responses/internalServerError"
security:
- DigestAuth: []
- summary: Download Logs for One Multi-Cloud Cluster Host in One Project
+ summary: Download Logs for One Cluster Host in One Project
tags:
- Monitoring and Logs
"/api/atlas/v2/groups/{groupId}/containers":
@@ -6056,7 +6069,7 @@ paths:
schema:
$ref: "#/components/schemas/noBody"
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"400":
$ref: "#/components/responses/badRequest"
"401":
@@ -6451,7 +6464,7 @@ paths:
schema:
$ref: "#/components/schemas/noBody"
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"404":
$ref: "#/components/responses/notFound"
"500":
@@ -6632,7 +6645,7 @@ paths:
schema:
$ref: "#/components/schemas/noBody"
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"400":
$ref: "#/components/responses/badRequest"
"500":
@@ -6684,9 +6697,7 @@ paths:
content:
application/vnd.atlas.2023-01-01+json:
schema:
- type: array
- items:
- $ref: "#/components/schemas/DataFederationTenantQueryLimit"
+ $ref: "#/components/schemas/DataFederationTenantQueryLimit"
x-xgen-version: 2023-01-01
description: OK
"401":
@@ -6747,9 +6758,7 @@ paths:
content:
application/vnd.atlas.2023-01-01+json:
schema:
- type: array
- items:
- $ref: "#/components/schemas/DataFederationTenantQueryLimit"
+ $ref: "#/components/schemas/DataFederationTenantQueryLimit"
x-xgen-version: 2023-01-01
description: OK
"400":
@@ -6966,8 +6975,8 @@ paths:
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, or LDAP, this value should
- be `$external`. If the user authenticates with SCRAM-SHA, this value
- should be `admin`.
+ be `$external`. If the user authenticates with SCRAM-SHA or OIDC,
+ this value should be `admin`.
in: path
name: databaseName
required: true
@@ -6995,16 +7004,19 @@ paths:
| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |
- | SCRAM-SHA | awsType, x509Type, ldapAuthType | NONE | Alphanumeric string |
+ | OIDC | oidcAuthType | IDP_GROUP | Atlas OIDC IdP Identifier (found in Federation Settings, or contact Support), followed by a '/', followed by the IdP group name |
+
+ | SCRAM-SHA | awsType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |
in: path
name: username
required: true
schema:
type: string
example: "SCRAM-SHA: dylan or AWS IAM:
- arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs
- orx.509 or LDAP: CN=Dylan
- Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM"
+ arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or
+ x.509/LDAP: CN=Dylan
+ Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC:
+ IdPIdentifier/IdPGroupName"
responses:
"204":
content:
@@ -7012,7 +7024,7 @@ paths:
schema:
$ref: "#/components/schemas/noBody"
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"401":
$ref: "#/components/responses/unauthorized"
"403":
@@ -7038,8 +7050,8 @@ paths:
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, or LDAP, this value should
- be `$external`. If the user authenticates with SCRAM-SHA, this value
- should be `admin`.
+ be `$external`. If the user authenticates with SCRAM-SHA or OIDC,
+ this value should be `admin`.
in: path
name: databaseName
required: true
@@ -7067,16 +7079,19 @@ paths:
| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |
- | SCRAM-SHA | awsType, x509Type, ldapAuthType | NONE | Alphanumeric string |
+ | OIDC | oidcAuthType | IDP_GROUP | Atlas OIDC IdP Identifier (found in Federation Settings, or contact Support), followed by a '/', followed by the IdP group name |
+
+ | SCRAM-SHA | awsType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |
in: path
name: username
required: true
schema:
type: string
example: "SCRAM-SHA: dylan or AWS IAM:
- arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs
- orx.509 or LDAP: CN=Dylan
- Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM"
+ arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or
+ x.509/LDAP: CN=Dylan
+ Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC:
+ IdPIdentifier/IdPGroupName"
responses:
"200":
content:
@@ -7108,8 +7123,8 @@ paths:
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, or LDAP, this value should
- be `$external`. If the user authenticates with SCRAM-SHA, this value
- should be `admin`.
+ be `$external`. If the user authenticates with SCRAM-SHA or OIDC,
+ this value should be `admin`.
in: path
name: databaseName
required: true
@@ -7137,16 +7152,19 @@ paths:
| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |
- | SCRAM-SHA | awsType, x509Type, ldapAuthType | NONE | Alphanumeric string |
+ | OIDC | oidcAuthType | IDP_GROUP | Atlas OIDC IdP Identifier (found in Federation Settings, or contact Support), followed by a '/', followed by the IdP group name |
+
+ | SCRAM-SHA | awsType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |
in: path
name: username
required: true
schema:
type: string
example: "SCRAM-SHA: dylan or AWS IAM:
- arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs
- orx.509 or LDAP: CN=Dylan
- Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM"
+ arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or
+ x.509/LDAP: CN=Dylan
+ Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC:
+ IdPIdentifier/IdPGroupName"
requestBody:
content:
application/vnd.atlas.2023-01-01+json:
@@ -7557,7 +7575,9 @@ paths:
in: query
name: eventType
schema:
- $ref: "#/components/schemas/EventTypeForNdsGroup"
+ type: array
+ items:
+ $ref: "#/components/schemas/EventTypeForNdsGroup"
- description: Flag that indicates whether to include the raw document in the
output. The raw document contains additional meta information about
the event.
@@ -7898,7 +7918,7 @@ paths:
schema:
$ref: "#/components/schemas/noBody"
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"400":
$ref: "#/components/responses/badRequest"
"401":
@@ -8179,7 +8199,7 @@ paths:
schema:
$ref: "#/components/schemas/noBody"
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"401":
$ref: "#/components/responses/unauthorized"
"500":
@@ -8286,7 +8306,9 @@ paths:
content:
application/vnd.atlas.2023-01-01+json:
schema:
- $ref: "#/components/schemas/Limit"
+ type: array
+ items:
+ $ref: "#/components/schemas/Limit"
x-xgen-version: 2023-01-01
description: OK
"400":
@@ -8354,7 +8376,7 @@ paths:
schema:
$ref: "#/components/schemas/noBody"
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"400":
$ref: "#/components/responses/badRequest"
"404":
@@ -8714,10 +8736,8 @@ paths:
"204":
content:
application/vnd.atlas.2023-01-01+json:
- schema:
- $ref: "#/components/schemas/noBody"
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"400":
$ref: "#/components/responses/badRequest"
"404":
@@ -8784,13 +8804,13 @@ paths:
description: Updates the maintenance window for the specified project.
required: true
responses:
- "204":
+ "200":
content:
application/vnd.atlas.2023-01-01+json:
schema:
$ref: "#/components/schemas/noBody"
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: OK
"400":
$ref: "#/components/responses/badRequest"
"404":
@@ -8812,11 +8832,11 @@ paths:
parameters:
- $ref: "#/components/parameters/groupId"
responses:
- "204":
+ "200":
content:
application/vnd.atlas.2023-01-01+json:
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: OK
"400":
$ref: "#/components/responses/badRequest"
"404":
@@ -8847,11 +8867,11 @@ paths:
parameters:
- $ref: "#/components/parameters/groupId"
responses:
- "204":
+ "200":
content:
application/vnd.atlas.2023-01-01+json:
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: OK
"400":
$ref: "#/components/responses/badRequest"
"404":
@@ -8884,7 +8904,7 @@ paths:
content:
application/vnd.atlas.2023-01-01+json:
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"401":
$ref: "#/components/responses/unauthorized"
"403":
@@ -8917,7 +8937,7 @@ paths:
content:
application/vnd.atlas.2023-01-01+json:
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"401":
$ref: "#/components/responses/unauthorized"
"403":
@@ -9219,7 +9239,7 @@ paths:
schema:
$ref: "#/components/schemas/noBody"
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"401":
$ref: "#/components/responses/unauthorized"
"404":
@@ -9877,7 +9897,7 @@ paths:
schema:
$ref: "#/components/schemas/noBody"
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"400":
$ref: "#/components/responses/badRequest"
"404":
@@ -10060,7 +10080,7 @@ paths:
schema:
$ref: "#/components/schemas/noBody"
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"400":
$ref: "#/components/responses/badRequest"
"500":
@@ -10220,7 +10240,7 @@ paths:
schema:
$ref: "#/components/schemas/noBody"
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"400":
$ref: "#/components/responses/badRequest"
"500":
@@ -10476,7 +10496,7 @@ paths:
schema:
$ref: "#/components/schemas/noBody"
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"401":
$ref: "#/components/responses/unauthorized"
"404":
@@ -11655,7 +11675,7 @@ paths:
schema:
$ref: "#/components/schemas/noBody"
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"400":
$ref: "#/components/responses/badRequest"
"404":
@@ -11922,10 +11942,8 @@ paths:
"204":
content:
application/vnd.atlas.2023-01-01+json:
- schema:
- $ref: "#/components/schemas/noBody"
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"400":
$ref: "#/components/responses/badRequest"
"401":
@@ -12038,13 +12056,13 @@ paths:
description: Updates the LDAP configuration for the specified project.
required: true
responses:
- "200":
+ "202":
content:
application/vnd.atlas.2023-01-01+json:
schema:
$ref: "#/components/schemas/UserSecurity"
x-xgen-version: 2023-01-01
- description: OK
+ description: Accepted
"400":
$ref: "#/components/responses/badRequest"
"404":
@@ -12068,13 +12086,13 @@ paths:
parameters:
- $ref: "#/components/parameters/groupId"
responses:
- "200":
+ "202":
content:
application/vnd.atlas.2023-01-01+json:
schema:
$ref: "#/components/schemas/UserSecurity"
x-xgen-version: 2023-01-01
- description: OK
+ description: Accepted
"404":
$ref: "#/components/responses/notFound"
"500":
@@ -12095,11 +12113,13 @@ paths:
parameters:
- $ref: "#/components/parameters/groupId"
responses:
- "204":
+ "202":
content:
application/vnd.atlas.2023-01-01+json:
+ schema:
+ $ref: "#/components/schemas/UserSecurity"
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: Accepted
"404":
$ref: "#/components/responses/notFound"
"500":
@@ -12263,7 +12283,7 @@ paths:
content:
application/vnd.atlas.2023-01-01+json:
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"400":
$ref: "#/components/responses/badRequest"
"403":
@@ -12379,7 +12399,7 @@ paths:
schema:
$ref: "#/components/schemas/noBody"
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"400":
$ref: "#/components/responses/badRequest"
"401":
@@ -12516,7 +12536,7 @@ paths:
content:
application/vnd.atlas.2023-01-01+json:
schema:
- $ref: "#/components/schemas/CreateApiKey"
+ $ref: "#/components/schemas/CreateOrganizationApiKey"
description: Organization API Key to be created. This request requires both body
parameters.
required: true
@@ -12567,7 +12587,7 @@ paths:
schema:
$ref: "#/components/schemas/noBody"
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"401":
$ref: "#/components/responses/unauthorized"
"500":
@@ -12642,7 +12662,7 @@ paths:
content:
application/vnd.atlas.2023-01-01+json:
schema:
- $ref: "#/components/schemas/CreateApiKey"
+ $ref: "#/components/schemas/CreateOrganizationApiKey"
description: Organization API key to be updated. This request requires a minimum
of one of the two body parameters.
required: true
@@ -12804,7 +12824,7 @@ paths:
schema:
$ref: "#/components/schemas/noBody"
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"400":
$ref: "#/components/responses/badRequest"
"401":
@@ -12897,7 +12917,9 @@ paths:
in: query
name: eventType
schema:
- $ref: "#/components/schemas/EventTypeForOrg"
+ type: array
+ items:
+ $ref: "#/components/schemas/EventTypeForOrg"
- description: Flag that indicates whether to include the raw document in the
output. The raw document contains additional meta information about
the event.
@@ -13215,7 +13237,7 @@ paths:
schema:
$ref: "#/components/schemas/noBody"
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"400":
$ref: "#/components/responses/badRequest"
"401":
@@ -13409,6 +13431,10 @@ paths:
responses:
"200":
content:
+ application/vnd.atlas.2023-01-01+csv:
+ schema:
+ type: string
+ x-xgen-version: 2023-01-01
application/vnd.atlas.2023-01-01+json:
schema:
$ref: "#/components/schemas/Invoice"
@@ -13451,6 +13477,8 @@ paths:
"200":
content:
application/vnd.atlas.2023-01-01+csv:
+ schema:
+ type: string
x-xgen-version: 2023-01-01
description: OK
"401":
@@ -13508,7 +13536,7 @@ paths:
schema:
$ref: "#/components/schemas/noBody"
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"400":
$ref: "#/components/responses/badRequest"
"404":
@@ -13771,7 +13799,7 @@ paths:
schema:
$ref: "#/components/schemas/noBody"
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"400":
$ref: "#/components/responses/badRequest"
"401":
@@ -14023,7 +14051,7 @@ paths:
content:
application/vnd.atlas.2023-01-01+json:
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"400":
$ref: "#/components/responses/badRequest"
"401":
@@ -14072,6 +14100,49 @@ paths:
summary: Return All MongoDB Cloud Users in One Organization
tags:
- Organizations
+ "/api/atlas/v2/orgs/{orgId}/users/{userId}":
+ delete:
+ description: Removes one MongoDB Cloud user from the specified organization. To
+ use this resource, the requesting API Key must have the Organization
+ User Admin role. This resource doesn't require the API Key to have an
+ Access List.
+ operationId: removeOrganizationUser
+ parameters:
+ - $ref: "#/components/parameters/orgId"
+ - description: Unique 24-hexadecimal digit string that identifies the user to be
+ deleted.
+ in: path
+ name: userId
+ required: true
+ schema:
+ type: string
+ maxLength: 24
+ minLength: 24
+ pattern: ^([a-f0-9]{24})$
+ responses:
+ "204":
+ content:
+ application/vnd.atlas.2023-01-01+json:
+ schema:
+ $ref: "#/components/schemas/noBody"
+ x-xgen-version: 2023-01-01
+ description: This endpoint does not return a response body.
+ "400":
+ $ref: "#/components/responses/badRequest"
+ "401":
+ $ref: "#/components/responses/unauthorized"
+ "403":
+ $ref: "#/components/responses/forbidden"
+ "404":
+ $ref: "#/components/responses/notFound"
+ "500":
+ $ref: "#/components/responses/internalServerError"
+ security:
+ - DigestAuth: []
+ summary: Remove One MongoDB Cloud User from One Organization
+ tags:
+ - Organizations
+ x-xgen-experimental: true
/api/atlas/v2/users:
post:
description: >-
@@ -14956,13 +15027,9 @@ components:
- groupId
- hostnameSchemaType
EventTypeForNdsGroup:
- type: array
- items:
- type: string
+ type: string
EventTypeForOrg:
- type: array
- items:
- type: string
+ type: string
EventViewForNdsGroup:
type: object
x-xgen-go-transform: merge-oneOf
@@ -15359,34 +15426,6 @@ components:
resource returns this parameter when `"eventTypeName" : "USER"`.'
example: test.user@mongodb.com
readOnly: true
- ExampleResourceResponseView20230201:
- type: object
- properties:
- additionalInfo:
- type: string
- description: Dummy additional field added to the response.
- data:
- type: array
- description: Array that contains the dummy metadata.
- items:
- type: string
- description: Dummy data added as response.
- description:
- type: string
- description: Dummy description added as response.
- links:
- type: array
- description: List of one or more Uniform Resource Locators (URLs) that point to
- API sub-resources, related API resources, or both. RFC 5988 outlines
- these relationships.
- externalDocs:
- description: Web Linking Specification (RFC 5988)
- url: https://datatracker.ietf.org/doc/html/rfc5988
- items:
- $ref: "#/components/schemas/Link"
- readOnly: true
- required:
- - description
IndexOptions:
type: object
description: One or more settings that determine how the MongoDB Cloud creates
@@ -15676,6 +15715,12 @@ components:
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
minimum: 5
+ notifierId:
+ type: string
+ description: The notifierId is a system-generated unique identifier assigned to
+ each notification method. This is needed when updating third-party
+ notifications without requiring explicit authentication credentials.
+ example: 6462742adc47d365036da07c
typeName:
type: string
description: Human-readable label that displays the alert notification type.
@@ -19269,7 +19314,7 @@ components:
represents.
readOnly: true
readOnly: true
- CreateApiKey:
+ CreateOrganizationApiKey:
type: object
properties:
desc:
@@ -19282,7 +19327,23 @@ components:
type: array
description: List of roles to grant this API key. If you provide this list,
provide a minimum of one role and ensure each role applies to this
- organization or project.
+ organization.
+ items:
+ type: string
+ CreateProjectApiKey:
+ type: object
+ properties:
+ desc:
+ type: string
+ description: Purpose or explanation provided when someone created this project
+ API key.
+ maxLength: 250
+ minLength: 1
+ roles:
+ type: array
+ description: List of roles to grant this API key. If you provide this list,
+ provide a minimum of one role and ensure each role applies to this
+ project.
items:
type: string
Database:
@@ -23239,8 +23300,8 @@ components:
readOnly: true
tags:
type: array
- description: Collection of key-value pairs between 1 to 255 characters in length
- that tag and categorize the cluster.
+ description: List that contains key-value pairs between 1 to 255 characters in
+ length for tagging and categorizing the cluster.
items:
$ref: "#/components/schemas/Tag"
terminationProtectionEnabled:
@@ -23545,7 +23606,18 @@ components:
type: object
properties:
apiKey:
- $ref: "#/components/schemas/CreateApiKey"
+ $ref: "#/components/schemas/CreateOrganizationApiKey"
+ federationSettingsId:
+ type: string
+ description: Unique 24-hexadecimal digit string that identifies the federation
+ to link the newly created organization to. If specified, the
+ proposed Organization Owner of the new organization must have the
+ Organization Owner role in an organization associated with the
+ federation.
+ example: 32b6e34b3d91647abb20e7b8
+ maxLength: 24
+ minLength: 24
+ pattern: ^([a-f0-9]{24})$
name:
type: string
description: Human-readable label that identifies the organization.
@@ -23554,10 +23626,13 @@ components:
pattern: ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$
orgOwnerId:
type: string
- description: Unique 24-hexadecimal digit string that identifies the Atlas user
- that you want to assign the Organization Owner role. This user must
- be a member of the same organization as the calling API key. This is
- only required when authenticating with Programmatic API Keys.
+ description: Unique 24-hexadecimal digit string that identifies the MongoDB
+ Cloud user that you want to assign the Organization Owner role. This
+ user must be a member of the same organization as the calling API
+ key. If you provide `federationSettingsId`, this user must instead
+ have the Organization Owner role on an organization in the specified
+ federation. This parameter is required only when you authenticate
+ with Programmatic API Keys.
example: 32b6e34b3d91647abb20e7b8
maxLength: 24
minLength: 24
@@ -23569,10 +23644,20 @@ components:
properties:
apiKey:
$ref: "#/components/schemas/ApiUser"
+ federationSettingsId:
+ type: string
+ description: Unique 24-hexadecimal digit string that identifies the federation
+ that you linked the newly created organization to.
+ example: 32b6e34b3d91647abb20e7b8
+ maxLength: 24
+ minLength: 24
+ pattern: ^([a-f0-9]{24})$
+ readOnly: true
orgOwnerId:
type: string
- description: Unique 24-hexadecimal digit string that identifies the Atlas user
- that you want to assign the Organization Owner role.
+ description: Unique 24-hexadecimal digit string that identifies the MongoDB
+ Cloud user that you assigned the Organization Owner role in the new
+ organization.
example: 32b6e34b3d91647abb20e7b8
maxLength: 24
minLength: 24
@@ -23691,6 +23776,7 @@ components:
type:
type: string
description: Type of ingestion destination of this Data Lake Pipeline.
+ readOnly: true
required: []
DataFederationQueryLimit:
type: object
@@ -24379,6 +24465,13 @@ components:
items:
$ref: "#/components/schemas/Link"
readOnly: true
+ oidcAuthType:
+ type: string
+ default: NONE
+ description: Human-readable label that indicates whether the new database user
+ authenticates with OIDC federated authentication. To create a
+ federated authentication user, specify the value of IDP_GROUP for
+ this field.
password:
type: string
description: Alphanumeric string that authenticates this database user against
@@ -24428,7 +24521,9 @@ components:
| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |
- | SCRAM-SHA | awsType, x509Type, ldapAuthType | NONE | Alphanumeric string |
+ | OIDC | oidcAuthType | IDP_GROUP | Atlas OIDC IdP Identifier (found in Federation Settings, or contact Support), followed by a '/', followed by the IdP group name |
+
+ | SCRAM-SHA | awsType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |
maxLength: 1024
x509Type:
type: string
@@ -24716,9 +24811,6 @@ components:
snapshot.
items:
type: string
- description: List that identifies the regions to which MongoDB Cloud copies the
- snapshot.
- readOnly: true
readOnly: true
createdAt:
type: string
@@ -24945,9 +25037,6 @@ components:
- targetGroupId
DiskBackupShardedClusterSnapshotMember:
type: object
- description: 'List that includes the snapshots and the cloud provider that
- stores the snapshots. The resource returns this parameter when `"type" :
- "SHARDED_CLUSTER"`.'
properties:
cloudProvider:
type: string
@@ -24968,7 +25057,6 @@ components:
description: Human-readable label that identifies the shard or config host from
which MongoDB Cloud took this snapshot.
readOnly: true
- readOnly: true
required:
- cloudProvider
- id
@@ -26405,7 +26493,6 @@ components:
type: object
additionalProperties:
$ref: "#/components/schemas/RegionSpec"
- deprecated: true
description: Physical location where MongoDB Cloud provisions cluster nodes.
title: Region Configuration
replicationSpecs:
@@ -26440,8 +26527,8 @@ components:
readOnly: true
tags:
type: array
- description: Collection of key-value pairs between 1 to 255 characters in length
- that tag and categorize the cluster.
+ description: List that contains key-value pairs between 1 to 255 characters in
+ length for tagging and categorizing the cluster.
items:
$ref: "#/components/schemas/Tag"
terminationProtectionEnabled:
@@ -27738,6 +27825,12 @@ components:
description: Human-readable label that indicates the current operating condition
of the serverless instance.
readOnly: true
+ tags:
+ type: array
+ description: List that contains key-value pairs between 1 to 255 characters in
+ length for tagging and categorizing the serverless instance.
+ items:
+ $ref: "#/components/schemas/Tag"
terminationProtectionEnabled:
type: boolean
default: false
@@ -27756,6 +27849,12 @@ components:
properties:
serverlessBackupOptions:
$ref: "#/components/schemas/ServerlessBackupOptions"
+ tags:
+ type: array
+ description: List that contains key-value pairs between 1 to 255 characters in
+ length for tagging and categorizing the serverless instance.
+ items:
+ $ref: "#/components/schemas/Tag"
terminationProtectionEnabled:
type: boolean
default: false
@@ -27827,6 +27926,8 @@ components:
readOnly: true
tags:
type: array
+ description: List that contains key-value pairs between 1 to 255 characters in
+ length for tagging and categorizing the serverless instance.
items:
$ref: "#/components/schemas/Tag"
terminationProtectionEnabled:
@@ -28051,17 +28152,20 @@ components:
- weeklySnapshotRetentionWeeks
Tag:
type: object
- description: A key-value pair that tags and categorizes a MongoDB Cloud org,
- project, or cluster
+ description: "Key-value pair that tags and categorizes a MongoDB Cloud
+ organization, project, or cluster. For example, `environment :
+ production`."
properties:
key:
type: string
- description: Key applied to the tag.
+ description: "Constant that defines the set of the tag. For example,
+ `environment` in the `environment : production` tag."
maxLength: 255
minLength: 1
value:
type: string
- description: Value applied to the tag.
+ description: "Variable that belongs to the set of the tag. For example,
+ `production` in the `environment : production` tag."
maxLength: 255
minLength: 1
title: Resource Tag
diff --git a/openapi/atlas-api.yaml b/openapi/atlas-api.yaml
index 1a9f0aff..52b63fab 100644
--- a/openapi/atlas-api.yaml
+++ b/openapi/atlas-api.yaml
@@ -5,7 +5,12 @@ info:
The Atlas Administration API uses HTTP Digest Authentication to authenticate requests. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request. For example, to [return database access history](#tag/Access-Tracking/operation/listAccessLogsByClusterName) with [cURL](https://en.wikipedia.org/wiki/CURL), run the following command in the terminal:
- `curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest "https://cloud.mongodb.com/api/atlas/v2.0/groups/{groupId}/dbAccessHistory/clusters/{clusterName}"`
+ ```
+ curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \
+ --digest \
+ --header "Accept: application/vnd.atlas.2023-02-01+json" \
+ GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true"
+ ```
To learn more, see [Get Started with the Atlas Administration API](https://www.mongodb.com/docs/atlas/configure-api-access/). For support, see [MongoDB Support](https://www.mongodb.com/support/get-started).
license:
@@ -13,8 +18,8 @@ info:
url: https://creativecommons.org/licenses/by-nc-sa/3.0/us/
termsOfService: https://www.mongodb.com/mongodb-management-service-terms-and-conditions
title: MongoDB Atlas Administration API
- version: 2.0~b0d2861b4b
- x-xgen-sha: b0d2861b4bfc9f349f9e26e3ed2d70c43c950779
+ version: 2.0~1056ca6d98
+ x-xgen-sha: 1056ca6d981acf30dfc69b4c7a2a67a43a2939fe
servers:
- url: https://cloud.mongodb.com
tags:
@@ -175,8 +180,6 @@ tags:
name: Shared-Tier Snapshots
- description: "Returns, adds, edits, or removes teams."
name: Teams
-- description: Atlas test endpoints.
- name: Test
- description: |-
Returns, adds, edits, and removes third-party service integration configurations. MongoDB Cloud sends alerts to each third-party service that you configure.
@@ -274,34 +277,6 @@ paths:
summary: Return All Authorized Clusters in All Projects
tags:
- Clusters
- /api/atlas/v2/example/info:
- get:
- description: "Returns some text dummy data for test purposes. Deprecated versions:\
- \ v2-{2023-01-01}"
- operationId: versionedExample
- parameters:
- - in: query
- name: additionalInfo
- schema:
- type: boolean
- default: false
- responses:
- "200":
- content:
- application/vnd.atlas.2023-02-01+json:
- schema:
- $ref: '#/components/schemas/ExampleResourceResponseView20230201'
- x-xgen-version: 2023-02-01
- description: OK
- "401":
- $ref: '#/components/responses/unauthorized'
- "500":
- $ref: '#/components/responses/internalServerError'
- security:
- - DigestAuth: []
- summary: Example resource info for versioning of the Atlas API
- tags:
- - Test
/api/atlas/v2/federationSettings/{federationSettingsId}:
delete:
description: "Deletes the federation settings instance and all associated data,\
@@ -390,7 +365,7 @@ paths:
schema:
$ref: '#/components/schemas/noBody'
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"400":
$ref: '#/components/responses/badRequest'
"401":
@@ -964,7 +939,7 @@ paths:
schema:
$ref: '#/components/schemas/noBody'
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"400":
$ref: '#/components/responses/badRequest'
"409":
@@ -1178,7 +1153,7 @@ paths:
schema:
$ref: '#/components/schemas/noBody'
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"403":
$ref: '#/components/responses/forbidden'
"404":
@@ -1793,7 +1768,7 @@ paths:
content:
application/vnd.atlas.2023-01-01+json:
schema:
- $ref: '#/components/schemas/ApiCreateApiKeyView'
+ $ref: '#/components/schemas/ApiCreateProjectApiKeyView'
description: Organization API key to be created and assigned to the specified
project. This request requires both body parameters.
required: true
@@ -1842,7 +1817,7 @@ paths:
schema:
$ref: '#/components/schemas/noBody'
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"400":
$ref: '#/components/responses/badRequest'
"401":
@@ -1880,7 +1855,7 @@ paths:
content:
application/vnd.atlas.2023-01-01+json:
schema:
- $ref: '#/components/schemas/ApiCreateApiKeyView'
+ $ref: '#/components/schemas/ApiCreateProjectApiKeyView'
description: Organization API Key to be updated. This request requires a minimum
of one of the two body parameters.
required: true
@@ -2163,7 +2138,7 @@ paths:
schema:
$ref: '#/components/schemas/noBody'
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"400":
$ref: '#/components/responses/badRequest'
"401":
@@ -2495,7 +2470,7 @@ paths:
$ref: '#/components/responses/internalServerError'
security:
- DigestAuth: []
- summary: Return All Multi-Cloud Clusters from One Project
+ summary: Return All Clusters in One Project
tags:
- Multi-Cloud Clusters
post:
@@ -2774,11 +2749,11 @@ paths:
schema:
type: boolean
responses:
- "204":
+ "202":
content:
application/vnd.atlas.2023-02-01+json:
x-xgen-version: 2023-02-01
- description: Endpoint does not return a response body.
+ description: Accepted
"400":
$ref: '#/components/responses/badRequest'
"401":
@@ -2823,6 +2798,10 @@ paths:
description: OK
"401":
$ref: '#/components/responses/unauthorized'
+ "404":
+ $ref: '#/components/responses/notFound'
+ "409":
+ $ref: '#/components/responses/conflict'
"500":
$ref: '#/components/responses/internalServerError'
security:
@@ -2845,8 +2824,7 @@ paths:
operationId: updateCluster
parameters:
- $ref: '#/components/parameters/groupId'
- - description: Human-readable label that identifies the advanced cluster to
- modify.
+ - description: Human-readable label that identifies the cluster.
in: path
name: clusterName
required: true
@@ -3131,7 +3109,7 @@ paths:
schema:
$ref: '#/components/schemas/noBody'
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"400":
$ref: '#/components/responses/badRequest'
"405":
@@ -3423,7 +3401,7 @@ paths:
schema:
$ref: '#/components/schemas/noBody'
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"404":
$ref: '#/components/responses/notFound'
"500":
@@ -3550,7 +3528,7 @@ paths:
schema:
$ref: '#/components/schemas/noBody'
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"400":
$ref: '#/components/responses/badRequest'
"404":
@@ -4163,7 +4141,7 @@ paths:
schema:
$ref: '#/components/schemas/noBody'
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"400":
$ref: '#/components/responses/badRequest'
"404":
@@ -4293,6 +4271,9 @@ paths:
\ dot separator, and the collection name. To use this resource, the requesting\
\ API Key must have the Project Read Only role. This resource doesn't require\
\ the API Key to have an Access List. Deprecated versions: v2-{2023-01-01}"
+ externalDocs:
+ description: Global Clusters
+ url: https://www.mongodb.com/docs/atlas/global-clusters/
operationId: getManagedNamespace
parameters:
- $ref: '#/components/parameters/groupId'
@@ -4313,6 +4294,8 @@ paths:
$ref: '#/components/schemas/ApiAtlasGeoShardingView'
x-xgen-version: 2023-02-01
description: OK
+ "401":
+ $ref: '#/components/responses/unauthorized'
"500":
$ref: '#/components/responses/internalServerError'
security:
@@ -4329,6 +4312,9 @@ paths:
\ geographical zone. To use this resource, the requesting API Key must have\
\ the Project Owner role. This resource doesn't require the API Key to have\
\ an Access List. Deprecated versions: v2-{2023-01-01}"
+ externalDocs:
+ description: Global Clusters
+ url: https://www.mongodb.com/docs/atlas/global-clusters/
operationId: deleteAllCustomZoneMappings
parameters:
- $ref: '#/components/parameters/groupId'
@@ -4365,6 +4351,9 @@ paths:
\ the closest geographical zone. To use this resource, the requesting API\
\ Key must have the Project Owner role. This resource doesn't require the\
\ API Key to have an Access List. Deprecated versions: v2-{2023-01-01}"
+ externalDocs:
+ description: Global Clusters
+ url: https://www.mongodb.com/docs/atlas/global-clusters/
operationId: createCustomZoneMapping
parameters:
- $ref: '#/components/parameters/groupId'
@@ -4394,6 +4383,8 @@ paths:
description: OK
"400":
$ref: '#/components/responses/badRequest'
+ "401":
+ $ref: '#/components/responses/unauthorized'
"500":
$ref: '#/components/responses/internalServerError'
security:
@@ -4410,6 +4401,9 @@ paths:
\ requesting API Key must have the Project Data Access Admin role. This resource\
\ doesn't require the API Key to have an Access List. Deprecated versions:\
\ v2-{2023-01-01}"
+ externalDocs:
+ description: Global Clusters
+ url: https://www.mongodb.com/docs/atlas/global-clusters/
operationId: deleteManagedNamespace
parameters:
- description: Human-readable label that identifies this advanced cluster.
@@ -4444,6 +4438,8 @@ paths:
description: OK
"400":
$ref: '#/components/responses/badRequest'
+ "401":
+ $ref: '#/components/responses/unauthorized'
"500":
$ref: '#/components/responses/internalServerError'
security:
@@ -4457,6 +4453,9 @@ paths:
\ dot separator, and the collection name. To use this resource, the requesting\
\ API Key must have the Project Data Access Admin role. This resource doesn't\
\ require the API Key to have an Access List. Deprecated versions: v2-{2023-01-01}"
+ externalDocs:
+ description: Global Clusters
+ url: https://www.mongodb.com/docs/atlas/global-clusters/
operationId: createManagedNamespace
parameters:
- $ref: '#/components/parameters/groupId'
@@ -4486,6 +4485,8 @@ paths:
description: OK
"400":
$ref: '#/components/responses/badRequest'
+ "401":
+ $ref: '#/components/responses/unauthorized'
"405":
$ref: '#/components/responses/methodNotAllowed'
"500":
@@ -4528,11 +4529,11 @@ paths:
description: Rolling index to create on the specified cluster.
required: true
responses:
- "204":
+ "202":
content:
application/vnd.atlas.2023-01-01+json:
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: Accepted
"400":
$ref: '#/components/responses/badRequest'
"404":
@@ -4753,7 +4754,7 @@ paths:
schema:
$ref: '#/components/schemas/noBody'
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"401":
$ref: '#/components/responses/unauthorized'
"404":
@@ -5120,11 +5121,11 @@ paths:
minLength: 1
pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$"
responses:
- "204":
+ "200":
content:
application/vnd.atlas.2023-02-01+json:
x-xgen-version: 2023-02-01
- description: Endpoint does not return a response body.
+ description: OK
"401":
$ref: '#/components/responses/unauthorized'
"500":
@@ -5474,7 +5475,7 @@ paths:
schema:
$ref: '#/components/schemas/noBody'
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"400":
$ref: '#/components/responses/badRequest'
"401":
@@ -5635,23 +5636,31 @@ paths:
/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz:
get:
description: "Returns a compressed (.gz) log file that contains a range of log\
- \ messages for the specified host for the specified project. To use this resource,\
- \ the requesting API Key must have the Project Owner or Project Data Access\
- \ Read Write roles. This resource doesn't require the API Key to have an Access\
- \ List. Deprecated versions: v2-{2023-01-01}"
+ \ messages for the specified host for the specified project. MongoDB updates\
+ \ process and audit logs from the cluster backend infrastructure every five\
+ \ minutes and contain log data from the previous five minutes. If you poll\
+ \ the API for log files, we recommend polling every five minutes. For example,\
+ \ if the logs are updated at 4:00 UTC and then you poll the API, the API returns\
+ \ log data from the interval between 3:55 UTC and 4:00 UTC. This feature isn't\
+ \ available for `M0` free clusters, `M2`, `M5`, or serverless clusters. To\
+ \ use this resource, the requesting API Key must have the Project Owner or\
+ \ Project Data Access Read/Write roles. This resource doesn't require the\
+ \ API Key to have an Access List. Deprecated versions: v2-{2023-01-01}"
operationId: getHostLogs
parameters:
- $ref: '#/components/parameters/groupId'
- - description: Fully qualified domain name or IP address of the MongoDB host
- that stores the log files that you want to download.
+ - description: Human-readable label that identifies the host that stores the
+ log files that you want to download.
in: path
name: hostName
required: true
schema:
type: string
- - description: Human-readable label of the log file that you want to return.
- You can return audit logs only if you enable Database Auditing for the specified
- project.
+ pattern: "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\\
+ .){1,10}[a-z]+)?$"
+ - description: "Human-readable label that identifies the log file that you want\
+ \ to return. To return audit logs, enable *Database Auditing* for the specified\
+ \ project."
in: path
name: logName
required: true
@@ -5662,6 +5671,9 @@ paths:
- mongos
- mongodb-audit-log
- mongos-audit-log
+ externalDocs:
+ description: Set up Database Auditing
+ url: https://docs.atlas.mongodb.com/database-auditing/
- description: Date and time when the period specifies the inclusive ending
point for the range of log messages to retrieve. This parameter expresses
its value in the number of seconds that have elapsed since the UNIX epoch.
@@ -5705,7 +5717,7 @@ paths:
$ref: '#/components/responses/internalServerError'
security:
- DigestAuth: []
- summary: Download Logs for One Multi-Cloud Cluster Host in One Project
+ summary: Download Logs for One Cluster Host in One Project
tags:
- Monitoring and Logs
/api/atlas/v2/groups/{groupId}/containers:
@@ -5851,7 +5863,7 @@ paths:
schema:
$ref: '#/components/schemas/noBody'
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"400":
$ref: '#/components/responses/badRequest'
"401":
@@ -6244,7 +6256,7 @@ paths:
schema:
$ref: '#/components/schemas/noBody'
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"404":
$ref: '#/components/responses/notFound'
"500":
@@ -6419,7 +6431,7 @@ paths:
schema:
$ref: '#/components/schemas/noBody'
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"400":
$ref: '#/components/responses/badRequest'
"500":
@@ -6468,9 +6480,7 @@ paths:
content:
application/vnd.atlas.2023-01-01+json:
schema:
- type: array
- items:
- $ref: '#/components/schemas/ApiAtlasDataFederationTenantQueryLimitView'
+ $ref: '#/components/schemas/ApiAtlasDataFederationTenantQueryLimitView'
x-xgen-version: 2023-01-01
description: OK
"401":
@@ -6529,9 +6539,7 @@ paths:
content:
application/vnd.atlas.2023-01-01+json:
schema:
- type: array
- items:
- $ref: '#/components/schemas/ApiAtlasDataFederationTenantQueryLimitView'
+ $ref: '#/components/schemas/ApiAtlasDataFederationTenantQueryLimitView'
x-xgen-version: 2023-01-01
description: OK
"400":
@@ -6745,7 +6753,7 @@ paths:
\ 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, or LDAP, this value should be `$external`. If the\
- \ user authenticates with SCRAM-SHA, this value should be `admin`."
+ \ user authenticates with SCRAM-SHA or OIDC, this value should be `admin`."
in: path
name: databaseName
required: true
@@ -6762,14 +6770,16 @@ paths:
| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |
| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |
| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |
- | SCRAM-SHA | awsType, x509Type, ldapAuthType | NONE | Alphanumeric string |
+ | OIDC | oidcAuthType | IDP_GROUP | Atlas OIDC IdP Identifier (found in Federation Settings, or contact Support), followed by a '/', followed by the IdP group name |
+ | SCRAM-SHA | awsType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |
in: path
name: username
required: true
schema:
type: string
example: "SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs\
- \ orx.509 or LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM"
+ \ or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM\
+ \ or OIDC: IdPIdentifier/IdPGroupName"
responses:
"204":
content:
@@ -6777,7 +6787,7 @@ paths:
schema:
$ref: '#/components/schemas/noBody'
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"401":
$ref: '#/components/responses/unauthorized'
"403":
@@ -6802,7 +6812,7 @@ paths:
\ 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, or LDAP, this value should be `$external`. If the\
- \ user authenticates with SCRAM-SHA, this value should be `admin`."
+ \ user authenticates with SCRAM-SHA or OIDC, this value should be `admin`."
in: path
name: databaseName
required: true
@@ -6819,14 +6829,16 @@ paths:
| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |
| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |
| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |
- | SCRAM-SHA | awsType, x509Type, ldapAuthType | NONE | Alphanumeric string |
+ | OIDC | oidcAuthType | IDP_GROUP | Atlas OIDC IdP Identifier (found in Federation Settings, or contact Support), followed by a '/', followed by the IdP group name |
+ | SCRAM-SHA | awsType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |
in: path
name: username
required: true
schema:
type: string
example: "SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs\
- \ orx.509 or LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM"
+ \ or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM\
+ \ or OIDC: IdPIdentifier/IdPGroupName"
responses:
"200":
content:
@@ -6858,7 +6870,7 @@ paths:
\ 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, or LDAP, this value should be `$external`. If the\
- \ user authenticates with SCRAM-SHA, this value should be `admin`."
+ \ user authenticates with SCRAM-SHA or OIDC, this value should be `admin`."
in: path
name: databaseName
required: true
@@ -6875,14 +6887,16 @@ paths:
| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |
| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |
| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |
- | SCRAM-SHA | awsType, x509Type, ldapAuthType | NONE | Alphanumeric string |
+ | OIDC | oidcAuthType | IDP_GROUP | Atlas OIDC IdP Identifier (found in Federation Settings, or contact Support), followed by a '/', followed by the IdP group name |
+ | SCRAM-SHA | awsType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |
in: path
name: username
required: true
schema:
type: string
example: "SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs\
- \ orx.509 or LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM"
+ \ or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM\
+ \ or OIDC: IdPIdentifier/IdPGroupName"
requestBody:
content:
application/vnd.atlas.2023-01-01+json:
@@ -7268,7 +7282,9 @@ paths:
in: query
name: eventType
schema:
- $ref: '#/components/schemas/EventTypeForNdsGroup'
+ type: array
+ items:
+ $ref: '#/components/schemas/EventTypeForNdsGroup'
- description: Flag that indicates whether to include the raw document in the
output. The raw document contains additional meta information about the
event.
@@ -7643,7 +7659,7 @@ paths:
schema:
$ref: '#/components/schemas/noBody'
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"400":
$ref: '#/components/responses/badRequest'
"401":
@@ -7957,7 +7973,7 @@ paths:
schema:
$ref: '#/components/schemas/noBody'
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"401":
$ref: '#/components/responses/unauthorized'
"500":
@@ -8064,7 +8080,9 @@ paths:
content:
application/vnd.atlas.2023-01-01+json:
schema:
- $ref: '#/components/schemas/ApiLimitView'
+ type: array
+ items:
+ $ref: '#/components/schemas/ApiLimitView'
x-xgen-version: 2023-01-01
description: OK
"400":
@@ -8129,7 +8147,7 @@ paths:
schema:
$ref: '#/components/schemas/noBody'
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"400":
$ref: '#/components/responses/badRequest'
"404":
@@ -8477,10 +8495,8 @@ paths:
"204":
content:
application/vnd.atlas.2023-01-01+json:
- schema:
- $ref: '#/components/schemas/noBody'
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"400":
$ref: '#/components/responses/badRequest'
"404":
@@ -8546,13 +8562,13 @@ paths:
description: Updates the maintenance window for the specified project.
required: true
responses:
- "204":
+ "200":
content:
application/vnd.atlas.2023-01-01+json:
schema:
$ref: '#/components/schemas/noBody'
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: OK
"400":
$ref: '#/components/responses/badRequest'
"404":
@@ -8574,11 +8590,11 @@ paths:
parameters:
- $ref: '#/components/parameters/groupId'
responses:
- "204":
+ "200":
content:
application/vnd.atlas.2023-01-01+json:
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: OK
"400":
$ref: '#/components/responses/badRequest'
"404":
@@ -8607,11 +8623,11 @@ paths:
parameters:
- $ref: '#/components/parameters/groupId'
responses:
- "204":
+ "200":
content:
application/vnd.atlas.2023-01-01+json:
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: OK
"400":
$ref: '#/components/responses/badRequest'
"404":
@@ -8643,7 +8659,7 @@ paths:
content:
application/vnd.atlas.2023-01-01+json:
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"401":
$ref: '#/components/responses/unauthorized'
"403":
@@ -8675,7 +8691,7 @@ paths:
content:
application/vnd.atlas.2023-01-01+json:
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"401":
$ref: '#/components/responses/unauthorized'
"403":
@@ -8980,7 +8996,7 @@ paths:
schema:
$ref: '#/components/schemas/noBody'
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"401":
$ref: '#/components/responses/unauthorized'
"404":
@@ -9635,7 +9651,7 @@ paths:
schema:
$ref: '#/components/schemas/noBody'
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"400":
$ref: '#/components/responses/badRequest'
"404":
@@ -9823,7 +9839,7 @@ paths:
schema:
$ref: '#/components/schemas/noBody'
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"400":
$ref: '#/components/responses/badRequest'
"500":
@@ -9996,7 +10012,7 @@ paths:
schema:
$ref: '#/components/schemas/noBody'
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"400":
$ref: '#/components/responses/badRequest'
"500":
@@ -10246,7 +10262,7 @@ paths:
schema:
$ref: '#/components/schemas/noBody'
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"401":
$ref: '#/components/responses/unauthorized'
"404":
@@ -11543,7 +11559,7 @@ paths:
schema:
$ref: '#/components/schemas/noBody'
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"400":
$ref: '#/components/responses/badRequest'
"404":
@@ -11808,10 +11824,8 @@ paths:
"204":
content:
application/vnd.atlas.2023-01-01+json:
- schema:
- $ref: '#/components/schemas/noBody'
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"400":
$ref: '#/components/responses/badRequest'
"401":
@@ -11920,13 +11934,13 @@ paths:
description: Updates the LDAP configuration for the specified project.
required: true
responses:
- "200":
+ "202":
content:
application/vnd.atlas.2023-01-01+json:
schema:
$ref: '#/components/schemas/ApiAtlasUserSecurityView'
x-xgen-version: 2023-01-01
- description: OK
+ description: Accepted
"400":
$ref: '#/components/responses/badRequest'
"404":
@@ -11948,13 +11962,13 @@ paths:
parameters:
- $ref: '#/components/parameters/groupId'
responses:
- "200":
+ "202":
content:
application/vnd.atlas.2023-01-01+json:
schema:
$ref: '#/components/schemas/ApiAtlasUserSecurityView'
x-xgen-version: 2023-01-01
- description: OK
+ description: Accepted
"404":
$ref: '#/components/responses/notFound'
"500":
@@ -11975,11 +11989,13 @@ paths:
parameters:
- $ref: '#/components/parameters/groupId'
responses:
- "204":
+ "202":
content:
application/vnd.atlas.2023-01-01+json:
+ schema:
+ $ref: '#/components/schemas/ApiAtlasUserSecurityView'
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: Accepted
"404":
$ref: '#/components/responses/notFound'
"500":
@@ -12137,7 +12153,7 @@ paths:
content:
application/vnd.atlas.2023-01-01+json:
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"400":
$ref: '#/components/responses/badRequest'
"403":
@@ -12251,7 +12267,7 @@ paths:
schema:
$ref: '#/components/schemas/noBody'
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"400":
$ref: '#/components/responses/badRequest'
"401":
@@ -12387,7 +12403,7 @@ paths:
content:
application/vnd.atlas.2023-01-01+json:
schema:
- $ref: '#/components/schemas/ApiCreateApiKeyView'
+ $ref: '#/components/schemas/ApiCreateOrganizationApiKeyView'
description: Organization API Key to be created. This request requires both
body parameters.
required: true
@@ -12438,7 +12454,7 @@ paths:
schema:
$ref: '#/components/schemas/noBody'
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"401":
$ref: '#/components/responses/unauthorized'
"500":
@@ -12513,7 +12529,7 @@ paths:
content:
application/vnd.atlas.2023-01-01+json:
schema:
- $ref: '#/components/schemas/ApiCreateApiKeyView'
+ $ref: '#/components/schemas/ApiCreateOrganizationApiKeyView'
description: Organization API key to be updated. This request requires a minimum
of one of the two body parameters.
required: true
@@ -12673,7 +12689,7 @@ paths:
schema:
$ref: '#/components/schemas/noBody'
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"400":
$ref: '#/components/responses/badRequest'
"401":
@@ -12759,7 +12775,9 @@ paths:
in: query
name: eventType
schema:
- $ref: '#/components/schemas/EventTypeForOrg'
+ type: array
+ items:
+ $ref: '#/components/schemas/EventTypeForOrg'
- description: Flag that indicates whether to include the raw document in the
output. The raw document contains additional meta information about the
event.
@@ -13063,7 +13081,7 @@ paths:
schema:
$ref: '#/components/schemas/noBody'
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"400":
$ref: '#/components/responses/badRequest'
"401":
@@ -13252,6 +13270,10 @@ paths:
responses:
"200":
content:
+ application/vnd.atlas.2023-01-01+csv:
+ schema:
+ type: string
+ x-xgen-version: 2023-01-01
application/vnd.atlas.2023-01-01+json:
schema:
$ref: '#/components/schemas/ApiInvoiceView'
@@ -13293,6 +13315,8 @@ paths:
"200":
content:
application/vnd.atlas.2023-01-01+csv:
+ schema:
+ type: string
x-xgen-version: 2023-01-01
description: OK
"401":
@@ -13348,7 +13372,7 @@ paths:
schema:
$ref: '#/components/schemas/noBody'
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"400":
$ref: '#/components/responses/badRequest'
"404":
@@ -13608,7 +13632,7 @@ paths:
schema:
$ref: '#/components/schemas/noBody'
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"400":
$ref: '#/components/responses/badRequest'
"401":
@@ -13859,7 +13883,7 @@ paths:
content:
application/vnd.atlas.2023-01-01+json:
x-xgen-version: 2023-01-01
- description: Endpoint does not return a response body.
+ description: This endpoint does not return a response body.
"400":
$ref: '#/components/responses/badRequest'
"401":
@@ -13908,6 +13932,48 @@ paths:
summary: Return All MongoDB Cloud Users in One Organization
tags:
- Organizations
+ /api/atlas/v2/orgs/{orgId}/users/{userId}:
+ delete:
+ description: "Removes one MongoDB Cloud user from the specified organization.\
+ \ To use this resource, the requesting API Key must have the Organization\
+ \ User Admin role. This resource doesn't require the API Key to have an Access\
+ \ List."
+ operationId: removeOrganizationUser
+ parameters:
+ - $ref: '#/components/parameters/orgId'
+ - description: Unique 24-hexadecimal digit string that identifies the user to
+ be deleted.
+ in: path
+ name: userId
+ required: true
+ schema:
+ type: string
+ maxLength: 24
+ minLength: 24
+ pattern: "^([a-f0-9]{24})$"
+ responses:
+ "204":
+ content:
+ application/vnd.atlas.2023-01-01+json:
+ schema:
+ $ref: '#/components/schemas/noBody'
+ x-xgen-version: 2023-01-01
+ description: This endpoint does not return a response body.
+ "400":
+ $ref: '#/components/responses/badRequest'
+ "401":
+ $ref: '#/components/responses/unauthorized'
+ "403":
+ $ref: '#/components/responses/forbidden'
+ "404":
+ $ref: '#/components/responses/notFound'
+ "500":
+ $ref: '#/components/responses/internalServerError'
+ security:
+ - DigestAuth: []
+ summary: Remove One MongoDB Cloud User from One Organization
+ tags:
+ - Organizations
/api/atlas/v2/users:
post:
description: |-
@@ -15432,12 +15498,6 @@ components:
description: Cloud service provider that serves the requested network peering
connection.
enum:
- - NONE
- - AWS
- - GCP
- - AZURE
- - FREE
- - SERVERLESS
- AWS
- AZURE
- GCP
@@ -16063,12 +16123,6 @@ components:
description: Cloud service provider that serves the requested network peering
connection.
enum:
- - NONE
- - AWS
- - GCP
- - AZURE
- - FREE
- - SERVERLESS
- AWS
- AZURE
- GCP
@@ -17204,8 +17258,8 @@ components:
readOnly: true
tags:
type: array
- description: Collection of key-value pairs between 1 to 255 characters in
- length that tag and categorize the cluster.
+ description: List that contains key-value pairs between 1 to 255 characters
+ in length for tagging and categorizing the cluster.
items:
$ref: '#/components/schemas/ApiAtlasTagView'
terminationProtectionEnabled:
@@ -17427,12 +17481,6 @@ components:
description: Cloud service provider that serves the requested network peering
connection.
enum:
- - NONE
- - AWS
- - GCP
- - AZURE
- - FREE
- - SERVERLESS
- AWS
- AZURE
- GCP
@@ -17564,7 +17612,17 @@ components:
type: object
properties:
apiKey:
- $ref: '#/components/schemas/ApiCreateApiKeyView'
+ $ref: '#/components/schemas/ApiCreateOrganizationApiKeyView'
+ federationSettingsId:
+ type: string
+ description: "Unique 24-hexadecimal digit string that identifies the federation\
+ \ to link the newly created organization to. If specified, the proposed\
+ \ Organization Owner of the new organization must have the Organization\
+ \ Owner role in an organization associated with the federation."
+ example: 32b6e34b3d91647abb20e7b8
+ maxLength: 24
+ minLength: 24
+ pattern: "^([a-f0-9]{24})$"
name:
type: string
description: Human-readable label that identifies the organization.
@@ -17573,10 +17631,13 @@ components:
pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$"
orgOwnerId:
type: string
- description: Unique 24-hexadecimal digit string that identifies the Atlas
- user that you want to assign the Organization Owner role. This user must
- be a member of the same organization as the calling API key. This is only
- required when authenticating with Programmatic API Keys.
+ description: "Unique 24-hexadecimal digit string that identifies the MongoDB\
+ \ Cloud user that you want to assign the Organization Owner role. This\
+ \ user must be a member of the same organization as the calling API key.\
+ \ If you provide `federationSettingsId`, this user must instead have\
+ \ the Organization Owner role on an organization in the specified federation.\
+ \ This parameter is required only when you authenticate with Programmatic\
+ \ API Keys."
example: 32b6e34b3d91647abb20e7b8
maxLength: 24
minLength: 24
@@ -17588,10 +17649,19 @@ components:
properties:
apiKey:
$ref: '#/components/schemas/ApiApiUserView'
+ federationSettingsId:
+ type: string
+ description: Unique 24-hexadecimal digit string that identifies the federation
+ that you linked the newly created organization to.
+ example: 32b6e34b3d91647abb20e7b8
+ maxLength: 24
+ minLength: 24
+ pattern: "^([a-f0-9]{24})$"
+ readOnly: true
orgOwnerId:
type: string
- description: Unique 24-hexadecimal digit string that identifies the Atlas
- user that you want to assign the Organization Owner role.
+ description: Unique 24-hexadecimal digit string that identifies the MongoDB
+ Cloud user that you assigned the Organization Owner role in the new organization.
example: 32b6e34b3d91647abb20e7b8
maxLength: 24
minLength: 24
@@ -18525,6 +18595,15 @@ components:
items:
$ref: '#/components/schemas/Link'
readOnly: true
+ oidcAuthType:
+ type: string
+ default: NONE
+ description: "Human-readable label that indicates whether the new database\
+ \ user authenticates with OIDC federated authentication. To create a federated\
+ \ authentication user, specify the value of IDP_GROUP for this field."
+ enum:
+ - NONE
+ - IDP_GROUP
password:
type: string
description: "Alphanumeric string that authenticates this database user\
@@ -18563,7 +18642,8 @@ components:
| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |
| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |
| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |
- | SCRAM-SHA | awsType, x509Type, ldapAuthType | NONE | Alphanumeric string |
+ | OIDC | oidcAuthType | IDP_GROUP | Atlas OIDC IdP Identifier (found in Federation Settings, or contact Support), followed by a '/', followed by the IdP group name |
+ | SCRAM-SHA | awsType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |
maxLength: 1024
x509Type:
type: string
@@ -18833,9 +18913,6 @@ components:
the snapshot.
items:
type: string
- description: List that identifies the regions to which MongoDB Cloud copies
- the snapshot.
- readOnly: true
readOnly: true
createdAt:
type: string
@@ -18941,9 +19018,6 @@ components:
type: string
description: Human-readable label that categorizes the cluster as a replica
set or sharded cluster.
- enum:
- - replicaSet
- - shardedCluster
readOnly: true
title: Replica Set Snapshot
ApiAtlasDiskBackupRestoreJobView:
@@ -19083,9 +19157,6 @@ components:
- targetGroupId
ApiAtlasDiskBackupShardedClusterSnapshotMemberView:
type: object
- description: "List that includes the snapshots and the cloud provider that stores\
- \ the snapshots. The resource returns this parameter when `\"type\" : \"SHARDED_CLUSTER\"\
- `."
properties:
cloudProvider:
type: string
@@ -19110,7 +19181,6 @@ components:
description: Human-readable label that identifies the shard or config host
from which MongoDB Cloud took this snapshot.
readOnly: true
- readOnly: true
required:
- cloudProvider
- id
@@ -19242,9 +19312,6 @@ components:
type: string
description: Human-readable label that categorizes the cluster as a replica
set or sharded cluster.
- enum:
- - replicaSet
- - shardedCluster
readOnly: true
title: Sharded Cluster Snapshot
ApiAtlasDiskBackupSnapshotAWSExportBucketView:
@@ -19484,9 +19551,6 @@ components:
type: string
description: Human-readable label that categorizes the cluster as a replica
set or sharded cluster.
- enum:
- - replicaSet
- - shardedCluster
readOnly: true
ApiAtlasDiskGBAutoScalingView:
type: object
@@ -20374,12 +20438,6 @@ components:
description: Cloud service provider that serves the requested network peering
connection.
enum:
- - NONE
- - AWS
- - GCP
- - AZURE
- - FREE
- - SERVERLESS
- AWS
- AZURE
- GCP
@@ -20864,6 +20922,7 @@ components:
description: Type of ingestion destination of this Data Lake Pipeline.
enum:
- DLS
+ readOnly: true
title: Ingestion Destination
ApiAtlasIngestionSourceView:
type: object
@@ -21187,7 +21246,6 @@ components:
type: object
additionalProperties:
$ref: '#/components/schemas/ApiAtlasRegionSpecView'
- deprecated: true
description: Physical location where MongoDB Cloud provisions cluster nodes.
title: Region Configuration
replicationSpecs:
@@ -21228,8 +21286,8 @@ components:
readOnly: true
tags:
type: array
- description: Collection of key-value pairs between 1 to 255 characters in
- length that tag and categorize the cluster.
+ description: List that contains key-value pairs between 1 to 255 characters
+ in length for tagging and categorizing the cluster.
items:
$ref: '#/components/schemas/ApiAtlasTagView'
terminationProtectionEnabled:
@@ -22841,6 +22899,12 @@ components:
- DELETED
- REPAIRING
readOnly: true
+ tags:
+ type: array
+ description: List that contains key-value pairs between 1 to 255 characters
+ in length for tagging and categorizing the serverless instance.
+ items:
+ $ref: '#/components/schemas/ApiAtlasTagView'
terminationProtectionEnabled:
type: boolean
default: false
@@ -22859,6 +22923,12 @@ components:
properties:
serverlessBackupOptions:
$ref: '#/components/schemas/ApiAtlasServerlessBackupOptionsView'
+ tags:
+ type: array
+ description: List that contains key-value pairs between 1 to 255 characters
+ in length for tagging and categorizing the serverless instance.
+ items:
+ $ref: '#/components/schemas/ApiAtlasTagView'
terminationProtectionEnabled:
type: boolean
default: false
@@ -22938,6 +23008,8 @@ components:
readOnly: true
tags:
type: array
+ description: List that contains key-value pairs between 1 to 255 characters
+ in length for tagging and categorizing the serverless instance.
items:
$ref: '#/components/schemas/ApiAtlasTagView'
terminationProtectionEnabled:
@@ -23226,17 +23298,19 @@ components:
- weeklySnapshotRetentionWeeks
ApiAtlasTagView:
type: object
- description: "A key-value pair that tags and categorizes a MongoDB Cloud org,\
- \ project, or cluster"
+ description: "Key-value pair that tags and categorizes a MongoDB Cloud organization,\
+ \ project, or cluster. For example, `environment : production`."
properties:
key:
type: string
- description: Key applied to the tag.
+ description: "Constant that defines the set of the tag. For example, `environment`\
+ \ in the `environment : production` tag."
maxLength: 255
minLength: 1
value:
type: string
- description: Value applied to the tag.
+ description: "Variable that belongs to the set of the tag. For example,\
+ \ `production` in the `environment : production` tag."
maxLength: 255
minLength: 1
title: Resource Tag
@@ -23649,7 +23723,7 @@ components:
- CONFIG_SERVER_REPLICA_SET
readOnly: true
readOnly: true
- ApiCreateApiKeyView:
+ ApiCreateOrganizationApiKeyView:
type: object
properties:
desc:
@@ -23661,8 +23735,29 @@ components:
roles:
type: array
description: "List of roles to grant this API key. If you provide this list,\
- \ provide a minimum of one role and ensure each role applies to this organization\
- \ or project."
+ \ provide a minimum of one role and ensure each role applies to this organization."
+ items:
+ type: string
+ enum:
+ - ORG_OWNER
+ - ORG_MEMBER
+ - ORG_GROUP_CREATOR
+ - ORG_BILLING_ADMIN
+ - ORG_READ_ONLY
+ - ORG_TEAM_MEMBERS_ADMIN
+ ApiCreateProjectApiKeyView:
+ type: object
+ properties:
+ desc:
+ type: string
+ description: Purpose or explanation provided when someone created this project
+ API key.
+ maxLength: 250
+ minLength: 1
+ roles:
+ type: array
+ description: "List of roles to grant this API key. If you provide this list,\
+ \ provide a minimum of one role and ensure each role applies to this project."
items:
type: string
enum:
@@ -23671,6 +23766,21 @@ components:
- ORG_GROUP_CREATOR
- ORG_BILLING_ADMIN
- ORG_READ_ONLY
+ - ORG_TEAM_MEMBERS_ADMIN
+ - GROUP_ATLAS_ADMIN
+ - GROUP_AUTOMATION_ADMIN
+ - GROUP_BACKUP_ADMIN
+ - GROUP_MONITORING_ADMIN
+ - GROUP_OWNER
+ - GROUP_READ_ONLY
+ - GROUP_USER_ADMIN
+ - GROUP_BILLING_ADMIN
+ - GROUP_DATA_ACCESS_ADMIN
+ - GROUP_DATA_ACCESS_READ_ONLY
+ - GROUP_DATA_ACCESS_READ_WRITE
+ - GROUP_CHARTS_ADMIN
+ - GROUP_CLUSTER_MANAGER
+ - GROUP_SEARCH_INDEX_EDITOR
ApiDatabaseView:
type: object
properties:
@@ -29142,6 +29252,7 @@ components:
- ORG_BILLING_ADMIN
- ORG_GROUP_CREATOR
- ORG_OWNER
+ - ORG_BILLING_READ_ONLY
- ORG_TEAM_MEMBERS_ADMIN
- GROUP_AUTOMATION_ADMIN
- GROUP_BACKUP_ADMIN
@@ -29852,6 +29963,12 @@ components:
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
minimum: 5
+ notifierId:
+ type: string
+ description: The notifierId is a system-generated unique identifier assigned
+ to each notification method. This is needed when updating third-party
+ notifications without requiring explicit authentication credentials.
+ example: 6462742adc47d365036da07c
typeName:
type: string
description: Human-readable label that displays the alert notification type.
@@ -30266,6 +30383,7 @@ components:
- AUTO_INDEXING_STALLED_INDEX_BUILD
- AUTO_INDEXING_FAILED_INDEX_BUILD
- AUTO_INDEXING_COMPLETED_INDEX_BUILD
+ - AUTO_INDEXING_STARTED_INDEX_BUILD
title: Auto Indexing Event Types
- type: string
enum:
@@ -30398,6 +30516,11 @@ components:
- INDEX_FAILED_INDEX_BUILD
- INDEX_SUCCESS_INDEX_BUILD
title: Index Build Audit Types
+ - type: string
+ enum:
+ - DB_CHECK_SUBMITTED
+ - DB_CHECK_UPDATED
+ title: NDS DB Check Audit Types
- type: string
enum:
- MAINTENANCE_IN_ADVANCED
@@ -30611,6 +30734,7 @@ components:
- IDENTITY_PROVIDER_UPDATED
- IDENTITY_PROVIDER_DELETED
- IDENTITY_PROVIDER_ACTIVATED
+ - OIDC_IDENTITY_PROVIDER_UPDATED
- IDENTITY_PROVIDER_DEACTIVATED
- IDENTITY_PROVIDER_JWKS_REVOKED
- OIDC_IDENTITY_PROVIDER_ENABLED
@@ -30829,6 +30953,12 @@ components:
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
minimum: 5
+ notifierId:
+ type: string
+ description: The notifierId is a system-generated unique identifier assigned
+ to each notification method. This is needed when updating third-party
+ notifications without requiring explicit authentication credentials.
+ example: 6462742adc47d365036da07c
typeName:
type: string
description: Human-readable label that displays the alert notification type.
@@ -30973,6 +31103,7 @@ components:
- AUTO_INDEXING_STALLED_INDEX_BUILD
- AUTO_INDEXING_FAILED_INDEX_BUILD
- AUTO_INDEXING_COMPLETED_INDEX_BUILD
+ - AUTO_INDEXING_STARTED_INDEX_BUILD
title: Auto Indexing Event Types
- type: string
enum:
@@ -31119,6 +31250,7 @@ components:
- FTS_INDEX_CREATED
- FTS_INDEX_UPDATED
- FTS_INDEX_DELETED
+ - FTS_INDEXES_RESTORED
title: FTS Index Audit Types
- type: string
enum:
@@ -31367,6 +31499,11 @@ components:
- DATA_API_SETUP_FOR_VERCEL
- ADMIN_CLUSTER_LOCK_UPDATED
title: NDS Audit Types
+ - type: string
+ enum:
+ - DB_CHECK_SUBMITTED
+ - DB_CHECK_UPDATED
+ title: NDS DB Check Audit Types
- type: string
enum:
- COMPUTE_AUTO_SCALE_INITIATED
@@ -31622,6 +31759,7 @@ components:
- IDENTITY_PROVIDER_UPDATED
- IDENTITY_PROVIDER_DELETED
- IDENTITY_PROVIDER_ACTIVATED
+ - OIDC_IDENTITY_PROVIDER_UPDATED
- IDENTITY_PROVIDER_DEACTIVATED
- IDENTITY_PROVIDER_JWKS_REVOKED
- OIDC_IDENTITY_PROVIDER_ENABLED
@@ -31858,6 +31996,7 @@ components:
- FTS_INDEX_CREATED
- FTS_INDEX_UPDATED
- FTS_INDEX_DELETED
+ - FTS_INDEXES_RESTORED
example: FTS_INDEX_CREATED
title: FTS Index Audit Types
FTSIndexAuditView:
@@ -32230,6 +32369,12 @@ components:
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
minimum: 5
+ notifierId:
+ type: string
+ description: The notifierId is a system-generated unique identifier assigned
+ to each notification method. This is needed when updating third-party
+ notifications without requiring explicit authentication credentials.
+ example: 6462742adc47d365036da07c
roles:
type: array
description: "List that contains the one or more [organization](https://dochub.mongodb.org/core/atlas-org-roles)\
@@ -32328,6 +32473,12 @@ components:
* Query the alert for the notification through the Atlas Administration API.
example: '************************************1234'
+ notifierId:
+ type: string
+ description: The notifierId is a system-generated unique identifier assigned
+ to each notification method. This is needed when updating third-party
+ notifications without requiring explicit authentication credentials.
+ example: 6462742adc47d365036da07c
roomName:
type: string
description: "HipChat API room name to which MongoDB Cloud sends alert notifications.\
@@ -33902,6 +34053,7 @@ components:
partialFilterExpression:
type: object
additionalProperties:
+ type: object
description: |-
Rules that limit the documents that the index references to a filter expression. All MongoDB index types accept a **partialFilterExpression** option. **partialFilterExpression** can include following expressions:
@@ -34311,6 +34463,12 @@ components:
**NOTE**: When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted.
example: https://webhook.com/****
+ notifierId:
+ type: string
+ description: The notifierId is a system-generated unique identifier assigned
+ to each notification method. This is needed when updating third-party
+ notifications without requiring explicit authentication credentials.
+ example: 6462742adc47d365036da07c
typeName:
type: string
description: Human-readable label that displays the alert notification type.
@@ -34897,6 +35055,12 @@ components:
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
minimum: 5
+ notifierId:
+ type: string
+ description: The notifierId is a system-generated unique identifier assigned
+ to each notification method. This is needed when updating third-party
+ notifications without requiring explicit authentication credentials.
+ example: 6462742adc47d365036da07c
severity:
type: string
description: Degree of seriousness given to this notification.
@@ -35655,6 +35819,12 @@ components:
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
minimum: 5
+ notifierId:
+ type: string
+ description: The notifierId is a system-generated unique identifier assigned
+ to each notification method. This is needed when updating third-party
+ notifications without requiring explicit authentication credentials.
+ example: 6462742adc47d365036da07c
opsGenieApiKey:
type: string
description: |-
@@ -35966,6 +36136,12 @@ components:
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
minimum: 5
+ notifierId:
+ type: string
+ description: The notifierId is a system-generated unique identifier assigned
+ to each notification method. This is needed when updating third-party
+ notifications without requiring explicit authentication credentials.
+ example: 6462742adc47d365036da07c
roles:
type: array
description: "List that contains the one or more [organization](https://dochub.mongodb.org/core/atlas-org-roles)\
@@ -36053,6 +36229,12 @@ components:
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
minimum: 5
+ notifierId:
+ type: string
+ description: The notifierId is a system-generated unique identifier assigned
+ to each notification method. This is needed when updating third-party
+ notifications without requiring explicit authentication credentials.
+ example: 6462742adc47d365036da07c
region:
type: string
default: US
@@ -38349,6 +38531,12 @@ components:
\ The resource requires this parameter when `\"notifications.[n].typeName\"\
\ : \"SMS\"`."
example: "1233337892"
+ notifierId:
+ type: string
+ description: The notifierId is a system-generated unique identifier assigned
+ to each notification method. This is needed when updating third-party
+ notifications without requiring explicit authentication credentials.
+ example: 6462742adc47d365036da07c
typeName:
type: string
description: Human-readable label that displays the alert notification type.
@@ -38627,6 +38815,12 @@ components:
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
minimum: 5
+ notifierId:
+ type: string
+ description: The notifierId is a system-generated unique identifier assigned
+ to each notification method. This is needed when updating third-party
+ notifications without requiring explicit authentication credentials.
+ example: 6462742adc47d365036da07c
typeName:
type: string
description: Human-readable label that displays the alert notification type.
@@ -38728,6 +38922,12 @@ components:
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
minimum: 5
+ notifierId:
+ type: string
+ description: The notifierId is a system-generated unique identifier assigned
+ to each notification method. This is needed when updating third-party
+ notifications without requiring explicit authentication credentials.
+ example: 6462742adc47d365036da07c
typeName:
type: string
description: Human-readable label that displays the alert notification type.
@@ -39048,6 +39248,12 @@ components:
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
minimum: 5
+ notifierId:
+ type: string
+ description: The notifierId is a system-generated unique identifier assigned
+ to each notification method. This is needed when updating third-party
+ notifications without requiring explicit authentication credentials.
+ example: 6462742adc47d365036da07c
smsEnabled:
type: boolean
description: |-
@@ -39762,6 +39968,12 @@ components:
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
minimum: 5
+ notifierId:
+ type: string
+ description: The notifierId is a system-generated unique identifier assigned
+ to each notification method. This is needed when updating third-party
+ notifications without requiring explicit authentication credentials.
+ example: 6462742adc47d365036da07c
smsEnabled:
type: boolean
description: |-
@@ -39846,6 +40058,12 @@ components:
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
minimum: 5
+ notifierId:
+ type: string
+ description: The notifierId is a system-generated unique identifier assigned
+ to each notification method. This is needed when updating third-party
+ notifications without requiring explicit authentication credentials.
+ example: 6462742adc47d365036da07c
typeName:
type: string
description: Human-readable label that displays the alert notification type.
@@ -39891,6 +40109,12 @@ components:
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
minimum: 5
+ notifierId:
+ type: string
+ description: The notifierId is a system-generated unique identifier assigned
+ to each notification method. This is needed when updating third-party
+ notifications without requiring explicit authentication credentials.
+ example: 6462742adc47d365036da07c
typeName:
type: string
description: Human-readable label that displays the alert notification type.
diff --git a/tools/transformer/src/atlasTransformations.js b/tools/transformer/src/atlasTransformations.js
index 17ad5028..7e5f7e64 100644
--- a/tools/transformer/src/atlasTransformations.js
+++ b/tools/transformer/src/atlasTransformations.js
@@ -3,7 +3,6 @@ const {
applyOneOfTransformations,
applyModelNameTransformations,
applyDiscriminatorTransformations,
- applyArrayTransformations,
transformOneOfProperties,
applyRemoveEnumsTransformations,
applyRemoveObjectAdditonalProperties,
@@ -84,12 +83,6 @@ module.exports = function runTransformations(openapi) {
openapi.components.schemas.Error.properties.parameters.items = {};
}
- // Temp workaround for CLOUDP-170462
- openapi = applyArrayTransformations(openapi, [
- "EventTypeForNdsGroup",
- "EventTypeForOrg",
- ]);
-
applyRemoveEnumsTransformations(openapi);
applyRemoveObjectAdditonalProperties(openapi);