For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Open sourceSupportFAQsDocs Home
DocumentationAPI ReferenceRelease notes
DocumentationAPI ReferenceRelease notes
  • Introduction
    • Overview
    • Authentication
  • Guides
    • Integration API routes
    • Operations Manager search APIs
    • Search API
    • URL query parameters
    • Use query parameters in API requests
  • Reference
        • POSTActivate an SSO configuration
        • POSTCreate an SSO configuration
        • DELDelete an SSO configuration
        • GETGet SSO configuration
        • GETList all SSO configurations
        • PUTUpdate an SSO configuration
LogoLogo
Open sourceSupportFAQsDocs Home
ReferenceSSO

Update an SSO configuration

PUT
http://localhost:3000/sso/configs/:name
PUT
/sso/configs/:name
$curl -X PUT http://localhost:3000/sso/configs/name \
>     -H "Content-Type: application/json" \
>     -u "<username>:<password>" \
>     -d '{}'
1{
2  "status": "OK",
3  "message": "A sample success message",
4  "data": {
5    "name": "Auth0",
6    "ssoType": "saml",
7    "settings": {
8      "description": "This sso configuration connects to Okta",
9      "issuer": "https://www.auth0.com/oauth2/example",
10      "loginURL": "https://www.auth0.com/login",
11      "logoutURL": "https://www.auth0.com/logout",
12      "certificate": "MIIDrjCCApagAwIBAgIGAYbHI140MA0GCSqGSIb3DQEBCwUAMIGXMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEU==",
13      "samlEmailAttribute": "mail",
14      "samlUserNameAttribute": "userName",
15      "samlGroupsAttribute": "groups",
16      "samlFirstNameAttribute": "firstName",
17      "forceLogin": false,
18      "disableAuthnContext": false
19    },
20    "active": false,
21    "tested": true
22  }
23}
Updates an SSO configuration.
Was this page helpful?
Previous

Clone existing tag

Next
Built with

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