[{"label":"Latest (1.3.0)","version":"latest"}]
vrealize-suite-lifecycle-manager

Onboard Tenant V2

Description

Onboard a tenant, associate with products if applicable, perform validations

Request

Request

URL

URL


post
https://localhost:8080/lcm/authzn/api/v2/idp/tenants/onboard/{tenantName}
Copy

Path Parameters

Path Parameters

string
tenantName Required

tenantName


Request Body

Request Body

TenantOnboardRequestDTO of type(s) application/json Required

tenantOrDto

{
	"migratePreludeOAuthClients": false,
	"productsToAssociateWith": [
		{
			"environmentId": "string",
			"productId": "string"
		}
	],
	"vidmCludDto": {
		"email": "string",
		"familyName": "string",
		"givenName": "string",
		"password": "string",
		"userName": "string"
	},
	"vidmDclDto": {
		"adOverLdapDirectories": [
			{
				"directoryBindPassword": "string",
				"directoryName": "string"
			}
		],
		"adWithIwaDirectories": [
			{
				"directoryBindPassword": "string",
				"directoryName": "string",
				"domainAdminPassword": "string"
			}
		]
	}
}
boolean
migratePreludeOAuthClients Optional

productsToAssociateWith Optional

vidmCludDto Optional

vidmDclDto Optional
Authentication

Authentication

This operation uses the following authentication methods.

Authorization

Scopes: global

Response

Response

Response Body

Response Body

201 Created returns GenericRequestResponse of type(s) application/json
{
	"requestId": "a0d8d8cd-ac87-4b5c-ba8b-7a0173c56b55"
}
string
requestId Optional

Request ID

Errors

Errors

400

Client error


401

Unauthorized


403

Forbidden


404

Not Found


500

Internal Server Error

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"migratePreludeOAuthClients":false,"productsToAssociateWith":[{"environmentId":"string","productId":"string"}],"vidmCludDto":{"email":"string","familyName":"string","givenName":"string","password":"string","userName":"string"},"vidmDclDto":{"adOverLdapDirectories":[{"directoryBindPassword":"string","directoryName":"string"}],"adWithIwaDirectories":[{"directoryBindPassword":"string","directoryName":"string","domainAdminPassword":"string"}]}}' https://localhost:8080/lcm/authzn/api/v2/idp/tenants/onboard/{tenantName}


[{"label":"Latest (1.3.0)","version":"latest"}]
vrealize-suite-lifecycle-manager
Feedback

Was this page helpful?