Onboard Tenant V2 Using POST

Onboard Tenant V2 Using POST

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

Request
URI
POST
https://{api_host}//localhost:8080/lcm/authzn/api/v2/idp/tenants/onboard/{tenantName}
COPY
Path Parameters
string
tenantName
Required

tenantName

Request Body

tenantOrDto

TenantOnboardRequestDTO of type(s) application/json
Required 
{
    "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

migratePreludeOAuthClients

array of TenantAssocProductDTO
productsToAssociateWith
Optional

productsToAssociateWith

VidmCreateLocalUserDefnDTO
vidmCludDto
Optional

vidmCludDto

VidmDirectoryConfigListDTO
vidmDclDto
Optional

vidmDclDto

Authentication
This operation uses the following authentication methods.
Responses
200

OK

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

Request ID


201

Created

Operation doesn't return any data structure

400

Client error

Returns GenericErrorResponseDTO of type(s) application/json 
{
    "errorCode": "LCM_EXAMPLE_API_ERROR0000",
    "errorLabel": "Example Error!",
    "message": "Something went wrong!",
    "recommendations": []
}
string
errorCode
Optional

errorCode

string
errorLabel
Optional

errorLabel

string
message
Optional

message

array of string
recommendations
Optional

recommendations


401

Unauthorized

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure

500

Internal Server Error

Returns GenericErrorResponseDTO of type(s) application/json 
{
    "errorCode": "LCM_EXAMPLE_API_ERROR0000",
    "errorLabel": "Example Error!",
    "message": "Something went wrong!",
    "recommendations": []
}
string
errorCode
Optional

errorCode

string
errorLabel
Optional

errorLabel

string
message
Optional

message

array of string
recommendations
Optional

recommendations


On This Page
Tenant Management Controller Operations
PUT
Associate Products V2 Using PUT
POST
Enable Multitenancy V2 Using POST
GET
Fetch Tenant List V2 Using GET
POST
Onboard Tenant V2 Using POST
GET
Tenant Request Status By Id V2 Using GET