Update Saml Authentication

Update Saml Authentication

Update SAML Authentication configuration

Request
URI
PUT
https://{api_host}/api/cws/v1/enterprises/{enterpriseLogicalId}/samlAuth
COPY
Path Parameters
string
enterpriseLogicalId
Required

Enterprise Logical ID


Request Body
updateSamlAuthenticationBody of type(s) application/json
Required
{
    "saml": {
        "enabled": true,
        "provider": "string",
        "verboseTill": 1613093095.679,
        "external": true,
        "endpointUrl": "http://vmware.com/",
        "issuerUrl": "http://vmware.com/",
        "x509": "string",
        "x509Additional": "string",
        "customExternalMsg": {
            "text": "External authentication service not enabled. Please contact your administrator.",
            "showLink": true,
            "linkLabel": "External Auth link",
            "linkUrl": "https://okta.com"
        }
    },
    "adminSaml": {
        "enabled": true,
        "provider": "string",
        "verboseTill": 1613093095.679,
        "external": true,
        "endpointUrl": "http://vmware.com/",
        "issuerUrl": "http://vmware.com/",
        "x509": "string",
        "x509Additional": "string",
        "customExternalMsg": {
            "text": "External authentication service not enabled. Please contact your administrator.",
            "showLink": true,
            "linkLabel": "External Auth link",
            "linkUrl": "https://okta.com"
        }
    }
}
object
saml
Optional

saml

object
adminSaml
Optional

adminSaml

Responses
200

SAML Authentication configuration Updated

Operation doesn't return any data structure

400

Invalid Input

Returns httpResponseError of type(s) application/json
{
    "code": "error code",
    "errors": [
        {
            "message": "error message",
            "path": "object.path"
        }
    ]
}
string
code
Required

code

Possible values are : INTERNAL_ERROR, INVALID_PARAMS, INVALID_QUERY_PARAMS, INVALID_LICENSE,
array of object
errors
Required

errors


500

Internal Server Error

Returns httpResponseError of type(s) application/json
{
    "code": "error code",
    "errors": [
        {
            "message": "error message",
            "path": "object.path"
        }
    ]
}
string
code
Required

code

Possible values are : INTERNAL_ERROR, INVALID_PARAMS, INVALID_QUERY_PARAMS, INVALID_LICENSE,
array of object
errors
Required

errors