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

Get SSO configuration

GET
http://localhost:3000/sso/configs/:name
GET
/sso/configs/:name
$curl http://localhost:3000/sso/configs/name \
>     -u "<username>:<password>"
1{
2  "name": "Auth0",
3  "ssoType": "saml",
4  "settings": {
5    "description": "This sso configuration connects to Okta",
6    "issuer": "https://www.auth0.com/oauth2/example",
7    "loginURL": "https://www.auth0.com/login",
8    "logoutURL": "https://www.auth0.com/logout",
9    "certificate": "MIIDrjCCApagAwIBAgIGAYbHI140MA0GCSqGSIb3DQEBCwUAMIGXMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEU==",
10    "samlEmailAttribute": "mail",
11    "samlUserNameAttribute": "userName",
12    "samlGroupsAttribute": "groups",
13    "samlFirstNameAttribute": "firstName",
14    "forceLogin": false,
15    "disableAuthnContext": false
16  },
17  "active": false,
18  "tested": true
19}
Returns the SSO configuration.
Was this page helpful?
Previous

List all SSO configurations

Next
Built with

Authentication

AuthorizationBasic

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

Path parameters

namestringRequired
The name of the SSO configuration to get

Response

The SSO configuration document
namestring
Name of the SSO configuration
ssoTypeenum
Single sign on type, SAML, OpenID, etc.
Allowed values:
settingsobject
The configuration for the sso type used
activebooleanDefaults to false
Whether or not the SSO Config is selected for use. For 'active' to be true, 'tested' must also be true.
testedboolean
Whether the sso config was tested

Errors

500
Internal Server Error