- API >
- Cloud Manager Administration API Resources >
- Federated Authentication Configuration >
- Update One Connected Organization
Update One Connected Organization¶
On this page
The federationSettings
resource allows you to update one
connected organization
for a federated authentication configuration.
Base URL: https://cloud.mongodb.com/api/public/v1.0
Required Roles¶
You must have the Organization Owner
role 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. |
ORG-ID |
string | Unique 24-hexadecimal digit string that identifies the connected organization. |
Request Query Parameters¶
The following query parameters are optional:
Name | Type | Necessity | Description | Default | ||||||
---|---|---|---|---|---|---|---|---|---|---|
pretty | boolean | Optional | Flag indicating 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 one result, the response body includes:
|
false |
Request Body Parameters¶
Name | Type | Necessity | Description |
---|---|---|---|
domainAllowList |
array | Optional | List that contains the approved domains from which organization users can log in. If you provide a |
domainRestrictionEnabled |
boolean | Required | Flag that indicates whether domain restriction is enabled for the connected organization. |
identityProviderId |
string | Required | Unique 20-hexadecimal digit string that identifies the identity provider associated with the connected organization. If omitted or if the value is |
orgId |
string | Required | Unique 24-hexadecimal digit string that identifies the connected organization. |
postAuthRoleGrants |
array | Optional | List that contains the default roles granted to users who authenticate through the IdP in a connected organization. If you provide a |
roleMappings |
array | Optional | List that contains the role mappings configured in this organization. If you provide a |
Response¶
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
|
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
|