---
updatedAt: 2026-06-15T13:51:20.000Z
agentTools:
  siteIndex: https://developer.jamf.com/llms.txt
  projectIndex: https://developer.jamf.com/jamf-pro/llms.txt
---

# Retrieve the current Single Sign On configuration settings


Retrieves the current Single Sign On configuration settings

> 📋 **Required privilege:** Read SSO Settings

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Jamf Pro API",
    "termsOfService": "https://www.jamf.com/developer-resources/api-license-agreement",
    "version": "11.32.0"
  },
  "servers": [
    {
      "url": "https://yourServer.jamfcloud.com/api"
    }
  ],
  "x-readme": {
    "samples-languages": [
      "curl",
      "swift",
      "ruby",
      "python"
    ],
    "explorer-enabled": false
  },
  "security": [
    {
      "Bearer": []
    },
    {
      "ApiClient": []
    },
    {
      "BasicAuth": [
        "/v1/auth/token"
      ]
    }
  ],
  "paths": {
    "/v3/sso": {
      "get": {
        "tags": [
          "sso-settings"
        ],
        "summary": "Retrieve the current Single Sign On configuration settings\n",
        "description": "Retrieves the current Single Sign On configuration settings\n\n> 📋 **Required privilege:** Read SSO Settings",
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SsoSettingsV3"
                }
              }
            }
          }
        },
        "x-required-privileges": [
          "Read SSO Settings"
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "EnrollmentSsoConfig": {
        "type": "object",
        "properties": {
          "hosts": {
            "minItems": 0,
            "type": "array",
            "example": [
              "dev-12324233.okta.com",
              "example.okta.com"
            ],
            "items": {
              "type": "string"
            },
            "default": []
          },
          "managementHint": {
            "type": "string",
            "default": ""
          }
        }
      },
      "OidcSettings": {
        "required": [
          "userMapping"
        ],
        "type": "object",
        "properties": {
          "userMapping": {
            "type": "string",
            "example": "USERNAME",
            "enum": [
              "USERNAME",
              "EMAIL"
            ]
          },
          "jamfIdAuthenticationEnabled": {
            "type": "boolean",
            "default": true
          },
          "usernameAttributeClaimMapping": {
            "type": "string",
            "example": "EMAIL",
            "enum": [
              "USERNAME",
              "EMAIL"
            ]
          }
        }
      },
      "SamlSettings": {
        "type": "object",
        "properties": {
          "tokenExpirationDisabled": {
            "type": "boolean",
            "default": false
          },
          "userAttributeEnabled": {
            "type": "boolean",
            "default": false
          },
          "userAttributeName": {
            "type": "string",
            "default": " "
          },
          "userMapping": {
            "type": "string",
            "example": "USERNAME",
            "enum": [
              "USERNAME",
              "EMAIL"
            ]
          },
          "groupAttributeName": {
            "type": "string",
            "default": "http://schemas.xmlsoap.org/claims/Group"
          },
          "groupRdnKey": {
            "type": "string",
            "default": " "
          },
          "idpProviderType": {
            "type": "string",
            "example": "ADFS",
            "enum": [
              "ADFS",
              "OKTA",
              "GOOGLE",
              "SHIBBOLETH",
              "ONELOGIN",
              "PING",
              "CENTRIFY",
              "AZURE",
              "OTHER"
            ]
          },
          "idpUrl": {
            "type": "string",
            "example": "https://example.idp.com/app/id/sso/saml/metadata"
          },
          "entityId": {
            "type": "string",
            "example": "saml/metadata"
          },
          "metadataFileName": {
            "type": "string",
            "example": "if MetadataSource is set to URL, remove this field"
          },
          "otherProviderTypeName": {
            "type": "string",
            "default": " "
          },
          "federationMetadataFile": {
            "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
            "type": "string",
            "format": "byte",
            "example": "WlhoaGJYQnNaU0J2WmlCaElHSmhjMlUyTkNCbGJtTnZaR1ZrSUhaaGJHbGtJSEF4TWk0Z2EyVjVjM1J2Y21VZ1ptbHNaUT09"
          },
          "metadataSource": {
            "type": "string",
            "example": "URL",
            "enum": [
              "URL",
              "FILE",
              "UNKNOWN"
            ]
          },
          "sessionTimeout": {
            "type": "integer",
            "format": "int32",
            "default": 480
          }
        }
      },
      "SsoSettingsV3": {
        "required": [
          "configurationType",
          "enrollmentSsoForAccountDrivenEnrollmentEnabled",
          "groupEnrollmentAccessEnabled",
          "oidcSettings",
          "samlSettings",
          "ssoBypassAllowed",
          "ssoEnabled",
          "ssoForEnrollmentEnabled",
          "ssoForMacOsSelfServiceEnabled"
        ],
        "type": "object",
        "properties": {
          "configurationType": {
            "type": "string",
            "example": "SAML",
            "enum": [
              "SAML",
              "OIDC",
              "OIDC_WITH_SAML"
            ]
          },
          "oidcSettings": {
            "$ref": "#/components/schemas/OidcSettings"
          },
          "samlSettings": {
            "$ref": "#/components/schemas/SamlSettings"
          },
          "ssoForEnrollmentEnabled": {
            "type": "boolean",
            "default": false
          },
          "ssoBypassAllowed": {
            "type": "boolean",
            "default": false
          },
          "ssoEnabled": {
            "type": "boolean",
            "default": false
          },
          "ssoForMacOsSelfServiceEnabled": {
            "type": "boolean",
            "default": false
          },
          "enrollmentSsoForAccountDrivenEnrollmentEnabled": {
            "type": "boolean",
            "default": false
          },
          "enrollmentSsoConfig": {
            "$ref": "#/components/schemas/EnrollmentSsoConfig"
          },
          "groupEnrollmentAccessEnabled": {
            "type": "boolean",
            "default": false
          },
          "groupEnrollmentAccessName": {
            "type": "string",
            "default": " "
          }
        }
      }
    },
    "securitySchemes": {
      "Bearer": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      },
      "BasicAuth": {
        "type": "http",
        "description": "Basic auth is used only for obtaining bearer tokens from the /v1/auth/token endpoint",
        "scheme": "basic"
      },
      "ApiClient": {
        "type": "oauth2",
        "description": "Jamf Pro API Roles and Clients provide a client ID and secret for obtaining access tokens using the OAuth2 client_credentials grant type",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "/api/v1/oauth/token",
            "scopes": {}
          }
        }
      }
    }
  }
}
```