Docs Menu
Docs Home
/
MongoDB Atlas
/
Atlas CLI
/
Commands
/
api
/
federatedAuthentication

atlas api federatedAuthentication updateConnectedOrgConfig

On this page

  • Syntax
  • Options
  • Inherited Options

Public Preview: please provide feedback at: Updates one connected organization configuration from the specified federation.

To use this resource, the requesting Service Account or API Key must have the Organization Owner role.

Note If the organization configuration has no associated identity provider, you can't use this resource to update role mappings or post authorization role grants.

Note: The domainRestrictionEnabled field defaults to false if not provided in the request.

Note: If the identityProviderId field is not provided, you will disconnect the organization and the identity provider.

Note: Currently connected data access identity providers missing from the dataAccessIdentityProviderIds field will be disconnected.

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateConnectedOrgConfig.

For more information and examples, see the referenced API documentation linked above.

Syntax

Command Syntax
atlas api federatedAuthentication updateConnectedOrgConfig [options]

Options

Name
Type
Required
Description

--envelope

envelope

false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

--federationSettingsId

string

true

Unique 24-hexadecimal digit string that identifies your federation.

--file

string

false

path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both.

-h, --help

false

help for updateConnectedOrgConfig

--orgId

string

true

Unique 24-hexadecimal digit string that identifies the connected organization configuration to update.

--output

string

false

preferred api format, can be ["json", go-template] This value defaults to "json".

--output-file

string

false

file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip)

--version

string

false

api version to use when calling the api call [options: "2023-01-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-01-01".

Inherited Options

Name
Type
Required
Description

-P, --profile

string

false

Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.

Back

revokeJwksFromIdentityProvider

Next

updateIdentityProvider