UpdateOrganizationRequest

UpdateOrganizationRequest
UpdateOrganizationRequest

Organization details to be updated

JSON Example 
{
    "language": "string",
    "displayName": "string",
    "customerId": "string",
    "type": "string",
    "enforceUserApiTokenMfa": false,
    "auditLogsInstanceId": "string",
    "isMfaRequired": false,
    "locale": "string"
}
string
language
Optional

Default locale lang code preference for the organization.

string
displayName
Optional
Constraints: minLength: 0 maxLength: 200

Display name must be alphanumerical and can contain the following symbols -_.`':@&, and space. International characters are allowed.

string
customerId
Optional

The Broadcom ERP customer id

string
type
Optional

Organization type. The type can be changed only by the Platform operator

boolean
enforceUserApiTokenMfa
Optional

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/activate
  • POST /am/api/orgs/{orgId}/mfa-api-token-policy/deactivate
  • GET  /am/api/orgs/{orgId}/mfa-api-token-policy

Note: Please use Authn sdk instead of AM sdk for MFA related Apis.

string
auditLogsInstanceId
Optional
Constraints: minLength: 0 maxLength: 255

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.

boolean
isMfaRequired
Optional

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/activate
  • POST /am/api/orgs/{orgId}/mfa-policy/deactivate
  • GET  /am/api/orgs/{orgId}/mfa-policy

Note: Please use Authn sdk instead of AM sdk for MFA related Apis.

string
locale
Optional

Default locale lang country preference for the organization.

Parameter To