[{"label":"Latest (v1.0)","version":"latest"}]
csp

Update Organization By Organization ID

Description

Update organization details.

Access Policy

Role User Accounts Service Accounts (Client Credentials Applications)
Organization Owner ✔️

Request

Request

URL

URL


patch
https://{api_host}/csp/gateway/am/api/orgs/{orgId}
Copy

Path Parameters

Path Parameters

string
orgId Required

Unique identifier (GUID) of the organization.

Parameter Serialization Style: simple Explode:false

Request Body

Request Body

UpdateOrganizationRequest of mimetype application/json Required
{
	"auditLogsInstanceId": "string",
	"displayName": "string",
	"enforceUserApiTokenMfa": false,
	"isMfaRequired": false,
	"language": "string",
	"locale": "string"
}
string
auditLogsInstanceId Optional

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.


string
displayName Optional

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


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.


boolean
isMfaRequired Optional

If the flag is enabled, vmwid users will be able to login only when they enabled multi-factor authentication (MFA).


string
language Optional

Default locale lang code preference for the organization.


string
locale Optional

Default locale lang country preference for the organization.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns RefLinkDto of type application/json
{
	"refLink": "string"
}
string
refLink Optional

Relative reference link to the resource.

Errors

Errors

400

Missing required parameters or invalid parameters in request body returns a 400 (bad request) status code


401

The user is not authorized to use the API


403

The user is forbidden to use the API


404

Organization with this identifier is not found.


409

The request could not be processed due to a conflict


429

The user has sent too many requests


500

An unexpected error has occurred while processing the request

Code Samples

Code Samples

cURL Command

curl -X PATCH -H "Content-Type: application/json" -d '{"auditLogsInstanceId":"string","displayName":"string","enforceUserApiTokenMfa":false,"isMfaRequired":false,"language":"string","locale":"string"}' https://{api_host}/csp/gateway/am/api/orgs/{orgId}
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-required-roles: org_owner
x-slo-tier: TIER2


Feedback

Was this page helpful?