---
updatedAt: 2025-09-15T09:14:12.000Z
agentTools:
  siteIndex: https://developer.jamf.com/llms.txt
  projectIndex: https://developer.jamf.com/jamf-pro/v11.14.0/llms.txt
---

# Put an object representation of Self Service settings

puts an object representation of Self Service 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.14.0"
  },
  "servers": [
    {
      "url": "https://yourServer.jamfcloud.com/api"
    }
  ],
  "x-readme": {
    "samples-languages": [
      "curl",
      "swift",
      "ruby",
      "python"
    ],
    "explorer-enabled": false,
    "proxy-enabled": true
  },
  "security": [
    {
      "Bearer": []
    },
    {
      "ApiClient": []
    },
    {
      "BasicAuth": [
        "/v1/auth/token"
      ]
    }
  ],
  "paths": {
    "/v1/self-service/settings": {
      "put": {
        "tags": [
          "self-service"
        ],
        "summary": "Put an object representation of Self Service settings\n",
        "description": "puts an object representation of Self Service settings\n",
        "requestBody": {
          "description": "object that contains all editable global fields to alter Self Service settings\n",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SelfServiceSettings"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "successful PUT\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SelfServiceSettings"
                }
              }
            }
          }
        },
        "x-required-privileges": [
          "Update Self Service"
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "SelfServiceInstallSettings": {
        "required": [
          "installLocation"
        ],
        "type": "object",
        "properties": {
          "installAutomatically": {
            "type": "boolean",
            "description": "true if Self Service is insalled automatically, false if not\n",
            "default": false
          },
          "installLocation": {
            "type": "string",
            "description": "path at which Self Service is installed\n",
            "example": "/Applications"
          }
        },
        "description": "object representation of Self Service settings regarding installation\n"
      },
      "SelfServiceInteractionSettings": {
        "required": [
          "bookmarksName"
        ],
        "type": "object",
        "properties": {
          "notificationsEnabled": {
            "type": "boolean",
            "description": "global Self Service setting for if notifications are on or off\n",
            "default": false
          },
          "alertUserApprovedMdm": {
            "type": "boolean",
            "description": "whether users should be notified they need to approve organization's MDM profile\n",
            "default": true
          },
          "defaultLandingPage": {
            "type": "string",
            "description": "the default landing page in Self Service\n",
            "example": "HOME",
            "enum": [
              "HOME",
              "BROWSE",
              "HISTORY",
              "NOTIFICATIONS"
            ],
            "default": "HOME"
          },
          "defaultHomeCategoryId": {
            "type": "integer",
            "description": "id for the default home category in Self Service\n",
            "format": "int32",
            "default": -1
          },
          "bookmarksName": {
            "type": "string",
            "description": "renamed string for bookmarks if the admin wishes\n",
            "example": "Bookmarks"
          }
        },
        "description": "object representation of Self Service settings regarding user interaction\n"
      },
      "SelfServiceLoginSettings": {
        "required": [
          "authType",
          "userLoginLevel"
        ],
        "type": "object",
        "properties": {
          "userLoginLevel": {
            "type": "string",
            "description": "login setting to tell clients how to let users log in\n",
            "example": "NotRequired",
            "enum": [
              "NotRequired",
              "Anonymous",
              "Required"
            ]
          },
          "allowRememberMe": {
            "type": "boolean",
            "description": "true if remember me functionality is allowed, false if not\n",
            "default": false
          },
          "useFido2": {
            "type": "boolean",
            "description": "true if use FIDO2 functionality is allowed, false if not\n",
            "default": false
          },
          "authType": {
            "type": "string",
            "description": "login type to be used when asking users to log in\n",
            "example": "Basic",
            "enum": [
              "Basic",
              "Saml"
            ]
          }
        },
        "description": "object representation of Self Service settings regarding login\n"
      },
      "SelfServiceSettings": {
        "type": "object",
        "properties": {
          "installSettings": {
            "$ref": "#/components/schemas/SelfServiceInstallSettings"
          },
          "loginSettings": {
            "$ref": "#/components/schemas/SelfServiceLoginSettings"
          },
          "configurationSettings": {
            "$ref": "#/components/schemas/SelfServiceInteractionSettings"
          }
        },
        "description": "object representation of Self Service settings\n"
      }
    },
    "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": {}
          }
        }
      }
    }
  },
  "x-si-base": "swagger.json",
  "x-github-repo": "jamf/Jamf-Pro-API-Schema",
  "x-github-sha": "5f8b85a61ce288205f7b44d478a117fb1acea0c6"
}
```