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

Search VIdm User Grp V2

Description

This API is used to search vidm user group.

Request

Request

URL

URL


post
https://localhost:8080/lcm/authzn/api/v2/search/vidm-user-group
Copy

Request Body

Request Body

VidmSearchUserRequestDTO of type(s) application/json Required

vidmSearchUserRequestDTO

{
	"baseTenantHostname": "string",
	"isTenantConfiguredByPath": false,
	"requestId": "70821976-9bdb-4017-adaf-88f18c498b9e",
	"searchString": "<search string>",
	"useServiceClient": false,
	"vidmAdminPassword": "locker:password:<vmid>:<alias>",
	"vidmAdminUser": "admin",
	"vidmDomainName": "vidm.example.com",
	"vidmHost": "<vIDM host>",
	"vidmOAuthServiceClientId": "Service__OAuth2Client",
	"vidmOAuthServiceClientSecret": "<vIDM Oauth Service Client Secret key>",
	"vidmTenant": "string"
}
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

Authentication

This operation uses the following authentication methods.

Authorization

Scopes: global

Response

Response

Response Body

Response Body

201 Created returns RequestDTO of type(s) application/json
{
	"createdBy": "admin@local",
	"errorCause": "string",
	"executionId": "e53ba5c9-1f6a-4cda-8ba6-6d6274441900",
	"executionPath": "string",
	"executionStatus": "string",
	"inputMap": {},
	"isCancelEnabled": "string",
	"lastUpdatedOn": 0,
	"outputMap": {},
	"requestName": "lcmgenricsetting",
	"requestReason": "Get Generic Settings",
	"requestSource": "string",
	"requestSourceType": "user",
	"requestType": "lcmgenricsetting",
	"resultSet": "string",
	"state": "CREATED",
	"transactionId": "string",
	"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
Errors

Errors

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 '{"baseTenantHostname":"string","isTenantConfiguredByPath":false,"requestId":"70821976-9bdb-4017-adaf-88f18c498b9e","searchString":"<search string>","useServiceClient":false,"vidmAdminPassword":"locker:password:<vmid>:<alias>","vidmAdminUser":"admin","vidmDomainName":"vidm.example.com","vidmHost":"<vIDM host>","vidmOAuthServiceClientId":"Service__OAuth2Client","vidmOAuthServiceClientSecret":"<vIDM Oauth Service Client Secret key>","vidmTenant":"string"}' https://localhost:8080/lcm/authzn/api/v2/search/vidm-user-group


Feedback

Was this page helpful?