Get Saml Authentication

Get Saml Authentication

Get SAML Authentication configuration for an Enterprise

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

Enterprise Logical ID

Responses
200

SAML Authentication configuration for an enterprise

Returns getSamlAuthenticationResponse of type(s) application/json 
{
    "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


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


On This Page
Customers Operations
POST
Decode Cert
GET
Get Anonymous Access
GET
Get Casb App Categories
GET
Get Casb Controls Metadata
GET
Get Categories
GET
Get Content Filtering Metadata
GET
Get Content Inspection Engine Configuration
GET
Get Content Inspection Metadata
GET
Get Dlp Content Types
GET
Get Dlp Dict Categories
GET
Get Dlp Dict Regions
GET
Get File Types
GET
Get License Type
GET
Get Pac Metadata
GET
Get Saml Authentication
GET
Get Saml Auth Providers
GET
Get Threats
PUT
Update Anonymous Access
PUT
Update Content Inspection Engine Configuration
PUT
Update Saml Authentication