Search Vidm User Grp V2 Using POST

This API is used to search vidm user group.

Request

URI

POST

https://{api_host}/lcm/authzn/api/v2/search/vidm-user-group

COPY

Request Body

vidmSearchUserRequestDTO

VidmSearchUserRequestDTO of type(s) application/json

Required

{
    "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

This operation uses the following authentication methods.

Authorization

Responses

200

Returns RequestDTO of type(s) application/json

{
    "createdBy": "admin@local",
    "errorCause": "string",
    "executionId": "e53ba5c9-1f6a-4cda-8ba6-6d6274441900",
    "executionPath": "string",
    "executionStatus": "string",
    "inputMap": {
        "inputMap": {}
    },
    "isCancelEnabled": "string",
    "lastUpdatedOn": 0,
    "outputMap": {
        "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

object

inputMap

Optional

inputMap

string

isCancelEnabled

Optional

Is Cancel Enabled?

integer As int64 As int64

lastUpdatedOn

Optional

Last Updated Time

object

outputMap

Optional

outputMap

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

transactionId

string

vmid

Optional

vmid

201

Created

Operation doesn't return any data structure

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