Configure Set Ls
This request configures the LookupService URL, persists the SSO admin credentials, and creates necessary SSO groups.
Request
URI
POST
https://{api_host}/config/lookup-service
COPY
Header Parameters
string
operationID
Optional
Operation ID for correlating logs across multiple services
Request Body
Configure the LookupService request.
ConfigureLsWithCredentialsRequest of type(s) application/json
Required
This request body class requires all of the following: ConfigureLsRequest
{
"url": "https://vc/lookupservice/sdk",
"thumbprint": "SHA-256:0D:80:21:91:C7:DC:94:BC:9D:E8:A7:04:0F:6B:F1:09:5C:AA:97:C8:4A:72:E5:CF:5E:8F:84:A7:B9:CC:8C:85",
"ssoAdminCredentials": {
"ssoUser": "Administrator@VSPHERE.LOCAL",
"ssoPassword": "myssopassword"
}
}
Responses
200
OK
Returns ConfigureLsResponse of type(s) application/json;charset=UTF-8
{
"lsUrl": "https://localhost/lookupservice/sdk",
"lsThumbprint": "SHA-256:0D:80:21:91:C7:DC:94:BC:9D:E8:A7:04:0F:6B:F1:09:5C:AA:97:C8:4A:72:E5:CF:5E:8F:84:A7:B9:CC:8C:85"
}string
lsThumbprint
Optional
The fingerprint of the vCenter Server Lookup Service SSL certificate.
string
lsUrl
Optional
The URL of the LookupService this service should use.
401
The returned error codes include (but are not limited to): NotAuthenticated
Returns ApiError of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8
{
"args": [],
"code": "Forbidden",
"msg": "Permission denied.",
"stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}array of string
args
Optional
Positional arguments.
string
code
Optional
Specific error code.
string
msg
Optional
Detailed error message.
string
stacktrace
Optional
Exception stacktrace.
500
The returned error codes include (but are not limited to): GeneralServerFailure
Returns ApiError of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8
{
"args": [],
"code": "Forbidden",
"msg": "Permission denied.",
"stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}array of string
args
Optional
Positional arguments.
string
code
Optional
Specific error code.
string
msg
Optional
Detailed error message.
string
stacktrace
Optional
Exception stacktrace.