Settings APIs
Operations
GET
List Features
List RBAC features
POST
Create Registration Token
Create registration access token
POST
Remove Registration Token
Delete registration access token
POST
Retrieve Registration Token
Get registration access token
DELETE
Delete Registration Token Deprecated
Delete registration access token
GET
Get Registration Token Deprecated
Get registration access token
GET
Get All Role Bindings
Get all users and groups with their roles
POST
Create Role Binding
Assign roles to User or Group
DELETE
Delete Role Binding
Delete user/group's roles assignment
GET
Get Role Binding
Get user/group's role information
PUT
Update Role Binding
Update User or Group's roles
POST
Delete All Stale Role Bindings
Delete all stale role assignments
GET
Get All Roles Info
Get information about all roles
GET
List Roles Info
Get information about all roles with features and their permissions
DELETE
Delete Role
Delete custom role
GET
Get Role Info
Get role information
PUT
Create Or Update Role
Update custom role
PUT
Update Role Assignment Config
Set role assignment permission configuration
POST
Clone Role
Clone an already present role
POST
Validate And Recommend Permissions
Validate a new feature permission set
GET
Get Current User Info
Get the name and role information of the user.
GET
Get Group Vidm Search Result
Get all the User Groups where vIDM display name matches the search key case insensitively. The search key is checked to be a substring of display name. This is a non paginated API. This API will return as many results that vIDM returns to NSX during the search query. vIDM may not send all results at once so to zero in on the group of interest more characters need to be entered.
POST
Get Vidm Search Result
Get all the users and groups from vIDM matching the search key case insensitively. The search key is checked to be a substring of name or given name or family name of user and display name of group. This is a non paginated API. This API will return as many results that vIDM returns to NSX during the search query. vIDM may not send all results at once so to zero in on the user/group of interest more characters need to be entered.
GET
Get User Vidm Search Result
Get all the users from vIDM whose userName, givenName or familyName matches the search key case insensitively. The search key is checked to be a substring of name or given name or family name. This is a non paginated API. This API will return as many results that vIDM returns to NSX during the search query. vIDM may not send all results at once so to zero in on the user of interest more characters need to be entered.
GET
Get Support Bundle Config
Get support bundle configuration
PUT
Update Support Bundle Config
Update support bundle configuration
GET
Get Dynamic Content Filter Values
Get list of supported content filters
POST
Collect Support Bundles Collect
Collect support bundles from registered cluster and fabric nodes
POST
Delete Support Bundles Async Response Delete Async Response
Delete existing support bundles waiting to be downloaded
GET
Cluster Cluster Node Id Node Read Auth Provider Vidm
Read AAA provider vIDM properties
PUT
Cluster Cluster Node Id Node Update Auth Provider Vidm
Update AAA provider vIDM properties
GET
Cluster Cluster Node Id Node Read Auth Provider Vidm Status
Read AAA provider vIDM status
POST
Accept EULA
Accept end user license agreement
GET
Get EULA Acceptance
Return the acceptance status of end user license agreement
GET
Get EULA Content
Return the content of end user license agreement
GET
Get License Deprecated
Return the Enterprise License
PUT
Update License Deprecated
Assign an Updated Enterprise License Key
GET
Get Licenses
Get all licenses
POST
Create License
Add a new license key
GET
Get License Usage Report
Get usage report of all registered modules
GET
Get License Usage Report In Csv Format
Get usage report of all registred modules in CSV format
GET
Get Security License Usage Report
Get the security feature license usage report.
GET
Get Security License Usage Report In Csv Format
Get the security feature license usage report in CSV format.
POST
Deprecated Sync VCF Licenses Deprecated
Synchronize VCF licenses from all registered vCenters
POST
Sync VCF Licenses
Synchronize VCF licenses from all registered vCenters
DELETE
Delete License Deprecated
Remove a license identified by the license-key
GET
Get License By Key Deprecated
Get license properties for license identified by the license-key
POST
Delete License Key
Remove a license
GET
Node Read Auth Provider Vidm
Read AAA provider vIDM properties
PUT
Node Update Auth Provider Vidm
Update AAA provider vIDM properties
GET
Node Read Auth Provider Vidm Status
Read AAA provider vIDM status
GET
Get Proxy Config
Returns the proxy configuration
PUT
Update Proxy Config
Creates or updates the proxy configuration
POST
Create Sensor Registration Token
Create sensor registration access token
GET
Get Telemetry Agreement
Returns telemetry agreement information
PUT
Update Telemetry Agreement
Set telemetry agreement information
GET
Get Telemetry Config
Returns the telemetry configuration
PUT
Update Telemetry Config
Creates or updates the telemetry configuration
GET
Get Trust Objects
Return the Properties of a Trust Manager
GET
Get Certificate Profile
Get the certificate profile for the given service type
GET
List Certificate Profiles
Return the list of certificate profiles.
GET
Get Certificates
Return All the User-Facing Components' Certificates
POST
Batch Replace Certificates
Batch replace certificates
POST
Renew Appliance Certificates
Renew all internal appliance certificates that will expire soon
POST
Replace Host Certificate
Replace a Host Certificate
DELETE
Delete Certificates Batch Operation Result
Delete result of certificates batch operation
GET
Get Certificates Batch Operation Result
Get result of certificates batch operation
POST
Add Trusted Ca Certificate
Add a CA certificate as a trust anchor
DELETE
Delete Certificate
Delete Certificate for the Given Certificate ID
GET
Get Certificate
Show Certificate Data for the Given Certificate ID
POST
Apply Certificate
Apply a certificate for a CertificateProfile
GET
Validate Certificate
Validate a certificate
POST
Fetch Peer Certificate Chain
Fetch the server certificate chain of a TLS service endpoint
POST
Add Certificate
Add a New Certificate
POST
Set Inter Site Aph Certificate Deprecated
Set a certificate as the Appliance Proxy certificate to be used in inter-site communication
POST
Set Principal Identity Certificate For Federation Deprecated
Set a certificate as a GM or LM Principal Identity certificate
GET
List Crl Distribution Points
Return the list of CrlDistributionPoints
POST
Create Crl Distribution Point
Create a Crl Distribution Point
POST
Get Crl Distribution Point Pem
Return stored CRL in PEM format
DELETE
Delete Crl Distribution Point
Delete a CrlDistributionPoint
GET
Get Crl Distribution Point
Return the CrlDistributionPoint with <crl-distribution-point-id>
PUT
Update Crl Distribution Point
Update CrlDistributionPoint with <crl-distribution-point-id>
This allows updating the ManagedResource fields.
GET
Get Crl Distribution Point Status
Return the status of the CrlDistributionPoint
GET
Get Crls
Return All Added CRLs
DELETE
Delete Crl
Delete a CRL
GET
Get Crl
Show CRL Data for the Given CRL ID
PUT
Update Crl
Update CRL for the Given CRL ID
POST
Add Crl
Add a New Certificate Revocation List
GET
Get Csrs
Return All the Generated CSRs
POST
Generate Csr
Generate a New Certificate Signing Request
POST
Generate Csr With Extensions Deprecated
Generate a New Certificate Signing Request with Extensions
DELETE
Delete Csr
Delete a CSR
GET
Get Csr
Show CSR Data for the Given CSR ID
GET
Get Csr Pem
Get CSR PEM File for the Given CSR ID
POST
Import Certificate
Import a Certificate Associated with an Approved CSR
POST
Self Sign Certificate
Self-Sign the CSR
POST
Generate Self Signed Certificate
Generate a New Self-Signed Certificate
GET
List Oidc End Points
Return the list of OpenID Connect end-points.
POST
Add Oidc End Point
Add an OpenID Connect end-point.
POST
Configure Ws1b And Add Oidc End Point
Configure NSX for OIDC authentication with VC/WS1B
POST
Remove Ws1b Oidc End Point
Unconfigure NSX for OIDC authentication with VC/WS1B
GET
Get Oidc End Point
Get an OpenID Connect end-point.
PUT
Update Oidc End Point
Update an OpenID Connect end-point.
GET
Check Oidc End Point Health
Check the health of an OpenID Connect end-point
POST
Search Scim Users And Groups
Search a SCIM endpoint
GET
Verify Scim User Or Group Exists
Verify that a given user or group exists on the SCIM endpoint
POST
Refresh Oidc End Point
Refresh an OpenID Connect end-point
POST
Update Oidc End Point Thumbprint
Update a OpenID Connect end-point's thumbprint
GET
Get Principal Identities
Return the list of principal identities
POST
Register Principal Identity Deprecated
Register a name-certificate combination.
POST
Register Principal Identity With Certificate
Register a name-certificate combination.
DELETE
Delete Principal Identity
Delete a principal identity
GET
Get Principal Identity
Get a principal identity
POST
Update Principal Identity Certificate
Update a principal identity's certificate
GET
Get Stale Certificates
Get stale certificates
GET
List Token Based Principal Identities
Return the list of token-based principal identities. | These don't have certificate or role information.
POST
Register Token Based Principal Identity
Register a token-based principal identity.
DELETE
Delete Token Based Principal Identity
Delete a token-based principal identity
GET
Get Token Based Principal Identity
Get a token-based principal identity