Update Vidm Configuration | VMware Aria Operations for Networks API

Update Vidm Configuration

Update the existing VMware Identity Manager configuration. Only admin users can perform this action.

Request

URI

PUT

https://{api_host}/api/ni/settings/vidm

COPY

Request Body

VMware Identity Manager configuration details

VidmConfiguration of type(s) application/json

Required

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

string

vidm_appliance

Optional

Provide fully quallified domain name of VMware Identity Manager

string

rootCA_certificate

Optional

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

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 Operations for Networks

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

Success

Returns VidmConfigResponse of type(s) application/json

{
    "vidm_appliance": "identity.domain.com",
    "client_id": "Operations for Networks Client-ID",
    "enable": true,
    "certificate_validation_enabled": 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

boolean

certificate_validation_enabled

Optional

True, if SSL certificate check 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

404

Not Found

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