Skip to content

Commit 1ef74e5

Browse files
authored
(DOCSP-39284) Adds example config for federated auth connected orgs. (#379) (#380)
1 parent b98ecc4 commit 1ef74e5

File tree

2 files changed

+56
-0
lines changed

2 files changed

+56
-0
lines changed

source/reference/json.txt

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ you can pass a configuration file when using the {+atlas-cli+} to:
2626
:ref:`update an alert configuration <atlas-alerts-settings-update>`.
2727
- :ref:`Create a rolling index <atlas-clusters-indexes-create>` for a cluster.
2828
- :ref:`Update a project <atlas-projects-update>`
29+
- :ref:`Update connected organizations for federated authentication <atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-update>`.
2930

3031
Usage
3132
-----
@@ -81,6 +82,9 @@ command. The commands you can use include but are not limited to:
8182
* - :ref:`atlas-projects-update`
8283
- :oas-atlas-tag:`Update One Project </Projects/operation/updateProject>`
8384

85+
* - :ref:`atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-update`
86+
- :oas-atlas-tag:`Update One Org Config Connected to One Federation </Federated-Authentication/operation/updateConnectedOrgConfig>`
87+
8488
When you run the command in your terminal, specify the ``--file`` option
8589
and provide the path to the |json| configuration file that defines your
8690
desired settings.
@@ -175,6 +179,13 @@ To learn more about project configuration files, see
175179
:ref:`atlas-cli-project-config-file`. To learn the syntax for a file,
176180
see :ref:`example-project-config-file`.
177181

182+
Federated Authentication Configuration File
183+
-------------------------------------------
184+
185+
To learn more about federated authentication configuration files, see
186+
:ref:`federated-auth-config-file`. To learn the syntax for a file,
187+
see :ref:`example-connected-org-config-file`.
188+
178189

179190
.. toctree::
180191
:titlesonly:
@@ -188,3 +199,4 @@ see :ref:`example-project-config-file`.
188199
Alert </reference/json/alert-config-file>
189200
Rolling Index </reference/json/rolling-index-config-file>
190201
Project </reference/json/project-config-file>
202+
Federated Authentication </reference/json/connected-org-config-file>
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
.. _federated-auth-config-file:
2+
3+
===========================================
4+
Federated Authentication Configuration File
5+
===========================================
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
12+
13+
.. facet::
14+
:name: genre
15+
:values: tutorial
16+
17+
.. To create a configuration file doc, copy this template, change
18+
.. the replacements below, and update the H1 title and refs.
19+
20+
.. |atlas-cli command| replace:: :ref:`atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-update`
21+
.. |configuration-file-name| replace:: federated authentication configuration
22+
.. |openapi-link| replace:: :oas-atlas-tag:`Update One Org Config Connected to One Federation </Federated-Authentication/operation/updateConnectedOrgConfig>`
23+
.. |action| replace:: update connected organizations for federated authentication
24+
25+
You can use a |configuration-file-name| file to specify the
26+
settings required when you |action|
27+
using the {+atlas-cli+}. The {+atlas-cli+} accepts ``.json``
28+
|configuration-file-name| files.
29+
30+
.. _connected-org-settings:
31+
32+
Available Settings
33+
------------------
34+
35+
When you |action| using a configuration file, you
36+
can specify any settings that are listed in
37+
|openapi-link| under :guilabel:`Request Body Schema`.
38+
39+
.. _example-connected-org-config-file:
40+
41+
Create a Configuration File
42+
---------------------------
43+
44+
.. include:: /includes/steps-config-file-template.rst

0 commit comments

Comments
 (0)