# Update One Organization Configuration in One Federation

**PATCH /api/atlas/v1.0/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}**

Updates one connected organization configuration from the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. 

**Note** If the organization configuration has no associated identity provider, you can't use this resource to update role mappings or post authorization role grants.  

**Note**: The domainRestrictionEnabled field defaults to false if not provided in the request. 

**Note**: If the identityProviderId field is not provided, you will disconnect the organization and the identity provider. 

**Note**: Currently connected data access identity providers missing from the dataAccessIdentityProviderIds field will be disconnected.


## Servers
- https://cloud.mongodb.com: https://cloud.mongodb.com ()


## Authentication methods
- Service accounts
- Digest auth


## Parameters

#### Path parameters
- **federationSettingsId** (string)
  Unique 24-hexadecimal digit string that identifies your federation.
- **orgId** (string)
  Unique 24-hexadecimal digit string that identifies the connected organization configuration to update.

#### Query parameters
- **envelope** (boolean)
  Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

## Body parameters
Content-type: application/json
The connected organization configuration that you want to update.
- **dataAccessIdentityProviderIds** (array[string])
  The collection of unique ids representing the identity providers that can be used for data access in this organization.
- **domainAllowList** (array[string])
  Approved domains that restrict users who can join the organization based on their email address.
- **domainRestrictionEnabled** (boolean)
  Value that indicates whether domain restriction is enabled for this connected org.
- **identityProviderId** (string)
  Legacy 20-hexadecimal digit string that identifies the UI access identity provider that this connected org config is associated with. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider.
- **postAuthRoleGrants** (array[string])
  Atlas roles that are granted to a user in this organization after authenticating. Roles are a human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific MongoDB Cloud user. These roles can only be organization specific roles.
- **roleMappings** (array[object])
  Role mappings that are configured in this organization.
- **userConflicts** (array[object])
  List that contains the users who have an email address that doesn't match any domain on the allowed list.

## Responses
### 200: OK

#### Body Parameters: application/json (object)
- **dataAccessIdentityProviderIds** (array[string])
  The collection of unique ids representing the identity providers that can be used for data access in this organization.
- **domainAllowList** (array[string])
  Approved domains that restrict users who can join the organization based on their email address.
- **domainRestrictionEnabled** (boolean)
  Value that indicates whether domain restriction is enabled for this connected org.
- **identityProviderId** (string)
  Legacy 20-hexadecimal digit string that identifies the UI access identity provider that this connected org config is associated with. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider.
- **orgId** (string)
  Unique 24-hexadecimal digit string that identifies the connected organization configuration.
- **postAuthRoleGrants** (array[string])
  Atlas roles that are granted to a user in this organization after authenticating. Roles are a human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific MongoDB Cloud user. These roles can only be organization specific roles.
- **roleMappings** (array[object])
  Role mappings that are configured in this organization.
- **userConflicts** (array[object])
  List that contains the users who have an email address that doesn't match any domain on the allowed list.

### 400: Bad Request.

#### Body Parameters: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **errorCode** (string)
  Application error code returned with this error.
- **parameters** (array[object])
  Parameters used to give more information about the error.
- **reason** (string)
  Application error message returned with this error.

### 401: Unauthorized.

#### Body Parameters: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **errorCode** (string)
  Application error code returned with this error.
- **parameters** (array[object])
  Parameters used to give more information about the error.
- **reason** (string)
  Application error message returned with this error.

### 403: Forbidden.

#### Body Parameters: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **errorCode** (string)
  Application error code returned with this error.
- **parameters** (array[object])
  Parameters used to give more information about the error.
- **reason** (string)
  Application error message returned with this error.

### 404: Not Found.

#### Body Parameters: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **errorCode** (string)
  Application error code returned with this error.
- **parameters** (array[object])
  Parameters used to give more information about the error.
- **reason** (string)
  Application error message returned with this error.

### 500: Internal Server Error.

#### Body Parameters: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **errorCode** (string)
  Application error code returned with this error.
- **parameters** (array[object])
  Parameters used to give more information about the error.
- **reason** (string)
  Application error message returned with this error.


[Powered by Bump.sh](https://bump.sh)