[{"label":"Latest (V1)","version":"latest"}]
horizon-cloud-nextgen

Create Home Site Mappings

Description

Create a HomeSite Mapping for multiple users and groups

Request

Request

URL

URL


post
https://cloud.vmwarehorizon.com/portal/v2/homesitemappings
Copy

Request Body

Request Body

HomesiteMappingBatchReq of mimetype application/json Required

homesiteMappingBatchReq

{
    "homeSiteId": "05650"
}
string
homeSiteId Required

HomeSite Id


string as date-time
createdAt Optional

Time when HomeSite mapping was created


array of AdEntity
groups Optional

List of groups getting mapped to the home ste


string
homeSiteName Optional

HomeSite Name


string
orgId Optional

HomeSite OrgId Id


string as date-time
updatedAt Optional

Time when HomeSite mapping was updated


array of AdEntity
users Optional

List of users getting mapped to the home ste

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

201 Created

Returns HomesiteMappingBatchResp of type */*
{
	"homesiteMappingsCreated": [
		{
			"createdAt": "string",
			"domain": "domain-1",
			"entityId": "en-id-12345",
			"entityName": "en-name-12345",
			"homeSiteId": "05650",
			"homeSiteName": "site-1",
			"id": "hm-id-12345",
			"location": "US",
			"orgId": "org-id-12345",
			"type": "GROUP",
			"updatedAt": "string"
		}
	],
	"homesiteMappingsfailedFor": [
		{
			"entityId": "string",
			"entityName": "string",
			"message": "string"
		}
	]
}
array of HomesiteMapping
homesiteMappingsCreated Optional

array of AdEntityResponse
homesiteMappingsfailedFor Optional
Errors

Errors

ErrorResponse
400

Bad Request


ErrorResponse
401

Unauthorized


ErrorResponse
403

Forbidden


ErrorResponse
412

Precondition Failed

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"groups":[{"entityId":"group-id-1","entityName":"group-1"}],"homeSiteId":"05650","homeSiteName":"site-1","orgId":"org-id-12345","users":[{"entityId":"group-id-1","entityName":"group-1"}]}' https://cloud.vmwarehorizon.com/portal/v2/homesitemappings
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-codegen-request-body-name: homesiteMappingBatchReq


Feedback

Was this page helpful?