Create Trust Member Organization Using POST

Create trust member organization. Only HIERARCHY and PARTNER trust types are allowed

Access Policy

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

Request

URI

POST

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

COPY

Path Parameters

string

orgId

Required

Unique identifier (GUID) of the organization.

Request Body

Defines the properties of the request for organization trust creation.

CreateTrustMemberOrganizationRequest of type(s) application/json

Required

"CreateTrustMemberOrganizationRequest Object"

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.

array of string

usernames

Optional

List of Usernames (e-mails) of users.

boolean

notifyUsersOfOrgAccess

Optional

Constraints: default: true

Send e-mail notification to existing user(s) informing about org access that is granted.

boolean

notifyUsersOfRegistration

Optional

Constraints: default: true

Send e-mail notification to new user(s) inviting them to VMware cloud services.

string

locale

Optional

Default locale lang country preference for the organization.

string

customerId

Optional

The Broadcom ERP customer id

string

trustType

Optional

Organization trust type.

Possible values are : HIERARCHY, CUSTOM, PARTNER,

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.

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.

Authentication

This operation uses the following authentication methods.

Bearer

Responses

201

Created

Returns IdDto of type(s) application/json

{
    "id": "string"
}

string

Optional

The unique identifier of the resource.

400

Trusted organization is already trustee organization in another active hierarchy organization trust.

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

message

Optional

message

string

errorCode

Optional

errorCode

string

requestId

Optional

requestId

integer As int32 As int32

moduleCode

Optional

moduleCode

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

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

message

Optional

message

string

errorCode

Optional

errorCode

string

requestId

Optional

requestId

integer As int32 As int32

moduleCode

Optional

moduleCode

integer As int32 As int32

statusCode

Optional

statusCode

403

The user is forbidden to use the API

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

message

Optional

message

string

errorCode

Optional

errorCode

string

requestId

Optional

requestId

integer As int32 As int32

moduleCode

Optional

moduleCode

integer As int32 As int32

statusCode

Optional

statusCode

404

Organization with this identifier is not found.

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

message

Optional

message

string

errorCode

Optional

errorCode

string

requestId

Optional

requestId

integer As int32 As int32

moduleCode

Optional

moduleCode

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

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

message

Optional

message

string

errorCode

Optional

errorCode

string

requestId

Optional

requestId

integer As int32 As int32

moduleCode

Optional

moduleCode

integer As int32 As int32

statusCode

Optional

statusCode

429

The user has sent too many requests

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

message

Optional

message

string

errorCode

Optional

errorCode

string

requestId

Optional

requestId

integer As int32 As int32

moduleCode

Optional

moduleCode

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

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

message

Optional

message

string

errorCode

Optional

errorCode

string

requestId

Optional

requestId

integer As int32 As int32

moduleCode

Optional

moduleCode

integer As int32 As int32

statusCode

Optional

statusCode

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/csp/gateway/am/api/orgs/{orgId}/member-orgs

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

201 Response Body

Errors

Organization Trust Management Operations

PATCH

Update Organization Trust Using PATCH