Add Vidb Configuration

Add Vidb Configuration
Add vIDB Configuration

Creates a new vCenter Identity Broker (vIDB/VCF SSO) configuration for OAuth-based authentication. Validates vIDB connection, retrieves and updates OAuth App details with redirect URLs and TTLs. If certificate is provided, imports it into trust store.

Request
URI
POST
https://{server}:9443/api/admin/global/config/vidb
COPY
Request Body
VidbPostRequestBody of type(s) application/json
Required 
{
    "data": {
        "items": [
            {
                "config": {
                    "clientId": "54716e4e-7992-4078-aad6-34f392529c54",
                    "clientSecret": "WldGaE4yVTVZamt0TnpRMVlTMDBPVFJrTFdFeFpqQXRNakppTW1JeFkyVmhPV014",
                    "issuerUrl": "https://vcf-sso.example.com/acs/t/CUSTOMER/"
                }
            }
        ]
    }
}
object
data
Optional

data

Authentication
This operation uses the following authentication methods.
Responses
200

vIDB configuration created successfully

Returns VidbGetResponse200 of type(s) application/json 
{
    "data": {
        "items": [
            {
                "section": "vidb",
                "config": {
                    "name": "VCF SSO",
                    "clientId": "54716e4e-7992-4078-aad6-34f392529c54",
                    "issuerUrl": "https://vcf-sso.example.com/acs/t/CUSTOMER/",
                    "url": "vcf-sso.example.com",
                    "port": "443",
                    "tenant": "CUSTOMER",
                    "UUID": "a7b8c9d0-e1f2-3456-a123-567890123456"
                }
            }
        ]
    }
}
object
data
Required

data


400

Bad request - validation failed, vIDB already configured, connection failed, or SSL certificate error

{
    "isSuccess": false,
    "message": "Request schema validation failed",
    "httpStatusCode": 400
}

500

Internal server error - configuration save failed

Returns ErrorResponse of type(s) application/json 
{
    "isSuccess": false,
    "message": "Unable to save vIDB configuration",
    "httpStatusCode": 500
}
boolean
isSuccess
Required

Indicates if the operation was successful

string
message
Required

Human-readable error message

integer
httpStatusCode
Required

HTTP status code


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/admin/global/config/vidb
On This Page
Vcf Sso Configuration Operations
GET
Get Vidb Configuration
POST
Add Vidb Configuration
PUT
Update Vidb Configuration