/v1/api/ssoIntegrations/{id} (PUT) - BlueCat DNS Edge

DNS Edge User Guide

prodname
BlueCat DNS Edge

Update the configuration of an existing SSO integration.

Request: PUT https://api-<DNS.edge.url>/v1/api/ssoIntegrations/{id}
Authorization: Bearer authentication token
Content-Type: application/JSON
{
  "name": "<connection_name>",
  "type": "SAML",
  "description": "<description>",
  "signInUrl": "<sign_in_endpoint>",
  "signingCertificate": "<idp_signing_certificate_x509>",
  "userIdAttribute": "<user_id_attribute_in_saml>",
  "protocolBinding": "<HTTP-Redirect | HTTP-POST>",
  "active": true | false
}

The signingCertificate must be base64 encoded in full, including the -----BEGIN CERTIFICATE----- and -----END CERTIFICATE----- fields.

The signInUrl must be an HTTPS endpoint.

Attention: BlueCat strongly recommends using the DNS Edge UI to update the SSO integration.

Successful response

204 NO CONTENT
Possible error codes:
  • BAD REQUEST - Incorrectly formatted request or when the user tries to create a second SAML integration
  • UNAUTHORIZED - Invalid access token
  • NOT FOUND - SSO integration ID wasn't found
  • INTERNAL SERVER ERROR - Unexpected error