Skip to content

Commit 91bd8d1

Browse files
blvaandreaangiolillotibulcajwilliams-mongo
authored
CLOUDP-244267: Add connect and disconnect commands (#2885)
Co-authored-by: Andrea Angiolillo <[email protected]> Co-authored-by: Ciprian Tibulca <[email protected]> Co-authored-by: John Williams <[email protected]>
1 parent 556894a commit 91bd8d1

15 files changed

+938
-0
lines changed

‎docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-connect.txt

+91
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
.. _atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-connect:
2+
3+
============================================================================
4+
atlas federatedAuthentication federationSettings connectedOrgConfigs connect
5+
============================================================================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
Connect an Identity Provider to an Organization.
16+
17+
Syntax
18+
------
19+
20+
.. code-block::
21+
:caption: Command Syntax
22+
23+
atlas federatedAuthentication federationSettings connectedOrgConfigs connect [options]
24+
25+
.. Code end marker, please don't delete this comment
26+
27+
Options
28+
-------
29+
30+
.. list-table::
31+
:header-rows: 1
32+
:widths: 20 10 10 60
33+
34+
* - Name
35+
- Type
36+
- Required
37+
- Description
38+
* - --federationSettingsId
39+
- string
40+
- true
41+
- Unique identifier of the federation settings.
42+
* - -h, --help
43+
-
44+
- false
45+
- help for connect
46+
* - --identityProviderId
47+
- string
48+
- true
49+
- Unique identifier of the identity provider.
50+
* - --orgId
51+
- string
52+
- false
53+
- Organization ID to use. This option overrides the settings in the configuration file or environment variable.
54+
* - -o, --output
55+
- string
56+
- false
57+
- Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option.
58+
* - --protocol
59+
- string
60+
- false
61+
- Protocol used to authenticate the user. Valid value is OIDC or SAML. This value defaults to "OIDC".
62+
63+
Inherited Options
64+
-----------------
65+
66+
.. list-table::
67+
:header-rows: 1
68+
:widths: 20 10 10 60
69+
70+
* - Name
71+
- Type
72+
- Required
73+
- Description
74+
* - -P, --profile
75+
- string
76+
- false
77+
- 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.
78+
79+
Examples
80+
--------
81+
82+
.. code-block::
83+
84+
# Connect the current profile org to identity provider with ID 5d1113b25a115342acc2d1aa and federationSettingsId 5d1113b25a115342acc2d1aa
85+
atlas federatedAuthentication connectedOrgs connect --identityProviderId 5d1113b25a115342acc2d1aa --federationSettingsId 5d1113b25a115342acc2d1aa
86+
87+
.. code-block::
88+
89+
# Connect the org with ID 7d1113b25a115342acc2d1aa to identity provider with ID 5d1113b25a115342acc2d1aa and federationSettingsId 5d1113b25a115342acc2d1aa
90+
atlas federatedAuthentication connectedOrgs connect --orgId 7d1113b25a115342acc2d1aa --identityProviderId 5d1113b25a115342acc2d1aa --federationSettingsId 5d1113b25a115342acc2d1aa
91+

‎docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-disconnect.txt

+100
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
.. _atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-disconnect:
2+
3+
===============================================================================
4+
atlas federatedAuthentication federationSettings connectedOrgConfigs disconnect
5+
===============================================================================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
Connect an Identity Provider to an Organization.
16+
17+
Syntax
18+
------
19+
20+
.. code-block::
21+
:caption: Command Syntax
22+
23+
atlas federatedAuthentication federationSettings connectedOrgConfigs disconnect [options]
24+
25+
.. Code end marker, please don't delete this comment
26+
27+
Options
28+
-------
29+
30+
.. list-table::
31+
:header-rows: 1
32+
:widths: 20 10 10 60
33+
34+
* - Name
35+
- Type
36+
- Required
37+
- Description
38+
* - --federationSettingsId
39+
- string
40+
- true
41+
- Unique identifier of the federation settings.
42+
* - -h, --help
43+
-
44+
- false
45+
- help for disconnect
46+
* - --identityProviderId
47+
- string
48+
- true
49+
- Unique identifier of the identity provider.
50+
* - --orgId
51+
- string
52+
- false
53+
- Organization ID to use. This option overrides the settings in the configuration file or environment variable.
54+
* - -o, --output
55+
- string
56+
- false
57+
- Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option.
58+
* - --protocol
59+
- string
60+
- false
61+
- Protocol used to authenticate the user. Valid value is OIDC or SAML. This value defaults to "OIDC".
62+
63+
Inherited Options
64+
-----------------
65+
66+
.. list-table::
67+
:header-rows: 1
68+
:widths: 20 10 10 60
69+
70+
* - Name
71+
- Type
72+
- Required
73+
- Description
74+
* - -P, --profile
75+
- string
76+
- false
77+
- 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.
78+
79+
Output
80+
------
81+
82+
If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.
83+
84+
.. code-block::
85+
86+
Org Configs disconnected.
87+
88+
Examples
89+
--------
90+
91+
.. code-block::
92+
93+
# Disconnect the current profile org from identity provider with ID 5d1113b25a115342acc2d1aa and federationSettingsId 5d1113b25a115342acc2d1aa
94+
atlas federatedAuthentication connectedOrgs disconnect --identityProviderId 5d1113b25a115342acc2d1aa --federationSettingsId 5d1113b25a115342acc2d1aa
95+
96+
.. code-block::
97+
98+
# Connect the org with ID 7d1113b25a115342acc2d1aa to identity provider with ID 5d1113b25a115342acc2d1aa and federationSettingsId 5d1113b25a115342acc2d1aa
99+
atlas federatedAuthentication connectedOrgs disconnect --orgId 7d1113b25a115342acc2d1aa --identityProviderId 5d1113b25a115342acc2d1aa --federationSettingsId 5d1113b25a115342acc2d1aa
100+

‎docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs.txt

+61
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
.. _atlas-federatedAuthentication-federationSettings-connectedOrgConfigs:
2+
3+
====================================================================
4+
atlas federatedAuthentication federationSettings connectedOrgConfigs
5+
====================================================================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
Manage Atlas Federated Authentication Connected Orgs Config
16+
17+
Options
18+
-------
19+
20+
.. list-table::
21+
:header-rows: 1
22+
:widths: 20 10 10 60
23+
24+
* - Name
25+
- Type
26+
- Required
27+
- Description
28+
* - -h, --help
29+
-
30+
- false
31+
- help for connectedOrgConfigs
32+
33+
Inherited Options
34+
-----------------
35+
36+
.. list-table::
37+
:header-rows: 1
38+
:widths: 20 10 10 60
39+
40+
* - Name
41+
- Type
42+
- Required
43+
- Description
44+
* - -P, --profile
45+
- string
46+
- false
47+
- 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.
48+
49+
Related Commands
50+
----------------
51+
52+
* :ref:`atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-connect` - Connect an Identity Provider to an Organization.
53+
* :ref:`atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-disconnect` - Connect an Identity Provider to an Organization.
54+
55+
56+
.. toctree::
57+
:titlesonly:
58+
59+
connect </command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-connect>
60+
disconnect </command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-disconnect>
61+

‎docs/command/atlas-federatedAuthentication-federationSettings.txt

+2
Original file line numberDiff line numberDiff line change
@@ -49,13 +49,15 @@ Inherited Options
4949
Related Commands
5050
----------------
5151

52+
* :ref:`atlas-federatedAuthentication-federationSettings-connectedOrgConfigs` - Manage Atlas Federated Authentication Connected Orgs Config
5253
* :ref:`atlas-federatedAuthentication-federationSettings-describe` - Return the Federation Settings details for the specified organization.
5354
* :ref:`atlas-federatedAuthentication-federationSettings-identityProvider` - Manage Federated Authentication Identity Providers.
5455

5556

5657
.. toctree::
5758
:titlesonly:
5859

60+
connectedOrgConfigs </command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs>
5961
describe </command/atlas-federatedAuthentication-federationSettings-describe>
6062
identityProvider </command/atlas-federatedAuthentication-federationSettings-identityProvider>
6163

0 commit comments

Comments
 (0)