Return All Connected Organizations¶
On this page
-
Required Roles
-
Resource
-
Request Path Parameters
-
Request Query Parameters
-
Request Body Parameters
-
Response
-
Response Document
-
results Embedded Document
-
Example Request
-
Example Response
The
federationSettings
resource allows you to return all
connected organizations
for a
federated authentication configuration.
Base URL:
https://cloud.mongodb.com/api/public/v1.0
Required Roles¶
You must have the
Organization
Owner
role for at least one
connected organization in the federation configuration to call this
endpoint.
Resource¶
Request Path Parameters¶
Name
|
Type
|
Description
|
FEDERATION-SETTINGS-ID
|
string
|
Unique 24-hexadecimal digit string that identifies the federated
authentication configuration.
|
Request Query Parameters¶
The following query parameters are optional:
Name
|
Type
|
Necessity
|
Description
|
Default
|
pageNum
|
number
|
Optional
|
One-based integer that returns a subsection of results.
|
1
|
itemsPerPage
|
number
|
Optional
|
Number of items to return per page, up to a maximum of 500.
|
100
|
pretty
|
boolean
|
Optional
|
Flag that indicates whether the response body should be in a
prettyprint format.
|
false
|
envelope
|
boolean
|
Optional
|
Flag that indicates whether or not to wrap the response in an
envelope.
Some
API
clients cannot access the
HTTP
response headers or
status code. To remediate this, set
envelope
:
true
in the
query.
For endpoints that return a list of results, the
results
object is an envelope. Cloud Manager adds the
status
field to the
response body.
|
false
|
Request Body Parameters¶
This endpoint does not use HTTP request body parameters.
Response¶
Response Document¶
The response
JSON
document includes an array of
result
objects, an array of
link
objects and a count of the total
number of
result
objects retrieved.
Name
|
Type
|
Description
|
results
|
array of objects
|
One object for each item detailed in the
results Embedded Document section.
|
links
|
array of objects
|
One or more links to sub-resources and/or related resources. All
links
arrays in responses include at least one link called
self
. The relationships between
URL
s are explained in the
Web Linking Specification
.
|
totalCount
|
integer
|
Count of the total number of items in the result set. It may
be greater than the number of objects in the
results
array if the entire result set is paginated.
|
results Embedded Document¶
Each document in the
result
array contains the federated
authentication configuration for each connected organization.
Name
|
Type
|
Description
|
domainAllowList
|
array
|
List that contains the approved domains from which organization
users can log in.
|
domainRestrictionEnabled
|
boolean
|
Flag that indicates whether domain restriction is enabled for
the connected organization.
Note
userConflicts
returns
null
when
"domainRestrictionEnabled":
false
.
|
identityProviderId
|
string
|
Unique 20-hexadecimal digit string that identifies the identity
provider associated with the connected organization.
|
orgId
|
string
|
Unique 24-hexadecimal digit string that identifies the
connected organization.
|
postAuthRoleGrants
|
array
|
List that contains the default
roles
granted to users who authenticate through the
IdP
in a
connected organization.
|
roleMappings
|
array
|
List that contains the role mappings configured in this
organization.
|
userConflicts
|
array
|
List that contains the usernames that don’t match any domain on
the allowed list.
Note
userConflicts
returns
null
when
"domainRestrictionEnabled":
false
.
|
Stay Ahead in Today’s Competitive Market!
Unlock your company’s full potential with a Virtual Delivery Center (VDC). Gain specialized expertise, drive
seamless operations, and scale effortlessly for long-term success.
Book A Meeting To Setup A VDC