Update Organization By Organization Id Using PATCH

Update organization details.

Access Policy

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

Request

URI

PATCH

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

COPY

Path Parameters

string

orgId

Required

Unique identifier (GUID) of the organization.

Request Body

UpdateOrganizationRequest of type(s) 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

This operation uses the following authentication methods.

Bearer

Responses

200

Returns RefLinkDto of type(s) application/json

{
    "refLink": "string"
}

string

refLink

Optional

Relative reference link to the resource.

400

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

Returns CspErrorResponse of type(s) application/json

{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

401

The user is not authorized to use the API

Returns CspErrorResponse of type(s) application/json

{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

403

The user is forbidden to use the API

Returns CspErrorResponse of type(s) application/json

{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

404

Organization with this identifier is not found.

Returns CspErrorResponse of type(s) application/json

{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

409

The request could not be processed due to a conflict

Returns CspErrorResponse of type(s) application/json

{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

429

The user has sent too many requests

Returns CspErrorResponse of type(s) application/json

{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

500

An unexpected error has occurred while processing the request

Returns CspErrorResponse of type(s) application/json

{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message