[{"label":"Latest (V1)","version":"latest"}]

horizon-cloud-nextgen

Patch SSO Config

Description

Patches an existing SSO configuration record with new values.

Request

URL

patch

https://cloud.vmwarehorizon.com/admin/v1/sso-configurations/{id}

Copy

Path Parameters

string

id Required

SSO configuration ID

Query Parameters

boolean

force_new_ca_bundle Optional

Force creation of a new CA bundle, even if caConfigDn is not changing.

string

org_id Optional

org_id

Request Body

SsoConfigurationPatchTO of mimetype application/json Optional

newSsoConfig

{
    "caCertVersionsToDelete": [
        1,
        2
    ],
    "caConfigDn": "CN=Configuration,DC=example,DC=com",
    "caMode": "sub",
    "description": "My SSO config.",
    "name": "my-sso-config"
}

array of string

activeDirectoryIds Optional

List of Active Directory IDs that are part of the same Active Directory Forest.

array of integer as int32

caCertVersionsToDelete Optional

List of valid CA cert versions to be deleted.If the CA bundle versions to be deleted is passed, then rest all of the fields can be optional, if only deletion of bundle is desired.Default : null

string

caConfigDn Optional

Configuration DN. Verify the Active Directory to get the appropriate value.If caConfigDn is changed, then a new Bundle is always created.

string

caMode Optional

CA mode. Accepted values: root or sub

string

description Optional

The description of the SSO config

string

name Optional

The name of the SSO config

Authentication

This operation uses the following authentication methods.

Bearer

Response

Response Body

200 OK

Returns SsoConfiguration of type */*

Successfully patch existing SSO configuration record

{
	"activeDirectoryIds": [
		"string"
	],
	"caBundles": [
		{
			"baseCrl": "string",
			"bundlePubKey": "string",
			"caCertVersion": 0,
			"credentialId": "string",
			"deltaCrl": "string",
			"rootCaCrt": "string",
			"subCaCsr": "string"
		}
	],
	"caConfigDn": "string",
	"caMode": "string",
	"createdAt": "string",
	"description": "string",
	"id": "string",
	"location": "string",
	"name": "string",
	"orgId": "string",
	"updatedAt": "string",
	"version": 0
}

string

location Required

string

caConfigDn Required

string

caMode Required

string

name Required

string

orgId Required

array of string

activeDirectoryIds Optional

string as date-time

createdAt Optional

string

description Optional

string

id Optional

array of CaBundle

caBundles Optional

string as date-time

updatedAt Optional

integer as int64

version Optional

204 No Content

No Content

Operation doesn't return any data structure.

Errors

ErrorResponse

400

Bad Request

ErrorResponse

401

Unauthorized

ErrorResponse

403

Forbidden

ErrorResponse

404

Not Found

ErrorResponse

409

Conflict - concurrent updates

Code Samples

cURL Command

curl -X PATCH -H "Content-Type: application/json" -d '{"caCertVersionsToDelete":[1,2],"caConfigDn":"CN=Configuration,DC=example,DC=com","caMode":"sub","description":"My SSO config.","name":"my-sso-config"}' https://cloud.vmwarehorizon.com/admin/v1/sso-configurations/{id}

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:

x-codegen-request-body-name: newSsoConfig

[{"label":"Latest (V1)","version":"latest"}]

horizon-cloud-nextgen

Admin Operations

post

Create

get

Get All

get

Get By ID

get

Get CA Bundle

patch

Patch SSO Config

delete

delete SSO Configurations

Patch SSO Config

Request

URL

Path Parameters

Query Parameters

Request Body

Authentication

Bearer

Response

Response Body

200 OK

204 No Content

Errors

Code Samples

cURL Command

Vendor Extensions

On This Page

Admin Operations

Was this page helpful?