Save Vidm Configuration

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 Network Insight. Only admin users can perform this action.

Request

URI

POST

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

COPY

Request Body

VidmConfiguration of type(s) application/json

Optional

{
    "vidm_appliance": "identity.domain.com",
    "client_id": "string",
    "client_secret": "string",
    "sha_thumbprint": "string",
    "enable": false
}

string

vidm_appliance

Optional

Provide fully quallified domain name of VMware Identity Manager

string

client_id

Optional

string

client_secret

Optional

Provide the registered OAuth client secret

string

sha_thumbprint

Optional

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

boolean

enable

Optional

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

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

201

Success

Returns VidmConfigResponse of type(s) application/json

{
    "vidm_appliance": "identity.domain.com",
    "client_id": "string",
    "enable": false
}

string

vidm_appliance

Optional

Fully quallified domain name of VMware Identity Manager

string

client_id

Optional

Client-id of the configured OAuth client

boolean

enable

Optional

True, if VMware Identity Manager integration is enabled

400

Bad Request

Returns ApiError of type(s) application/json

{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}

integer As int32 As int32

code

Optional

code

string

message

Optional

message

array of ErrorDetail

details

Optional

details

401

Unauthorized

Returns ApiError of type(s) application/json

{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}

integer As int32 As int32

code

Optional

code

string

message

Optional

message

array of ErrorDetail

details

Optional

details

409

Already Exists

Returns ApiError of type(s) application/json

{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}

integer As int32 As int32

code

Optional

code

string

message

Optional

message

array of ErrorDetail

details

Optional

details

500

Internal Error

Operation doesn't return any data structure

On This Page

Description

Request

Request Body

Authentication

Response

201 Response Body

Errors

Settings Operations