Generate CSR | VMware Horizon Server API

Generate CSR

All the listed privileges are required -

Privileges	Description
MANAGE_CERTIFICATES	Caller should have permission to this privilege, to perform this operation.

Request

URI

POST

https://{api_host}/rest/config/v1/connection-servers/action/generate-csr

COPY

Request Body

CsrSpec of type(s) application/json

Required

{
    "certificate_usage": "MACHINE",
    "dns_subject_alternative_names": [
        "server.example.com",
        "www.vmware.com"
    ],
    "subject_name": "CN=Horizon-server.example.local, OU=VMware Horizon View default certificate, O=VMware, S=California, C=CALIFORNIA"
}

string

certificate_usage

Required

Indicates the type of certificate based on usage.

MACHINE: vdm certificates
CLUSTER: vdm.ec certificates

Possible values are : MACHINE, CLUSTER,

array of string

dns_subject_alternative_names

Optional

Subject alternative DNS names. If the 'certificateUsage' is set to 'CLUSTER', the cluster GUID can be provided in this field. If the cluster GUID is not provided in 'dnsSubjectAlternativeNames', the CSR generation process will automatically append it, along with the value provided in dnsSubjectAlternativeNames

string

subject_name

Required

Subject name. If the 'certificateUsage' is set to 'CLUSTER', the cluster GUID can be provided in this field. If the cluster GUID is not provided in the subject name, the CSR generation process will automatically append the cluster GUID to the 'dnsSubjectAlternativeNames' field, ensuring that the generated CSR is specific to the cluster and does not conflict with other clusters.

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

Returns CsrGenerateResponseInfo of type(s) */*

{
    "csr": "MIIC8DCCAdgCAQAwfDF6MHgGA1UEAxNxqRkDxR4gWqAoe26YU1S4...XRdFpQPhpkDRQ13yeO+oq"
}

string

csr

Optional

Generated CSR.

400

Bad Request

Operation doesn't return any data structure

401

User is not authenticated

Operation doesn't return any data structure

403

Access to the resource is forbidden

Operation doesn't return any data structure

On This Page

Description

Request

Request Body

Authentication

Response

200 Response Body

Errors

Config Operations

POST

Add App Volumes Manager

POST

Add App Volumes Manager V2

Create Federation Access Group

POST

Create Gateway Access User Or Group

POST

Create GSSAPI Authenticator

POST

Create IC Domain Account

Create JWT Authenticator

POST

Create Local Access Group

POST

Create Message Client

POST

Create Permissions

POST

Create Permissions V2

POST

Create RADIUS Authenticator

POST

Create Role

POST

Create SAML Authenticator

POST

Create Secondary Credential

POST

Create True SSO Connector

POST

Create Unauthenticated Access User

POST

Create Virtual Center

POST

Create Virtual Center V4

POST

Create Virtual Center V5

DELETE

Delete App Volumes Manager

DELETE

Delete App Volumes Manager V2

DELETE

Delete Certificate

DELETE

Delete Federation Access Group

DELETE

Delete Gateway Access User Or Group

DELETE

Delete GSSAPI Authenticator

DELETE

Delete IC Domain Account

Delete JWT Authenticator

DELETE

Delete Local Access Group

DELETE

Delete Message Client

DELETE

Delete Permissions

DELETE

Delete Permissions V2

DELETE

Delete RADIUS Authenticator

DELETE

Delete Role

DELETE

Delete SAML Authenticator

DELETE

Delete Secondary Credential

DELETE

Delete True SSO Connector

DELETE

Delete Unauthenticated Access User

POST

Disable Connection Servers

POST

Enable Connection Servers