Update (SAML)

URL:
https://<root>/security/saml/update
Methods:
POST
Required Capability:
Access allowed with the "Security and infrastructure" privilege
Version Introduced:
10.9

Description

The update operation enables SAML certification when the identityCertificateName value for an imported SAML identity certificate is provided and SAML configuration is enabled.

Request parameters

ParameterDetails

samlSecurityConfig

A JSON object containing the identityCertificateName value for the imported SAML identity certificate (samlcert) and the enabled status of the SAML configuration. SAML will only be configured if the enabled status is set to true.

Example
Use dark colors for code blocksCopy
1
2
3
4
samlSecurityConfig={
  "enabled": true,
  "identityCertificateName": "samlcert"
}

f

The response format. The default format is html.

Values: html | json | pjson

Example usage

The following is a sample POST request for the update operation:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
POST /context/admin/security/saml/update HTTP/1.1
Host: organization.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

samlSecurityConfig=samlSecurityConfig={
  "enabled": true,
  "identityCertificateName": "samlcert"
}&f=pjson&token=_kBqsaCPR-Ql1iGaWTDt1xw_bHMgOCJK7wojmD205-P4Hg2-7WAo-GxPOtDMa0AJTrudIll_YCA-zWuqqXvjaCrA9mVkZBb9lQHm2keiO9rktrKM4ycD-Nh6f0Wc3YWf9Q7AdCMexgtAK61ZqmWVdKvvkqsHFcCMrg7IE-CmKyrO57I8z_SSiFZCLmgOupIaHqMJMsCKgfa8KMbxiVtRHseJIbBNddDVVXjqYKdbjf3ildQs9rK6i-0CHXOPUaYp

JSON Response example

Use dark colors for code blocksCopy
1
{"status": "success"}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.