Update Organization By Organization Id Using PATCH
Update organization details.
Note: The type of the organization can only be changed by the Platform operator. If you want to reset the organization type pass an empty string.
Access Policy
| Role | User Accounts | Service Accounts (Client Credentials Applications) |
|---|---|---|
| Organization Admin | ✔️ | ✔️ |
| Organization Owner | ✔️ | ✔️ |
Unique identifier (GUID) of the organization.
"UpdateOrganizationRequest Object"Default locale lang code preference for the organization.
Display name must be alphanumerical and can contain the following symbols -_.`':@&, and space. International characters are allowed.
The Broadcom ERP customer id
Organization type. The type can be changed only by the Platform operator
Flag to enforce the user Api token multi-factor authentication (MFA).
If enabled then user needs to provide additional multi-factor authentication passcode when exchange API token for AccessToken.
Important:
Parameter enforceUserApiTokenMfa is no longer supported. Please use below mentioned APIs to manage MFA Api Token Policy.
POST /am/api/orgs/{orgId}/mfa-api-token-policy/activatePOST /am/api/orgs/{orgId}/mfa-api-token-policy/deactivateGET /am/api/orgs/{orgId}/mfa-api-token-policy
Note: Please use Authn sdk instead of AM sdk for MFA related Apis.
The instance of the LINT service in the region to which we will redirect audit logs. The organization must already have been granted access to the LINT service and assigned to one or more LINT service instances. To reset, send empty string.
If the flag is enabled, vmwid users will be able to login only when they enabled multi-factor authentication (MFA).
Important:
Parameter isMfaRequired is no longer supported. Please use below mentioned APIs to update MFA setting for an Org"
POST /am/api/orgs/{orgId}/mfa-policy/activatePOST /am/api/orgs/{orgId}/mfa-policy/deactivateGET /am/api/orgs/{orgId}/mfa-policy
Note: Please use Authn sdk instead of AM sdk for MFA related Apis.
Default locale lang country preference for the organization.
OK
{
"refLink": "string"
}Relative reference link to the resource.
Missing required parameters or invalid parameters in request body returns a 400 (bad request) status code
"CspErrorResponse Object"cspErrorCode
message
errorCode
requestId
moduleCode
statusCode
The user is not authorized to use the API
"CspErrorResponse Object"cspErrorCode
message
errorCode
requestId
moduleCode
statusCode
The user is forbidden to use the API
"CspErrorResponse Object"cspErrorCode
message
errorCode
requestId
moduleCode
statusCode
Organization with this identifier is not found.
"CspErrorResponse Object"cspErrorCode
message
errorCode
requestId
moduleCode
statusCode
The request could not be processed due to a conflict
"CspErrorResponse Object"cspErrorCode
message
errorCode
requestId
moduleCode
statusCode
The user has sent too many requests
"CspErrorResponse Object"cspErrorCode
message
errorCode
requestId
moduleCode
statusCode
An unexpected error has occurred while processing the request
"CspErrorResponse Object"cspErrorCode
message
errorCode
requestId
moduleCode
statusCode
curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]'