System Administration >
Settings
>
User Management
>
Vidm Configuration
Read AAA provider vIDM properties
Request:
Method:
GET
URI Path(s):
/api/v1/node/aaa/providers/vidm
/api/v1/transport-nodes/<transport-node-id>/node/aaa/providers/vidm
/api/v1/cluster/<cluster-node-id>/node/aaa/providers/vidm
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a
Example Request:
GET https://<nsx-mgr>/api/v1/node/aaa/providers/vidm
Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeAuthProviderVidmProperties
+
NodeAuthProviderVidmProperties
(
schema
)
Name
Description
Type
Notes
client_id
vIDM client id
string
Required
client_secret
vIDM client secret
string
host_name
Fully Qualified Domain Name(FQDN) of vIDM
string
Required
lb_enable
Load Balancer enable flag
boolean
node_host_name
host name of the node redirected to
host name to use when creating the redirect URL for clients to follow after authenticating to vIDM
string
Required
thumbprint
vIDM certificate thumbprint
Hexadecimal SHA256 hash of the vIDM server's X.509 certificate
string
Required
vidm_enable
vIDM enable flag
boolean
Example Response:
{ "lb_enable": true, "vidm_enable": true, "host_name": "jt-vidm.eng.vmware.com", "thumbprint": "898b75618e3e56615d53f987a720ff22b6381f4b85bec1eb973214ff7361f8b8", "client_id": "OAuth2Client_NsxClientId", "node_host_name": "jt-nsx.eng.vmware.com" }
Required Permissions:
read
Feature:
users_configuration
Additional Errors:
301 Moved Permanently
307 Temporary Redirect
400 Bad Request
403 Forbidden
409 Conflict
500 Internal Server Error
503 Service Unavailable