[{"label":"Latest (6.4.0)","version":"latest"}]
vrealize-network-insight-api

Save VIdm Configuration

Description

vRealize Network Insight supports SSO authentication through VMware Identity Manager. To authenticate against a particular VMware Identity Manager appliance, it must be configured and enabled in vRealize Network Insight. Only admin users can perform this action.

Request

Request

URL

URL


post
https://vrni.example.com/api/ni/settings/vidm
Copy

Request Body

Request Body

VidmConfiguration of type(s) application/json Required

VMware Identity Manager configuration details

{
	"client_id": "vRealize Network Insight Client-ID",
	"client_secret": "T2zRetc2f242KhelfoO6Qzw9",
	"enable": true,
	"rootCA_certificate": "-----BEGIN CERTIFICATE----- ..etc..",
	"sha_thumbprint": "15:37:48:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:19",
	"vidm_appliance": "identity.domain.com"
}
string
client_id Optional

Register VMware vRealize Network Insight as an OAuth client to VMware Identity Manager and provide client-id


string
client_secret Optional

Provide the registered OAuth client secret


boolean
enable Optional

True, to enable the VMware Identity Manager integration in vRealize Network Insight


string
rootCA_certificate Optional

Provide rootCA certificate to trust. Can be generated using /vidm/licence


string
sha_thumbprint Optional

Optionally, provide SHA thumbprint to validate VMware Identity Manager appliance that is being configured


string
vidm_appliance Optional

Provide fully quallified domain name of VMware Identity Manager

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

201 Created returns VidmConfigResponse of type(s) application/json
{
	"certificate_validation_enabled": false,
	"client_id": "vRealize Network Insight Client-ID",
	"enable": true,
	"vidm_appliance": "identity.domain.com"
}
boolean
certificate_validation_enabled Optional

True, if SSL certificate check is enabled.


string
client_id Optional

Client-id of the configured OAuth client


boolean
enable Optional

True, if VMware Identity Manager integration is enabled


string
vidm_appliance Optional

Fully quallified domain name of VMware Identity Manager

Errors

Errors

400

Bad Request


401

Unauthorized


409

Already Exists


500

Internal Error

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"client_id":"vRealize Network Insight Client-ID","client_secret":"T2zRetc2f242KhelfoO6Qzw9","enable":true,"rootCA_certificate":"-----BEGIN CERTIFICATE----- ..etc..","sha_thumbprint":"15:37:48:1E:DB:70:65:80:B2:74:E5:78:25:E5:AD:39:14:53:69:19","vidm_appliance":"identity.domain.com"}' https://vrni.example.com/api/ni/settings/vidm


[{"label":"Latest (6.4.0)","version":"latest"}]
vrealize-network-insight-api
Settings Operations
Feedback

Was this page helpful?