Update an SSO configuration

curl -X PUT http://localhost:3000/sso/configs/name \
     -H "Content-Type: application/json" \
     -u "<username>:<password>" \
     -d '{}'

{
  "status": "OK",
  "message": "A sample success message",
  "data": {
    "name": "Auth0",
    "ssoType": "saml",
    "settings": {
      "description": "This sso configuration connects to Okta",
      "issuer": "https://www.auth0.com/oauth2/example",
      "loginURL": "https://www.auth0.com/login",
      "logoutURL": "https://www.auth0.com/logout",
      "certificate": "MIIDrjCCApagAwIBAgIGAYbHI140MA0GCSqGSIb3DQEBCwUAMIGXMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEU==",
      "samlEmailAttribute": "mail",
      "samlUserNameAttribute": "userName",
      "samlGroupsAttribute": "groups",
      "samlFirstNameAttribute": "firstName",
      "forceLogin": false,
      "disableAuthnContext": false
    },
    "active": false,
    "tested": true
  }
}

Updates an SSO configuration.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

namestringRequired

The name of the SSO configuration to delete

Request

request body

configobjectOptional

Schema describing an SSO configuration object

Response

The result of the SSO config update process.

statusenum

The status of the API request.

Allowed values:

messagestring

Message containing either confirmation of the operation or the reason for the failure of the operation.

dataobject

Schema describing an SSO configuration object

Errors

500

Internal Server Error