Docs Menu
Docs Home
/
MongoDB Atlas
/
Atlas CLI
/
Atlas CLI Reference
/
JSON Configuration Files

Federated Authentication Configuration File

On this page

  • Available Settings
  • Create a Configuration File

You can use a federated authentication configuration file to specify the settings required when you update connected organizations for federated authentication using the Atlas CLI. The Atlas CLI accepts .json federated authentication configuration files.

Available Settings

When you update connected organizations for federated authentication using a configuration file, you can specify any settings that are listed in Update One Org Config Connected to One Federation under Request Body Schema.

Create a Configuration File

Follow these steps to update connected organizations for federated authentication with a configuration file:

1

Copy the sample request for Update One Org Config Connected to One Federation.

  1. Navigate to the Update One Org Config Connected to One Federation section of the Atlas Admin API specification.

  2. Under Request samples on the right side, click Expand all.

  3. Click Copy to copy the sample request.

2

Create the configuration file.

  1. Paste the sample request into a text editor and change the values to reflect your desired configuration.

  2. Save the file with a .json extension.

3

Run the atlas federatedAuthentication federationSettings connectedOrgConfigs update command with the --file option.

Specify the path to the file you saved with the --file flag.

Back

Project