[{"label":"Latest (1.3.0)","version":"latest"}]
vrealize-suite-lifecycle-manager
Search VIdm User Grp V2
DescriptionThis API is used to search vidm user group.
Request
URLURL
https://localhost:8080/lcm/authzn/api/v2/search/vidm-user-group
Request Body
Request Body
{
"isTenantConfiguredByPath": false,
"requestId": "70821976-9bdb-4017-adaf-88f18c498b9e",
"searchString": "<search string>",
"vidmAdminPassword": "locker:password:<vmid>:<alias>",
"vidmAdminUser": "admin",
"vidmDomainName": "vidm.example.com",
"vidmHost": "<vIDM host>",
"vidmOAuthServiceClientId": "Service__OAuth2Client",
"vidmOAuthServiceClientSecret": "<vIDM Oauth Service Client Secret key>"
}
string
baseTenantHostname
Optional
Base Tenant Hostname
boolean
isTenantConfiguredByPath
Optional
Is Tenant Configured By Path
string
requestId
Optional
Request ID
string
searchString
Optional
Search string
boolean
useServiceClient
Optional
User Service Client
string
vidmAdminPassword
Optional
vIDM Admin password
string
vidmAdminUser
Optional
vIDM Admin User
string
vidmDomainName
Optional
vIDM Domain Name
string
vidmHost
Optional
vIDM hostname
string
vidmOAuthServiceClientId
Optional
vIDM Oauth Service Client Id
string
vidmOAuthServiceClientSecret
Optional
vIDM Oauth Service Client Secret key
string
vidmTenant
Optional
vIDM Tenant
Authentication
This operation uses the following authentication methods.
Authorization
Scopes:
global
Response
Response
Response BodyResponse Body
200 OK
Returns
RequestDTO
of type(s) application/json
{
"createdBy": "admin@local",
"executionId": "e53ba5c9-1f6a-4cda-8ba6-6d6274441900",
"requestName": "lcmgenricsetting",
"requestReason": "Get Generic Settings",
"requestSourceType": "user",
"requestType": "lcmgenricsetting",
"state": "CREATED",
"vmid": "6c9fca27-678d-4e79-9a0f-5f690735e67c"
}
string
createdBy
Optional
Created By User
string
errorCause
Optional
Error Cause
string
executionId
Optional
Execution Id
string
executionPath
Optional
Execution Path
string
executionStatus
Optional
Execution Status
map of
object
inputMap
Optional
string
isCancelEnabled
Optional
Is Cancel Enabled?
integer as int64
lastUpdatedOn
Optional
Last Updated Time
map of
object
outputMap
Optional
string
requestName
Optional
Request Name
string
requestReason
Optional
Request Reason
string
requestSource
Optional
Request Source
string
requestSourceType
Optional
Request Source Type
string
requestType
Optional
Request Type
string
resultSet
Optional
Result Set
string
state
Optional
State
string
transactionId
Optional
string
vmid
Optional
201 Created
Created
Operation doesn't return any data structure.
Errors
401
Unauthorized
403
Forbidden
404
Not Found
GenericErrorResponseDTO
500
Internal Server Error
Code Samples
cURL Command
curl -X POST -H "Content-Type: application/json" -d '{"isTenantConfiguredByPath":false,"requestId":"70821976-9bdb-4017-adaf-88f18c498b9e","searchString":"<search string>","vidmAdminPassword":"locker:password:<vmid>:<alias>","vidmAdminUser":"admin","vidmDomainName":"vidm.example.com","vidmHost":"<vIDM host>","vidmOAuthServiceClientId":"Service__OAuth2Client","vidmOAuthServiceClientSecret":"<vIDM Oauth Service Client Secret key>"}' https://localhost:8080/lcm/authzn/api/v2/search/vidm-user-group
[{"label":"Latest (1.3.0)","version":"latest"}]
vrealize-suite-lifecycle-manager
On This Page
Authentication User Controller Operations
post
delete
patch