{"openapi":"3.0.1","info":{"title":"Jamf Pro API","termsOfService":"https://www.jamf.com/developer-resources/api-license-agreement","version":"11.33.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":{"/v1/account-groups":{"get":{"tags":["account-groups"],"summary":"Get account groups","description":"Get all account groups with pagination, sorting, and filtering support.\n\n> 📋 **Required privilege:** Read Account Groups","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is\nname:asc. Multiple sort criteria are supported and must be separated with a comma.\nAccepts fields: id, name, siteId, ldapServerId.\n","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["name:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format to filter account groups collection. An empty query returns all results for the requested page.\nSupported fields: id, name, siteId, ldapServerId.\nMultiple conditions can be combined using logical operators.\nThis parameter can be used with paging and sorting parameters.\nExample: name==\"Admins\" and siteId==-1\n","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Account groups retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountGroupSearchResultsV1"}}}}},"x-required-privileges":["Read Account Groups"],"x-authentication-required":true}},"/v1/account-groups/{id}":{"get":{"tags":["account-groups"],"summary":"Gets the account group.\n","description":"Gets the account group for the given id.\n\n\n> 📋 **Required privilege:** Read Account Groups","parameters":[{"name":"id","in":"path","description":"id of target account group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response - account group retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountGroupV1"}}}},"404":{"description":"Not Found - account group does not exist"}},"x-required-privileges":["Read Account Groups"],"x-authentication-required":true}},"/v1/accounts":{"get":{"tags":["accounts"],"summary":"Get user accounts","description":"Get all user accounts with pagination, sorting, and filtering support.\n\n> 📋 **Required privilege:** Read Accounts","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is\nusername:desc. Multiple sort criteria are supported and must be separated with a comma.\nAccepts fields: id, lastPasswordChange, failedLoginAttempts, username, realname, email, phone, ldapServerId, distinguishedName, siteId, privilegeLevel, changePasswordOnNextLogin, accountStatus. \nIf any other field is passed it will be ignored in sorting operation and/or create unpredictable results.\n","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["username:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format to filter user accounts collection. An empty query returns all results for the requested page.\nSupported fields: id, lastPasswordChange, failedLoginAttempts, username, realname, email, phone, ldapServerId, distinguishedName, siteId, privilegeLevel, changePasswordOnNextLogin, accountStatus.\nMultiple conditions can be combined using logical operators.\nThis parameter can be used with paging and sorting parameters.\nExample: username==\"admin\" and accountStatus==Enabled and failedLoginAttempts==0\n","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"User accounts retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAccountSearchResults"}}}}},"x-required-privileges":["Read Accounts"],"x-authentication-required":true},"post":{"tags":["accounts"],"summary":"Adds new account.\n","description":"Adds the user account provided.\n\n\n> 📋 **Required privilege:** Create Accounts","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAccount"}}},"required":true},"responses":{"201":{"description":"Successful response - Jamf Pro user account added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAccount"}}}}},"x-required-privileges":["Create Accounts"],"x-authentication-required":true,"x-action":true,"x-rate-limit":false}},"/v1/accounts/{id}":{"get":{"tags":["accounts"],"summary":"Gets the user account.\n","description":"Gets the user account for the given id.\n\n\n> 📋 **Required privilege:** Read Accounts","parameters":[{"name":"id","in":"path","description":"id of target account","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response - Jamf Pro user account retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAccount"}}}}},"x-required-privileges":["Read Accounts"],"x-authentication-required":true},"put":{"tags":["accounts"],"summary":"Updates the user account.\n","description":"Updates the user account for the given id.\n\n\n> 📋 **Required privilege:** Update Accounts","parameters":[{"name":"id","in":"path","description":"id of target account","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAccount"}}},"required":true},"responses":{"200":{"description":"Successful response - Jamf Pro user account updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAccount"}}}},"400":{"description":"Bad Request - validation failure"},"404":{"description":"Not Found - user account does not exist"}},"x-required-privileges":["Update Accounts"],"x-authentication-required":true,"x-action":true,"x-rate-limit":false},"delete":{"tags":["accounts"],"summary":"Deletes the user account.\n","description":"Deletes the user account for the given id.\n\n\n> 📋 **Required privilege:** Delete Accounts","parameters":[{"name":"id","in":"path","description":"id of target account","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful response - Jamf Pro user account deleted"}},"x-required-privileges":["Delete Accounts"],"x-authentication-required":true}},"/v1/activation-code":{"put":{"tags":["activation-code"],"summary":"Updates Activation Code","description":"Updates Activation Code in Jamf Pro.\n\n> 📋 **Required privilege:** Update License Information","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivationCode"}}}},"responses":{"202":{"description":"Update successful."}},"x-required-privileges":["Update License Information"]}},"/v1/activation-code/history":{"get":{"tags":["activation-code"],"summary":"Get Activation Code history object","description":"Get Activation Code history object\n\n> 📋 **Required privilege:** Read License Information","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is date:desc. Fields allowed in the query: id, username, date, note, details Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,note:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["date:desc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: id, username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Details of Activation Code history was found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistorySearchResults"}}}},"404":{"description":"Activation Code object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read License Information"]},"post":{"tags":["activation-code"],"summary":"Add Activation Code object note\n","description":"Adds Activation Code object note.\n\n\n> 📋 **Required privilege:** Update License Information","requestBody":{"description":"Activation Code history notes to create.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistoryNote"}}},"required":true},"responses":{"201":{"description":"Notes of Activation Code history were added.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistory"}}}},"503":{"description":"Activation Code history cannot be saved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update License Information"]}},"/v1/activation-code/history/export":{"post":{"tags":["activation-code"],"summary":"Export history object collection in specified format for Activation Code\n","description":"Export history object collection in specified format for Activation Code\n\n\n> 📋 **Required privilege:** Read License Information","parameters":[{"$ref":"#/components/parameters/export-fields"},{"$ref":"#/components/parameters/export-labels"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["date:desc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"requestBody":{"description":"Optional. Override query parameters since they can make URI exceed 2,000 character limit.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportParameters"}}},"required":false},"responses":{"200":{"description":"Export successful","content":{"text/csv":{"schema":{"format":"binary","example":"id,username,date,note,details\n1,admin,2019-02-04 21:09:31,Buildings update,Some details\n"}}}},"400":{"description":"Export fields specified incorrectly - non-existing column or duplicate on the list.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"Export currently unavailable, all export-related resources are in use. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read License Information"],"x-action":true}},"/v1/activation-code/organization-name":{"patch":{"tags":["activation-code"],"summary":"Updates Organization Name","description":"Updates Organization Name in Jamf Pro.\n\n> 📋 **Required privilege:** Update License Information","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationName"}}}},"responses":{"202":{"description":"Update successful."}},"x-required-privileges":["Update License Information"]}},"/v1/pki/adcs-settings":{"post":{"tags":["adcs-settings"],"summary":"Create AD CS Settings configuration for either inbound or outbound mode\n","description":"Create AD CS Settings configuration and initialize renewal monitor. Once set, the configuration cannot change between inbound and outbound modes.\n\n> 📋 **Required privilege:** Create AD CS Settings","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdcsSettings"},"examples":{"sample1":{"value":{"displayName":"Example Display Name - 1","caName":"EXAMPLE-SUBCA02-CA","fqdn":"example-subca02.example.com","adcsUrl":null,"serverCert":null,"clientCert":null,"revocationEnabled":true,"outbound":true,"apiClientId":"A11B43D6-9ED4-4B29-B726-E2DE747D2410"}},"sample2":{"value":{"caName":"EXAMPLE-SUBCA02-CA","fqdn":"example-subca02.example.com","adcsUrl":"https://<host-name>.example.com","serverCert":{"filename":"adcs-proxy-ca.cer","data":"TUlJRFZEQ0NBanlnQXdJQkFnSVFVS1ZramVieXZxUk1XTzRnazR6SVlUQU5CZ2txaGtpRzl3MEJBUXNGQURBb01TWXdKQVlEVlFRRERCMXJkRzV6ZG0wdGQybHVNakF4Tmk1bGJucHBZVzUwWldOb0xtTnZiVEFlRncweU1qQXpNVFV4TWpJd01ETmFGdzB6TWpBek1UVXhNakk1TlRoYU1DZ3hKakFrQmdOVkJBTU1IV3QwYm5OMmJTMTNhVzR5TURFMkxtVnVlbWxoYm5SbFkyZ3VZMjl0TUlJQklqQU5CZ2txaGtpRzl3MEJBUUVGQUFPQ0FROEFNSUlCQ2dLQ0FRRUFvZGxoSTVaNVdOKzhqTFFZVFdQOXF2eklNZTRVaVRLVy9iQ3VCMlAwYm53ZEtKY2xjQU9MQ2h0UGhFZmNKd3ZtNjVFL0FnMnBwODNndnNlVHNwMmZFR2orNXRMVUVpd2lhM3lmUkdxVkVvQS8wMmIrMlBxbDUxWVNPYkVxU2x6TGRJUEVna0JNNzB1WGJDOHBjT2xSRFpZYnhGRWhaWDQzR1c2d3JCMElLaEdvV2o1Y2M5akJ0K1ZGSkFVc0dxMHl0dU44TFE3MGw0Z1laZ0hsa0x6UXlhcVZKUzhTalpyd0ZrczQzNlRuUkRQb2tSMzl6YVlkc0tra2prdXRWMUNlZVh3dEZDQURJOHhwUkdLU2EzZTl6eVU4cGN1V1VCaEt3OElNaTF2MExZdXVZNEVTNFBIRERRNmdVazhFTUtOTkVyek9lQkJUcHEwRC9aNnYwcTVaRndJREFRQUJvM293ZURBT0JnTlZIUThCQWY4RUJBTUNBYll3SFFZRFZSMGxCQll3RkFZSUt3WUJCUVVIQXdJR0NDc0dBUVVGQndNQk1DZ0dBMVVkRVFRaE1CK0NIV3QwYm5OMmJTMTNhVzR5TURFMkxtVnVlbWxoYm5SbFkyZ3VZMjl0TUIwR0ExVWREZ1FXQkJRK2h2aU5ONnFuZlVYZFZBa2pNdkZzYzdZUnV6QU5CZ2txaGtpRzl3MEJBUXNGQUFPQ0FRRUFUZVRhd3BXOFdPQUhUbFVtdzk5ZmJQUUtSc000UU8xUjlxKzkwSXRPMUxVTEpTMUZoNHplZysvR1ZQNjVhbUViQmVNamlOMmNYS2V5bGZhM3psWW9DVHpWRDFQY0VIdEdqNXoxTXVLaEJuZEJ5YVY1cG8vTGRlNWYvb0xWZWlORmJOSFh2am1OVDVJMzNMeFN6RG40d00yeHRsY1R3cHRKQzlTWGZPbSt0TGY0b21oTnBkSDhaKzFIMVhyYVVXU3pXVmRWL1g4QWZxMmxLamRpQzRiRXUyeGNJOXp3NmN6TVAvYWk0LzRZaE92dlVKTEVxUTRaQ0NRNDFPUEJvaHJaSW5VYUFFeXZxV2p0TWJLTjV6eXpZdWJQZ21PVGFheFhxb3M4cGs4emwvQXlYSTdTRFUxTmdpK05aT3h0Sy83TGI5V0lBVUF3ZTBjSU9tOGNrM3pldkE9PQ==","password":""},"clientCert":{"filename":"client-cert.pfx","data":"MIINvwIBAzCCDXsGCSqGSIb3DQEHAaCCDWwEgg1oMIINZDCCBg8GCSqGSIb3DQEHAaCCBgAEggX8MIIF+DCCBfQGCyqGSIb3DQEMCgECoIIE/jCCBPowHAYKKoZIhvcNAQwBAzAOBAhIPjJB7Ls2fAICB9AEggTY3EKQVRtYWdwsisoMtXWIYJXvLTLm3WtBULqFdkVIXiMg0Y6cKtMdYHoLKEhyZwcsFxiUSfM4QkGpo4woshiwjFBEwc7Iu3waIGe5CVmAsZ9ynvqBirCfelmt5mLn6iU+AjR/xcYqwV2MJNO+lo8K3gVGDHvE0caJQB2blFioW7QOsGb+8GWpNNdWkbTHB6zH3XRB1lVm+9rsr1BF1l3lzEQOlc4P1nBtNumf2TVBoU6cM4lgiWA0as896nUilj1w9AAXiQcdhIT4zaaJFP4AnXqL94bDDlfceA60HNpzCYRIGOhohnxBtquUoDw6uHBnmo6PMkB2KkYNVoxk+/+egF3arCdjbj4OkWhZ/wzNGa0uHTA6nG8bNWRXULWZ/QfvQi424vKfuLSGQty1AP0VHOeoY4SkWvDz+gCEfP29C8vk4kWcnl/0dsE1wmmowuydJvL6WhGRAPii1y/BOJW0FTXav03o7SP5aYZXnr8qLKKUkmSziV1toY7YFl7lUCKYj5j/1I+5uaGlEqbjEsQs6GwL6S9M6ggpbGSBT4fp4xH1FSXeRoWbbVKuB3+Sin8lwP4ZrSTarufWpYCnnLNfYgTFiatpbP9u9BS4PaBVZTFygyvl4Gj4QtVMtZy39tRqiN82RkG61DiTeLFI0xXGqMctQLpOHU8Rn07tBZBKWI6U5wc2nDKWr60ohQPVEglt5MEqYgPuPcoUvj2GOG536pHR6HeWiX3nszv3KCNxOog8hkvs1JKoJuByhgzeUR6ylHTBOq+jNrbTJvzWGXEK6+I5rUmViITmMksumg96kUgP2ZPYzGbaJLt0lE1zD+rI05EWroZh4GQpcwfX8PQkbadR10MXbhnPe039TwhbgtDecxgNZQd0Fs4WTZqzpZOkUpcvWxHmPm1iSCd860EvNKwJos4kAlgE2tMtPpAiNqhxOzzgMiSFdxOnTV3khJ2xTL4J8UsObbn2K6qp9EhXcUUl+0Xn7C8+T4PIYkW4G5LNkIjv/3Df7VGjaTwk0rJtFwJh8k09BPA4ETNaxC/C7JFwkW9eJYtYi/UxStMSrVj1HGmnsG036C+IYDjKeUWvNK7QV2mq+Pas5WncgRU8BwgU5D2fLffRjtnP1UnnTkHsk9wocUqIaEpylIDnmUzA6mgM/4vfibF2BHDgkLjo5w2kgSjoSsRp7z23RudESgIyax21aWtmBZvDLTCn7KXGwXPELxLoU3lvOow7G8XTwAymaV/ymn6aQDp9tEwMHL0slRc3okRtAkHvhwUWpy7wXHup/aGhciA0fpkZhU1UECxGybhjPANsBzB9gUoBo2QWmKI7pjAovDWTbqHMylEi0Xumj+FxJgrdSHm9IbkX92ShJKLoD/flGfMS9pNVaqoCSsa66lPSCNqnDEF85/rr1vDBwDHSPChZri7748VWXxNzoCnbp2wYlRTUn8DOvuMDdO5W/tWnxmHgaiOxOKgoiRsl0Rm2N9E9sse5VLkXnQG4/Ybgzdq9xsxB9RdL5pnXsvBjCc+ruH3/XW4ufEq10PvdruBSz7jFqMfXJZ0APqNcRAm6UVsLSIqYbDuaDXMIJATUzy+EGVLdUcLfcMpWWxXgtUr+mJLvWTTlHTdoF57mJoY0XiFe2lz/xsumI0CgA2z0AyUmvDGB4jANBgkrBgEEAYI3EQIxADATBgkqhkiG9w0BCRUxBgQEAQAAADBdBgkqhkiG9w0BCRQxUB5OAHQAZQAtADEANgAxADMANgAxADQANAAtADYAMQA4ADQALQA0ADYAYwAwAC0AOAA3ADIAMgAtAGEAZQBmADgAMgBkADkANABmAGUAZgBkMF0GCSsGAQQBgjcRATFQHk4ATQBpAGMAcgBvAHMAbwBmAHQAIABTAG8AZgB0AHcAYQByAGUAIABLAGUAeQAgAFMAdABvAHIAYQBnAGUAIABQAHIAbwB2AGkAZABlAHIwggdNBgkqhkiG9w0BBwGgggc+BIIHOjCCBzYwggODBgsqhkiG9w0BDAoBA6CCA3AwggNsBgoqhkiG9w0BCRYBoIIDXASCA1gwggNUMIICPKADAgECAhBQpWSN5vK+pExY7iCTjMhhMA0GCSqGSIb3DQEBCwUAMCgxJjAkBgNVBAMMHWt0bnN2bS13aW4yMDE2LmVuemlhbnRlY2guY29tMB4XDTIyMDMxNTEyMjAwM1oXDTMyMDMxNTEyMjk1OFowKDEmMCQGA1UEAwwda3Ruc3ZtLXdpbjIwMTYuZW56aWFudGVjaC5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCh2WEjlnlY37yMtBhNY/2q/Mgx7hSJMpb9sK4HY/RufB0olyVwA4sKG0+ER9wnC+brkT8CDamnzeC+x5OynZ8QaP7m0tQSLCJrfJ9EapUSgD/TZv7Y+qXnVhI5sSpKXMt0g8SCQEzvS5dsLylw6VENlhvEUSFlfjcZbrCsHQgqEahaPlxz2MG35UUkBSwarTK243wtDvSXiBhmAeWQvNDJqpUlLxKNmvAWSzjfpOdEM+iRHf3Nph2wqSSOS61XUJ55fC0UIAMjzGlEYpJrd73PJTyly5ZQGErDwgyLW/Qti65jgRLg8cMNDqBSTwQwo00SvM54EFOmrQP9nq/SrlkXAgMBAAGjejB4MA4GA1UdDwEB/wQEAwIBtjAdBgNVHSUEFjAUBggrBgEFBQcDAgYIKwYBBQUHAwEwKAYDVR0RBCEwH4Ida3Ruc3ZtLXdpbjIwMTYuZW56aWFudGVjaC5jb20wHQYDVR0OBBYEFD6G+I03qqd9Rd1UCSMy8WxzthG7MA0GCSqGSIb3DQEBCwUAA4IBAQBN5NrClbxY4AdOVSbD319s9ApGwzhA7VH2r73Qi07UtQslLUWHjN6D78ZU/rlqYRsF4yOI3Zxcp7KV9rfOVigJPNUPU9wQe0aPnPUy4qEGd0HJpXmmj8t17l/+gtV6I0Vs0de+OY1PkjfcvFLMOfjAzbG2VxPCm0kL1Jd86b60t/iiaE2l0fxn7UfVetpRZLNZV1X9fwB+raUqN2ILhsS7bFwj3PDpzMw/9qLj/hiE6+9QksSpDhkIJDjU48GiGtkidRoATK+paO0xso3nPLNi5s+CY5NprFeqizymTzOX8DJcjtINTU2CL41k7G0r/stv1YgBQDB7Rwg6bxyTfN68MQAwggOrBgsqhkiG9w0BDAoBA6CCA4MwggN/BgoqhkiG9w0BCRYBoIIDbwSCA2swggNnMIICT6ADAgECAhAaVZcv8KdtjUbjDGvLd3toMA0GCSqGSIb3DQEBCwUAMCgxJjAkBgNVBAMMHWt0bnN2bS13aW4yMDE2LmVuemlhbnRlY2guY29tMB4XDTIyMDMxNTEyMjAwM1oXDTMyMDMxNTEyMzAwM1owIDEeMBwGA1UEAwwVaDY4aGNnLnF1aWNrLmphbWYubmV0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAvBD1C4tR8vWZeSDdQ6AhynzMB47plvkqrXnmhcavlsDnu8Zfanr6gjUND0NK2Ufm0BBhH86kIcYMwehLYVNNfC3RTCT+QLo3wIn7VxUnsAPTqD23QjNwYnDTBQDkBrQIrFYaPc0RxO0MYexg/EqgEiAF1nJAZ3tndev1LBSEO5iN+8patoyV7jE3JlgF9qN0T0XCELrRpEi/pxKaVpAupXp38NBWVAJ6yqWuTCP2gcvnvo8KHHUTpJhwUcxr1aKUjX0LBnJ/mStQ8Cfckr7sLaHXyt4ei5uiQID69d/6JNoqpfoWW0EcHW8V3fiLX5fzsMBGjmRa/R8//zVM/ebpSwIDAQABo4GUMIGRMA4GA1UdDwEB/wQEAwIEsDAdBgNVHSUEFjAUBggrBgEFBQcDAgYIKwYBBQUHAwEwIAYDVR0RBBkwF4IVaDY4aGNnLnF1aWNrLmphbWYubmV0MB8GA1UdIwQYMBaAFD6G+I03qqd9Rd1UCSMy8WxzthG7MB0GA1UdDgQWBBT1Gk6lWWBdrF1z7n/FMgxT5Hb5YjANBgkqhkiG9w0BAQsFAAOCAQEAj0UtZ118booksRr7kDg47IhlhSlkhZVnZfkRUHY2QSYBkHNyilcb9rWJIAzrSI5q+RV+FDXDEc0at9CmH2yIb+dYSojxj1ebSCloZb5QiHfAZTFN5+AicESWb0PMGiiz1HeU8Bm2bjHIRx4OLKSm4agMck/6iBDJhduiidrEZkmz8MRFr04GE/9MAg3JG149JeCSS54seKx7tBx+dJjzHJg2HeqZtOKjaKLOnstquEVhwgGXIqH51lQd5SOfYJH1cQyi6xe7SBZ5YYYF1iubhMUqvYnbugskm35nYWk9XObw4QRnfTQNIuW6p1cz2Nk+yaDheraycaxbBGYaXMgIJzEVMBMGCSqGSIb3DQEJFTEGBAQBAAAAMDswHzAHBgUrDgMCGgQUA/Hryi7gjlbKpKpGVlTvAnjevyAEFFhGKjlcFPkz5+bUOnz1OcWq/3zPAgIH0A==","password":"password-example"},"revocationEnabled":true,"outbound":false,"apiClientId":null}},"sample3":{"value":{"displayName":"Example Display Name - 2","caName":"EXAMPLE-SUBCA02-CA","fqdn":"example-subca02.example.com","adcsUrl":"https://<host-name>.example.com","serverCert":{"filename":"adcs-proxy-ca.pem","data":"TUlJRFZEQ0NBanlnQXdJQkFnSVFVS1ZramVieXZxUk1XTzRnazR6SVlUQU5CZ2txaGtpRzl3MEJBUXNGQURBb01TWXdKQVlEVlFRRERCMXJkRzV6ZG0wdGQybHVNakF4Tmk1bGJucHBZVzUwWldOb0xtTnZiVEFlRncweU1qQXpNVFV4TWpJd01ETmFGdzB6TWpBek1UVXhNakk1TlRoYU1DZ3hKakFrQmdOVkJBTU1IV3QwYm5OMmJTMTNhVzR5TURFMkxtVnVlbWxoYm5SbFkyZ3VZMjl0TUlJQklqQU5CZ2txaGtpRzl3MEJBUUVGQUFPQ0FROEFNSUlCQ2dLQ0FRRUFvZGxoSTVaNVdOKzhqTFFZVFdQOXF2eklNZTRVaVRLVy9iQ3VCMlAwYm53ZEtKY2xjQU9MQ2h0UGhFZmNKd3ZtNjVFL0FnMnBwODNndnNlVHNwMmZFR2orNXRMVUVpd2lhM3lmUkdxVkVvQS8wMmIrMlBxbDUxWVNPYkVxU2x6TGRJUEVna0JNNzB1WGJDOHBjT2xSRFpZYnhGRWhaWDQzR1c2d3JCMElLaEdvV2o1Y2M5akJ0K1ZGSkFVc0dxMHl0dU44TFE3MGw0Z1laZ0hsa0x6UXlhcVZKUzhTalpyd0ZrczQzNlRuUkRQb2tSMzl6YVlkc0tra2prdXRWMUNlZVh3dEZDQURJOHhwUkdLU2EzZTl6eVU4cGN1V1VCaEt3OElNaTF2MExZdXVZNEVTNFBIRERRNmdVazhFTUtOTkVyek9lQkJUcHEwRC9aNnYwcTVaRndJREFRQUJvM293ZURBT0JnTlZIUThCQWY4RUJBTUNBYll3SFFZRFZSMGxCQll3RkFZSUt3WUJCUVVIQXdJR0NDc0dBUVVGQndNQk1DZ0dBMVVkRVFRaE1CK0NIV3QwYm5OMmJTMTNhVzR5TURFMkxtVnVlbWxoYm5SbFkyZ3VZMjl0TUIwR0ExVWREZ1FXQkJRK2h2aU5ONnFuZlVYZFZBa2pNdkZzYzdZUnV6QU5CZ2txaGtpRzl3MEJBUXNGQUFPQ0FRRUFUZVRhd3BXOFdPQUhUbFVtdzk5ZmJQUUtSc000UU8xUjlxKzkwSXRPMUxVTEpTMUZoNHplZysvR1ZQNjVhbUViQmVNamlOMmNYS2V5bGZhM3psWW9DVHpWRDFQY0VIdEdqNXoxTXVLaEJuZEJ5YVY1cG8vTGRlNWYvb0xWZWlORmJOSFh2am1OVDVJMzNMeFN6RG40d00yeHRsY1R3cHRKQzlTWGZPbSt0TGY0b21oTnBkSDhaKzFIMVhyYVVXU3pXVmRWL1g4QWZxMmxLamRpQzRiRXUyeGNJOXp3NmN6TVAvYWk0LzRZaE92dlVKTEVxUTRaQ0NRNDFPUEJvaHJaSW5VYUFFeXZxV2p0TWJLTjV6eXpZdWJQZ21PVGFheFhxb3M4cGs4emwvQXlYSTdTRFUxTmdpK05aT3h0Sy83TGI5V0lBVUF3ZTBjSU9tOGNrM3pldkE9PQ==","password":""},"clientCert":{"filename":"client-cert.p12","data":"MIINvwIBAzCCDXsGCSqGSIb3DQEHAaCCDWwEgg1oMIINZDCCBg8GCSqGSIb3DQEHAaCCBgAEggX8MIIF+DCCBfQGCyqGSIb3DQEMCgECoIIE/jCCBPowHAYKKoZIhvcNAQwBAzAOBAhIPjJB7Ls2fAICB9AEggTY3EKQVRtYWdwsisoMtXWIYJXvLTLm3WtBULqFdkVIXiMg0Y6cKtMdYHoLKEhyZwcsFxiUSfM4QkGpo4woshiwjFBEwc7Iu3waIGe5CVmAsZ9ynvqBirCfelmt5mLn6iU+AjR/xcYqwV2MJNO+lo8K3gVGDHvE0caJQB2blFioW7QOsGb+8GWpNNdWkbTHB6zH3XRB1lVm+9rsr1BF1l3lzEQOlc4P1nBtNumf2TVBoU6cM4lgiWA0as896nUilj1w9AAXiQcdhIT4zaaJFP4AnXqL94bDDlfceA60HNpzCYRIGOhohnxBtquUoDw6uHBnmo6PMkB2KkYNVoxk+/+egF3arCdjbj4OkWhZ/wzNGa0uHTA6nG8bNWRXULWZ/QfvQi424vKfuLSGQty1AP0VHOeoY4SkWvDz+gCEfP29C8vk4kWcnl/0dsE1wmmowuydJvL6WhGRAPii1y/BOJW0FTXav03o7SP5aYZXnr8qLKKUkmSziV1toY7YFl7lUCKYj5j/1I+5uaGlEqbjEsQs6GwL6S9M6ggpbGSBT4fp4xH1FSXeRoWbbVKuB3+Sin8lwP4ZrSTarufWpYCnnLNfYgTFiatpbP9u9BS4PaBVZTFygyvl4Gj4QtVMtZy39tRqiN82RkG61DiTeLFI0xXGqMctQLpOHU8Rn07tBZBKWI6U5wc2nDKWr60ohQPVEglt5MEqYgPuPcoUvj2GOG536pHR6HeWiX3nszv3KCNxOog8hkvs1JKoJuByhgzeUR6ylHTBOq+jNrbTJvzWGXEK6+I5rUmViITmMksumg96kUgP2ZPYzGbaJLt0lE1zD+rI05EWroZh4GQpcwfX8PQkbadR10MXbhnPe039TwhbgtDecxgNZQd0Fs4WTZqzpZOkUpcvWxHmPm1iSCd860EvNKwJos4kAlgE2tMtPpAiNqhxOzzgMiSFdxOnTV3khJ2xTL4J8UsObbn2K6qp9EhXcUUl+0Xn7C8+T4PIYkW4G5LNkIjv/3Df7VGjaTwk0rJtFwJh8k09BPA4ETNaxC/C7JFwkW9eJYtYi/UxStMSrVj1HGmnsG036C+IYDjKeUWvNK7QV2mq+Pas5WncgRU8BwgU5D2fLffRjtnP1UnnTkHsk9wocUqIaEpylIDnmUzA6mgM/4vfibF2BHDgkLjo5w2kgSjoSsRp7z23RudESgIyax21aWtmBZvDLTCn7KXGwXPELxLoU3lvOow7G8XTwAymaV/ymn6aQDp9tEwMHL0slRc3okRtAkHvhwUWpy7wXHup/aGhciA0fpkZhU1UECxGybhjPANsBzB9gUoBo2QWmKI7pjAovDWTbqHMylEi0Xumj+FxJgrdSHm9IbkX92ShJKLoD/flGfMS9pNVaqoCSsa66lPSCNqnDEF85/rr1vDBwDHSPChZri7748VWXxNzoCnbp2wYlRTUn8DOvuMDdO5W/tWnxmHgaiOxOKgoiRsl0Rm2N9E9sse5VLkXnQG4/Ybgzdq9xsxB9RdL5pnXsvBjCc+ruH3/XW4ufEq10PvdruBSz7jFqMfXJZ0APqNcRAm6UVsLSIqYbDuaDXMIJATUzy+EGVLdUcLfcMpWWxXgtUr+mJLvWTTlHTdoF57mJoY0XiFe2lz/xsumI0CgA2z0AyUmvDGB4jANBgkrBgEEAYI3EQIxADATBgkqhkiG9w0BCRUxBgQEAQAAADBdBgkqhkiG9w0BCRQxUB5OAHQAZQAtADEANgAxADMANgAxADQANAAtADYAMQA4ADQALQA0ADYAYwAwAC0AOAA3ADIAMgAtAGEAZQBmADgAMgBkADkANABmAGUAZgBkMF0GCSsGAQQBgjcRATFQHk4ATQBpAGMAcgBvAHMAbwBmAHQAIABTAG8AZgB0AHcAYQByAGUAIABLAGUAeQAgAFMAdABvAHIAYQBnAGUAIABQAHIAbwB2AGkAZABlAHIwggdNBgkqhkiG9w0BBwGgggc+BIIHOjCCBzYwggODBgsqhkiG9w0BDAoBA6CCA3AwggNsBgoqhkiG9w0BCRYBoIIDXASCA1gwggNUMIICPKADAgECAhBQpWSN5vK+pExY7iCTjMhhMA0GCSqGSIb3DQEBCwUAMCgxJjAkBgNVBAMMHWt0bnN2bS13aW4yMDE2LmVuemlhbnRlY2guY29tMB4XDTIyMDMxNTEyMjAwM1oXDTMyMDMxNTEyMjk1OFowKDEmMCQGA1UEAwwda3Ruc3ZtLXdpbjIwMTYuZW56aWFudGVjaC5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCh2WEjlnlY37yMtBhNY/2q/Mgx7hSJMpb9sK4HY/RufB0olyVwA4sKG0+ER9wnC+brkT8CDamnzeC+x5OynZ8QaP7m0tQSLCJrfJ9EapUSgD/TZv7Y+qXnVhI5sSpKXMt0g8SCQEzvS5dsLylw6VENlhvEUSFlfjcZbrCsHQgqEahaPlxz2MG35UUkBSwarTK243wtDvSXiBhmAeWQvNDJqpUlLxKNmvAWSzjfpOdEM+iRHf3Nph2wqSSOS61XUJ55fC0UIAMjzGlEYpJrd73PJTyly5ZQGErDwgyLW/Qti65jgRLg8cMNDqBSTwQwo00SvM54EFOmrQP9nq/SrlkXAgMBAAGjejB4MA4GA1UdDwEB/wQEAwIBtjAdBgNVHSUEFjAUBggrBgEFBQcDAgYIKwYBBQUHAwEwKAYDVR0RBCEwH4Ida3Ruc3ZtLXdpbjIwMTYuZW56aWFudGVjaC5jb20wHQYDVR0OBBYEFD6G+I03qqd9Rd1UCSMy8WxzthG7MA0GCSqGSIb3DQEBCwUAA4IBAQBN5NrClbxY4AdOVSbD319s9ApGwzhA7VH2r73Qi07UtQslLUWHjN6D78ZU/rlqYRsF4yOI3Zxcp7KV9rfOVigJPNUPU9wQe0aPnPUy4qEGd0HJpXmmj8t17l/+gtV6I0Vs0de+OY1PkjfcvFLMOfjAzbG2VxPCm0kL1Jd86b60t/iiaE2l0fxn7UfVetpRZLNZV1X9fwB+raUqN2ILhsS7bFwj3PDpzMw/9qLj/hiE6+9QksSpDhkIJDjU48GiGtkidRoATK+paO0xso3nPLNi5s+CY5NprFeqizymTzOX8DJcjtINTU2CL41k7G0r/stv1YgBQDB7Rwg6bxyTfN68MQAwggOrBgsqhkiG9w0BDAoBA6CCA4MwggN/BgoqhkiG9w0BCRYBoIIDbwSCA2swggNnMIICT6ADAgECAhAaVZcv8KdtjUbjDGvLd3toMA0GCSqGSIb3DQEBCwUAMCgxJjAkBgNVBAMMHWt0bnN2bS13aW4yMDE2LmVuemlhbnRlY2guY29tMB4XDTIyMDMxNTEyMjAwM1oXDTMyMDMxNTEyMzAwM1owIDEeMBwGA1UEAwwVaDY4aGNnLnF1aWNrLmphbWYubmV0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAvBD1C4tR8vWZeSDdQ6AhynzMB47plvkqrXnmhcavlsDnu8Zfanr6gjUND0NK2Ufm0BBhH86kIcYMwehLYVNNfC3RTCT+QLo3wIn7VxUnsAPTqD23QjNwYnDTBQDkBrQIrFYaPc0RxO0MYexg/EqgEiAF1nJAZ3tndev1LBSEO5iN+8patoyV7jE3JlgF9qN0T0XCELrRpEi/pxKaVpAupXp38NBWVAJ6yqWuTCP2gcvnvo8KHHUTpJhwUcxr1aKUjX0LBnJ/mStQ8Cfckr7sLaHXyt4ei5uiQID69d/6JNoqpfoWW0EcHW8V3fiLX5fzsMBGjmRa/R8//zVM/ebpSwIDAQABo4GUMIGRMA4GA1UdDwEB/wQEAwIEsDAdBgNVHSUEFjAUBggrBgEFBQcDAgYIKwYBBQUHAwEwIAYDVR0RBBkwF4IVaDY4aGNnLnF1aWNrLmphbWYubmV0MB8GA1UdIwQYMBaAFD6G+I03qqd9Rd1UCSMy8WxzthG7MB0GA1UdDgQWBBT1Gk6lWWBdrF1z7n/FMgxT5Hb5YjANBgkqhkiG9w0BAQsFAAOCAQEAj0UtZ118booksRr7kDg47IhlhSlkhZVnZfkRUHY2QSYBkHNyilcb9rWJIAzrSI5q+RV+FDXDEc0at9CmH2yIb+dYSojxj1ebSCloZb5QiHfAZTFN5+AicESWb0PMGiiz1HeU8Bm2bjHIRx4OLKSm4agMck/6iBDJhduiidrEZkmz8MRFr04GE/9MAg3JG149JeCSS54seKx7tBx+dJjzHJg2HeqZtOKjaKLOnstquEVhwgGXIqH51lQd5SOfYJH1cQyi6xe7SBZ5YYYF1iubhMUqvYnbugskm35nYWk9XObw4QRnfTQNIuW6p1cz2Nk+yaDheraycaxbBGYaXMgIJzEVMBMGCSqGSIb3DQEJFTEGBAQBAAAAMDswHzAHBgUrDgMCGgQUA/Hryi7gjlbKpKpGVlTvAnjevyAEFFhGKjlcFPkz5+bUOnz1OcWq/3zPAgIH0A==","password":"password-example"},"revocationEnabled":true,"outbound":false,"apiClientId":null}}}}},"required":true},"responses":{"201":{"description":"Created","content":{"*/*":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}}},"x-required-privileges":["Create AD CS Settings"]}},"/v1/pki/adcs-settings/validate-certificate":{"post":{"tags":["adcs-settings"],"summary":"Validate AD CS Settings server certificate\n","description":"Validate AD CS Settings server certificate for file format. Must be base64-encoded X.509 file content, obtainable by `openssl base64 < /file/path/filename.pfx | tr -d '\\n' | pbcopy` in linux terminal, or similar parsing methods.\n\n> 📋 **Required privileges:**\n> - Update AD CS Settings\n> - Create AD CS Settings","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdcsCertificate"},"examples":{"sample1":{"value":{"filename":"adcs-proxy-ca.cer","data":"MIIDVDCCAjygAwIBAgIQUKVkjebyvqRMWO4gk4zIYTANBgkqhkiG9w0BAQsFADAoMSYwJAYDVQQDDB1rdG5zdm0td2luMjAxNi5lbnppYW50ZWNoLmNvbTAeFw0yMjAzMTUxMjIwMDNaFw0zMjAzMTUxMjI5NThaMCgxJjAkBgNVBAMMHWt0bnN2bS13aW4yMDE2LmVuemlhbnRlY2guY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAodlhI5Z5WN+8jLQYTWP9qvzIMe4UiTKW/bCuB2P0bnwdKJclcAOLChtPhEfcJwvm65E/Ag2pp83gvseTsp2fEGj+5tLUEiwia3yfRGqVEoA/02b+2Pql51YSObEqSlzLdIPEgkBM70uXbC8pcOlRDZYbxFEhZX43GW6wrB0IKhGoWj5cc9jBt+VFJAUsGq0ytuN8LQ70l4gYZgHlkLzQyaqVJS8SjZrwFks436TnRDPokR39zaYdsKkkjkutV1CeeXwtFCADI8xpRGKSa3e9zyU8pcuWUBhKw8IMi1v0LYuuY4ES4PHDDQ6gUk8EMKNNErzOeBBTpq0D/Z6v0q5ZFwIDAQABo3oweDAOBgNVHQ8BAf8EBAMCAbYwHQYDVR0lBBYwFAYIKwYBBQUHAwIGCCsGAQUFBwMBMCgGA1UdEQQhMB+CHWt0bnN2bS13aW4yMDE2LmVuemlhbnRlY2guY29tMB0GA1UdDgQWBBQ+hviNN6qnfUXdVAkjMvFsc7YRuzANBgkqhkiG9w0BAQsFAAOCAQEATeTawpW8WOAHTlUmw99fbPQKRsM4QO1R9q+90ItO1LULJS1Fh4zeg+/GVP65amEbBeMjiN2cXKeylfa3zlYoCTzVD1PcEHtGj5z1MuKhBndByaV5po/Lde5f/oLVeiNFbNHXvjmNT5I33LxSzDn4wM2xtlcTwptJC9SXfOm+tLf4omhNpdH8Z+1H1XraUWSzWVdV/X8Afq2lKjdiC4bEu2xcI9zw6czMP/ai4/4YhOvvUJLEqQ4ZCCQ41OPBohrZInUaAEyvqWjtMbKN5tupKssPgmOTaaxXqos8pk8zl/AyXI7SDU1Ngi+NZOxtK/7Lb9WIAUAwe0cIOm8ck3zevA==","password":""}},"sample2":{"value":{"filename":"adcs-proxy-ca.pem","data":"MIIDVDCCAjygAwIBAgIQUKVkjebyvqRMWO4gk4zIYTANBgkqhkiG9w0BAQsFADAoMSYwJAYDVQQDDB1rdG5zdm0td2luMjAxNi5lbnppYW50ZWNoLmNvbTAeFw0yMjAzMTUxMjIwMDNaFw0zMjAzMTUxMjI5NThaMCgxJjAkBgNVBAMMHWt0bnN2bS13aW4yMDE2LmVuemlhbnRlY2guY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAodlhI5Z5WN+8jLQYTWP9qvzIMe4UiTKW/bCuB2P0bnwdKJclcAOLChtPhEfcJwvm65E/Ag2pp83gvseTsp2fEGj+5tLUEiwia3yfRGqVEoA/02b+2Pql51YSObEqSlzLdIPEgkBM70uXbC8pcOlRDZYbxFEhZX43GW6wrB0IKhGoWj5cc9jBt+VFJAUsGq0ytuN8LQ70l4gYZgHlkLzQyaqVJS8SjZrwFks436TnRDPokR39zaYdsKkkjkutV1CeeXwtFCADI8xpRGKSa3e9zyU8pcuWUBhKw8IMi1v0LYuuY4ES4PHDDQ6gUk8EMKNNErzOeBBTpq0D/Z6v0q5ZFwIDAQABo3oweDAOBgNVHQ8BAf8EBAMCAbYwHQYDVR0lBBYwFAYIKwYBBQUHAwIGCCsGAQUFBwMBMCgGA1UdEQQhMB+CHWt0bnN2bS13aW4yMDE2LmVuemlhbnRlY2guY29tMB0GA1UdDgQWBBQ+hviNN6qnfUXdVAkjMvFsc7YRuzANBgkqhkiG9w0BAQsFAAOCAQEATeTawpW8WOAHTlUmw99fbPQKRsM4QO1R9q+90ItO1LULJS1Fh4zeg+/GVP65amEbBeMjiN2cXKeylfa3zlYoCTzVD1PcEHtGj5z1MuKhBndByaV5po/Lde5f/oLVeiNFbNHXvjmNT5I33LxSzDn4wM2xtlcTwptJC9SXfOm+tLf4omhNpdH8Z+1H1XraUWSzWVdV/X8Afq2lKjdiC4bEu2xcI9zw6czMP/ai4/4YhOvvUJLEqQ4ZCCQ41OPBohrZInUaAEyvqWjtMbKN5tupKssPgmOTaaxXqos8pk8zl/AyXI7SDU1Ngi+NZOxtK/7Lb9WIAUAwe0cIOm8ck3zevA==","password":""}}}}}},"responses":{"204":{"description":"AD CS Settings certificate for the Jamf Pro server is of valid file format."}},"x-required-privileges":["Update AD CS Settings","Create AD CS Settings"],"x-action":true}},"/v1/pki/adcs-settings/validate-client-certificate":{"post":{"tags":["adcs-settings"],"summary":"Validate AD CS Settings client certificate\n","description":"Validate AD CS Settings client certificate for file format and correct password. Must be base64-encoded PKCS#12 file content, obtainable by `openssl base64 < /file/path/filename.pfx | tr -d '\\n' | pbcopy` in linux terminal, or similar parsing methods. This should only contain a single X.509 certificate.\n\n> 📋 **Required privileges:**\n> - Update AD CS Settings\n> - Create AD CS Settings","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdcsCertificate"},"examples":{"sample1":{"value":{"filename":"client-cert.pfx","data":"MIINvwIBAzCCDXsGCSqGSIb3DQEHAaCCDWwEgg1oMIINZDCCBg8GCSqGSIb3DQEHAaCCBgAEggX8MIIF+DCCBfQGCyqGSIb3DQEMCgECoIIE/jCCBPowHAYKKoZIhvcNAQwBAzAOBAhIPjJB7Ls2fAICB9AEggTY3EKQVRtYWdwsisoMtXWIYJXvLTLm3WtBULqFdkVIXiMg0Y6cKtMdYHoLKEhyZwcsFxiUSfM4QkGpo4woshiwjFBEwc7Iu3waIGe5CVmAsZ9ynvqBirCfelmt5mLn6iU+AjR/xcYqwV2MJNO+lo8K3gVGDHvE0caJQB2blFioW7QOsGb+8GWpNNdWkbTHB6zH3XRB1lVm+9rsr1BF1l3lzEQOlc4P1nBtNumf2TVBoU6cM4lgiWA0as896nUilj1w9AAXiQcdhIT4zaaJFP4AnXqL94bDDlfceA60HNpzCYRIGOhohnxBtquUoDw6uHBnmo6PMkB2KkYNVoxk+/+egF3arCdjbj4OkWhZ/wzNGa0uHTA6nG8bNWRXULWZ/QfvQi424vKfuLSGQty1AP0VHOeoY4SkWvDz+gCEfP29C8vk4kWcnl/0dsE1wmmowuydJvL6WhGRAPii1y/BOJW0FTXav03o7SP5aYZXnr8qLKKUkmSziV1toY7YFl7lUCKYj5j/1I+5uaGlEqbjEsQs6GwL6S9M6ggpbGSBT4fp4xH1FSXeRoWbbVKuB3+Sin8lwP4ZrSTarufWpYCnnLNfYgTFiatpbP9u9BS4PaBVZTFygyvl4Gj4QtVMtZy39tRqiN82RkG61DiTeLFI0xXGqMctQLpOHU8Rn07tBZBKWI6U5wc2nDKWr60ohQPVEglt5MEqYgPuPcoUvj2GOG536pHR6HeWiX3nszv3KCNxOog8hkvs1JKoJuByhgzeUR6ylHTBOq+jNrbTJvzWGXEK6+I5rUmViITmMksumg96kUgP2ZPYzGbaJLt0lE1zD+rI05EWroZh4GQpcwfX8PQkbadR10MXbhnPe039TwhbgtDecxgNZQd0Fs4WTZqzpZOkUpcvWxHmPm1iSCd860EvNKwJos4kAlgE2tMtPpAiNqhxOzzgMiSFdxOnTV3khJ2xTL4J8UsObbn2K6qp9EhXcUUl+0Xn7C8+T4PIYkW4G5LNkIjv/3Df7VGjaTwk0rJtFwJh8k09BPA4ETNaxC/C7JFwkW9eJYtYi/UxStMSrVj1HGmnsG036C+IYDjKeUWvNK7QV2mq+Pas5WncgRU8BwgU5D2fLffRjtnP1UnnTkHsk9wocUqIaEpylIDnmUzA6mgM/4vfibF2BHDgkLjo5w2kgSjoSsRp7z23RudESgIyax21aWtmBZvDLTCn7KXGwXPELxLoU3lvOow7G8XTwAymaV/ymn6aQDp9tEwMHL0slRc3okRtAkHvhwUWpy7wXHup/aGhciA0fpkZhU1UECxGybhjPANsBzB9gUoBo2QWmKI7pjAovDWTbqHMylEi0Xumj+FxJgrdSHm9IbkX92ShJKLoD/flGfMS9pNVaqoCSsa66lPSCNqnDEF85/rr1vDBwDHSPChZri7748VWXxNzoCnbp2wYlRTUn8DOvuMDdO5W/tWnxmHgaiOxOKgoiRsl0Rm2N9E9sse5VLkXnQG4/Ybgzdq9xsxB9RdL5pnXsvBjCc+ruH3/XW4ufEq10PvdruBSz7jFqMfXJZ0APqNcRAm6UVsLSIqYbDuaDXMIJATUzy+EGVLdUcLfcMpWWxXgtUr+mJLvWTTlHTdoF57mJoY0XiFe2lz/xsumI0CgA2z0AyUmvDGB4jANBgkrBgEEAYI3EQIxADATBgkqhkiG9w0BCRUxBgQEAQAAADBdBgkqhkiG9w0BCRQxUB5OAHQAZQAtADEANgAxADMANgAxADQANAAtADYAMQA4ADQALQA0ADYAYwAwAC0AOAA3ADIAMgAtAGEAZQBmADgAMgBkADkANABmAGUAZgBkMF0GCSsGAQQBgjcRATFQHk4ATQBpAGMAcgBvAHMAbwBmAHQAIABTAG8AZgB0AHcAYQByAGUAIABLAGUAeQAgAFMAdABvAHIAYQBnAGUAIABQAHIAbwB2AGkAZABlAHIwggdNBgkqhkiG9w0BBwGgggc+BIIHOjCCBzYwggODBgsqhkiG9w0BDAoBA6CCA3AwggNsBgoqhkiG9w0BCRYBoIIDXASCA1gwggNUMIICPKADAgECAhBQpWSN5vK+pExY7iCTjMhhMA0GCSqGSIb3DQEBCwUAMCgxJjAkBgNVBAMMHWt0bnN2bS13aW4yMDE2LmVuemlhbnRlY2guY29tMB4XDTIyMDMxNTEyMjAwM1oXDTMyMDMxNTEyMjk1OFowKDEmMCQGA1UEAwwda3Ruc3ZtLXdpbjIwMTYuZW56aWFudGVjaC5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCh2WEjlnlY37yMtBhNY/2q/Mgx7hSJMpb9sK4HY/RufB0olyVwA4sKG0+ER9wnC+brkT8CDamnzeC+x5OynZ8QaP7m0tQSLCJrfJ9EapUSgD/TZv7Y+qXnVhI5sSpKXMt0g8SCQEzvS5dsLylw6VENlhvEUSFlfjcZbrCsHQgqEahaPlxz2MG35UUkBSwarTK243wtDvSXiBhmAeWQvNDJqpUlLxKNmvAWSzjfpOdEM+iRHf3Nph2wqSSOS61XUJ55fC0UIAMjzGlEYpJrd73PJTyly5ZQGErDwgyLW/Qti65jgRLg8cMNDqBSTwQwo00SvM54EFOmrQP9nq/SrlkXAgMBAAGjejB4MA4GA1UdDwEB/wQEAwIBtjAdBgNVHSUEFjAUBggrBgEFBQcDAgYIKwYBBQUHAwEwKAYDVR0RBCEwH4Ida3Ruc3ZtLXdpbjIwMTYuZW56aWFudGVjaC5jb20wHQYDVR0OBBYEFD6G+I03qqd9Rd1UCSMy8WxzthG7MA0GCSqGSIb3DQEBCwUAA4IBAQBN5NrClbxY4AdOVSbD319s9ApGwzhA7VH2r73Qi07UtQslLUWHjN6D78ZU/rlqYRsF4yOI3Zxcp7KV9rfOVigJPNUPU9wQe0aPnPUy4qEGd0HJpXmmj8t17l/+gtV6I0Vs0de+OY1PkjfcvFLMOfjAzbG2VxPCm0kL1Jd86b60t/iiaE2l0fxn7UfVetpRZLNZV1X9fwB+raUqN2ILhsS7bFwj3PDpzMw/9qLj/hiE6+9QksSpDhkIJDjU48GiGtkidRoATK+paO0xso3nPLNi5s+CY5NprFeqizymTzOX8DJcjtINTU2CL41k7G0r/stv1YgBQDB7Rwg6bxyTfN68MQAwggOrBgsqhkiG9w0BDAoBA6CCA4MwggN/BgoqhkiG9w0BCRYBoIIDbwSCA2swggNnMIICT6ADAgECAhAaVZcv8KdtjUbjDGvLd3toMA0GCSqGSIb3DQEBCwUAMCgxJjAkBgNVBAMMHWt0bnN2bS13aW4yMDE2LmVuemlhbnRlY2guY29tMB4XDTIyMDMxNTEyMjAwM1oXDTMyMDMxNTEyMzAwM1owIDEeMBwGA1UEAwwVaDY4aGNnLnF1aWNrLmphbWYubmV0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAvBD1C4tR8vWZeSDdQ6AhynzMB47plvkqrXnmhcavlsDnu8Zfanr6gjUND0NK2Ufm0BBhH86kIcYMwehLYVNNfC3RTCT+QLo3wIn7VxUnsAPTqD23QjNwYnDTBQDkBrQIrFYaPc0RxO0MYexg/EqgEiAF1nJAZ3tndev1LBSEO5iN+8patoyV7jE3JlgF9qN0T0XCELrRpEi/pxKaVpAupXp38NBWVAJ6yqWuTCP2gcvnvo8KHHUTpJhwUcxr1aKUjX0LBnJ/mStQ8Cfckr7sLaHXyt4ei5uiQID69d/6JNoqpfoWW0EcHW8V3fiLX5fzsMBGjmRa/R8//zVM/ebpSwIDAQABo4GUMIGRMA4GA1UdDwEB/wQEAwIEsDAdBgNVHSUEFjAUBggrBgEFBQcDAgYIKwYBBQUHAwEwIAYDVR0RBBkwF4IVaDY4aGNnLnF1aWNrLmphbWYubmV0MB8GA1UdIwQYMBaAFD6G+I03qqd9Rd1UCSMy8WxzthG7MB0GA1UdDgQWBBT1Gk6lWWBdrF1z7n/FMgxT5Hb5YjANBgkqhkiG9w0BAQsFAAOCAQEAj0UtZ118booksRr7kDg47IhlhSlkhZVnZfkRUHY2QSYBkHNyilcb9rWJIAzrSI5q+RV+FDXDEc0at9CmH2yIb+dYSojxj1ebSCloZb5QiHfAZTFN5+AicESWb0PMGiiz1HeU8Bm2bjHIRx4OLKSm4agMck/6iBDJhduiidrEZkmz8MRFr04GE/9MAg3JG149JeCSS54seKx7tBx+dJjzHJg2HeqZtOKjaKLOnstquEVhwgGXIqH51lQd5SOfYJH1cQyi6xe7SBZ5YYYF1iubhMUqvYnbugskm35nYWk9XObw4QRnfTQNIuW6p1cz2Nk+yaDheraycaxbBGYaXMgIJzEVMBMGCSqGSIb3DQEJFTEGBAQBAAAAMDswHzAHBgUrDgMCGgQUA/Hryi7gjlbKpKpGVlTvAnjevyAEFFhGKjlcFPkz5+bUOnz1OcWq/3zPAgIH0A==","password":"password-example"}},"sample2":{"value":{"filename":"client-cert.p12","data":"MIINvwIBAzCCDXsGCSqGSIb3DQEHAaCCDWwEgg1oMIINZDCCBg8GCSqGSIb3DQEHAaCCBgAEggX8MIIF+DCCBfQGCyqGSIb3DQEMCgECoIIE/jCCBPowHAYKKoZIhvcNAQwBAzAOBAhIPjJB7Ls2fAICB9AEggTY3EKQVRtYWdwsisoMtXWIYJXvLTLm3WtBULqFdkVIXiMg0Y6cKtMdYHoLKEhyZwcsFxiUSfM4QkGpo4woshiwjFBEwc7Iu3waIGe5CVmAsZ9ynvqBirCfelmt5mLn6iU+AjR/xcYqwV2MJNO+lo8K3gVGDHvE0caJQB2blFioW7QOsGb+8GWpNNdWkbTHB6zH3XRB1lVm+9rsr1BF1l3lzEQOlc4P1nBtNumf2TVBoU6cM4lgiWA0as896nUilj1w9AAXiQcdhIT4zaaJFP4AnXqL94bDDlfceA60HNpzCYRIGOhohnxBtquUoDw6uHBnmo6PMkB2KkYNVoxk+/+egF3arCdjbj4OkWhZ/wzNGa0uHTA6nG8bNWRXULWZ/QfvQi424vKfuLSGQty1AP0VHOeoY4SkWvDz+gCEfP29C8vk4kWcnl/0dsE1wmmowuydJvL6WhGRAPii1y/BOJW0FTXav03o7SP5aYZXnr8qLKKUkmSziV1toY7YFl7lUCKYj5j/1I+5uaGlEqbjEsQs6GwL6S9M6ggpbGSBT4fp4xH1FSXeRoWbbVKuB3+Sin8lwP4ZrSTarufWpYCnnLNfYgTFiatpbP9u9BS4PaBVZTFygyvl4Gj4QtVMtZy39tRqiN82RkG61DiTeLFI0xXGqMctQLpOHU8Rn07tBZBKWI6U5wc2nDKWr60ohQPVEglt5MEqYgPuPcoUvj2GOG536pHR6HeWiX3nszv3KCNxOog8hkvs1JKoJuByhgzeUR6ylHTBOq+jNrbTJvzWGXEK6+I5rUmViITmMksumg96kUgP2ZPYzGbaJLt0lE1zD+rI05EWroZh4GQpcwfX8PQkbadR10MXbhnPe039TwhbgtDecxgNZQd0Fs4WTZqzpZOkUpcvWxHmPm1iSCd860EvNKwJos4kAlgE2tMtPpAiNqhxOzzgMiSFdxOnTV3khJ2xTL4J8UsObbn2K6qp9EhXcUUl+0Xn7C8+T4PIYkW4G5LNkIjv/3Df7VGjaTwk0rJtFwJh8k09BPA4ETNaxC/C7JFwkW9eJYtYi/UxStMSrVj1HGmnsG036C+IYDjKeUWvNK7QV2mq+Pas5WncgRU8BwgU5D2fLffRjtnP1UnnTkHsk9wocUqIaEpylIDnmUzA6mgM/4vfibF2BHDgkLjo5w2kgSjoSsRp7z23RudESgIyax21aWtmBZvDLTCn7KXGwXPELxLoU3lvOow7G8XTwAymaV/ymn6aQDp9tEwMHL0slRc3okRtAkHvhwUWpy7wXHup/aGhciA0fpkZhU1UECxGybhjPANsBzB9gUoBo2QWmKI7pjAovDWTbqHMylEi0Xumj+FxJgrdSHm9IbkX92ShJKLoD/flGfMS9pNVaqoCSsa66lPSCNqnDEF85/rr1vDBwDHSPChZri7748VWXxNzoCnbp2wYlRTUn8DOvuMDdO5W/tWnxmHgaiOxOKgoiRsl0Rm2N9E9sse5VLkXnQG4/Ybgzdq9xsxB9RdL5pnXsvBjCc+ruH3/XW4ufEq10PvdruBSz7jFqMfXJZ0APqNcRAm6UVsLSIqYbDuaDXMIJATUzy+EGVLdUcLfcMpWWxXgtUr+mJLvWTTlHTdoF57mJoY0XiFe2lz/xsumI0CgA2z0AyUmvDGB4jANBgkrBgEEAYI3EQIxADATBgkqhkiG9w0BCRUxBgQEAQAAADBdBgkqhkiG9w0BCRQxUB5OAHQAZQAtADEANgAxADMANgAxADQANAAtADYAMQA4ADQALQA0ADYAYwAwAC0AOAA3ADIAMgAtAGEAZQBmADgAMgBkADkANABmAGUAZgBkMF0GCSsGAQQBgjcRATFQHk4ATQBpAGMAcgBvAHMAbwBmAHQAIABTAG8AZgB0AHcAYQByAGUAIABLAGUAeQAgAFMAdABvAHIAYQBnAGUAIABQAHIAbwB2AGkAZABlAHIwggdNBgkqhkiG9w0BBwGgggc+BIIHOjCCBzYwggODBgsqhkiG9w0BDAoBA6CCA3AwggNsBgoqhkiG9w0BCRYBoIIDXASCA1gwggNUMIICPKADAgECAhBQpWSN5vK+pExY7iCTjMhhMA0GCSqGSIb3DQEBCwUAMCgxJjAkBgNVBAMMHWt0bnN2bS13aW4yMDE2LmVuemlhbnRlY2guY29tMB4XDTIyMDMxNTEyMjAwM1oXDTMyMDMxNTEyMjk1OFowKDEmMCQGA1UEAwwda3Ruc3ZtLXdpbjIwMTYuZW56aWFudGVjaC5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCh2WEjlnlY37yMtBhNY/2q/Mgx7hSJMpb9sK4HY/RufB0olyVwA4sKG0+ER9wnC+brkT8CDamnzeC+x5OynZ8QaP7m0tQSLCJrfJ9EapUSgD/TZv7Y+qXnVhI5sSpKXMt0g8SCQEzvS5dsLylw6VENlhvEUSFlfjcZbrCsHQgqEahaPlxz2MG35UUkBSwarTK243wtDvSXiBhmAeWQvNDJqpUlLxKNmvAWSzjfpOdEM+iRHf3Nph2wqSSOS61XUJ55fC0UIAMjzGlEYpJrd73PJTyly5ZQGErDwgyLW/Qti65jgRLg8cMNDqBSTwQwo00SvM54EFOmrQP9nq/SrlkXAgMBAAGjejB4MA4GA1UdDwEB/wQEAwIBtjAdBgNVHSUEFjAUBggrBgEFBQcDAgYIKwYBBQUHAwEwKAYDVR0RBCEwH4Ida3Ruc3ZtLXdpbjIwMTYuZW56aWFudGVjaC5jb20wHQYDVR0OBBYEFD6G+I03qqd9Rd1UCSMy8WxzthG7MA0GCSqGSIb3DQEBCwUAA4IBAQBN5NrClbxY4AdOVSbD319s9ApGwzhA7VH2r73Qi07UtQslLUWHjN6D78ZU/rlqYRsF4yOI3Zxcp7KV9rfOVigJPNUPU9wQe0aPnPUy4qEGd0HJpXmmj8t17l/+gtV6I0Vs0de+OY1PkjfcvFLMOfjAzbG2VxPCm0kL1Jd86b60t/iiaE2l0fxn7UfVetpRZLNZV1X9fwB+raUqN2ILhsS7bFwj3PDpzMw/9qLj/hiE6+9QksSpDhkIJDjU48GiGtkidRoATK+paO0xso3nPLNi5s+CY5NprFeqizymTzOX8DJcjtINTU2CL41k7G0r/stv1YgBQDB7Rwg6bxyTfN68MQAwggOrBgsqhkiG9w0BDAoBA6CCA4MwggN/BgoqhkiG9w0BCRYBoIIDbwSCA2swggNnMIICT6ADAgECAhAaVZcv8KdtjUbjDGvLd3toMA0GCSqGSIb3DQEBCwUAMCgxJjAkBgNVBAMMHWt0bnN2bS13aW4yMDE2LmVuemlhbnRlY2guY29tMB4XDTIyMDMxNTEyMjAwM1oXDTMyMDMxNTEyMzAwM1owIDEeMBwGA1UEAwwVaDY4aGNnLnF1aWNrLmphbWYubmV0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAvBD1C4tR8vWZeSDdQ6AhynzMB47plvkqrXnmhcavlsDnu8Zfanr6gjUND0NK2Ufm0BBhH86kIcYMwehLYVNNfC3RTCT+QLo3wIn7VxUnsAPTqD23QjNwYnDTBQDkBrQIrFYaPc0RxO0MYexg/EqgEiAF1nJAZ3tndev1LBSEO5iN+8patoyV7jE3JlgF9qN0T0XCELrRpEi/pxKaVpAupXp38NBWVAJ6yqWuTCP2gcvnvo8KHHUTpJhwUcxr1aKUjX0LBnJ/mStQ8Cfckr7sLaHXyt4ei5uiQID69d/6JNoqpfoWW0EcHW8V3fiLX5fzsMBGjmRa/R8//zVM/ebpSwIDAQABo4GUMIGRMA4GA1UdDwEB/wQEAwIEsDAdBgNVHSUEFjAUBggrBgEFBQcDAgYIKwYBBQUHAwEwIAYDVR0RBBkwF4IVaDY4aGNnLnF1aWNrLmphbWYubmV0MB8GA1UdIwQYMBaAFD6G+I03qqd9Rd1UCSMy8WxzthG7MB0GA1UdDgQWBBT1Gk6lWWBdrF1z7n/FMgxT5Hb5YjANBgkqhkiG9w0BAQsFAAOCAQEAj0UtZ118booksRr7kDg47IhlhSlkhZVnZfkRUHY2QSYBkHNyilcb9rWJIAzrSI5q+RV+FDXDEc0at9CmH2yIb+dYSojxj1ebSCloZb5QiHfAZTFN5+AicESWb0PMGiiz1HeU8Bm2bjHIRx4OLKSm4agMck/6iBDJhduiidrEZkmz8MRFr04GE/9MAg3JG149JeCSS54seKx7tBx+dJjzHJg2HeqZtOKjaKLOnstquEVhwgGXIqH51lQd5SOfYJH1cQyi6xe7SBZ5YYYF1iubhMUqvYnbugskm35nYWk9XObw4QRnfTQNIuW6p1cz2Nk+yaDheraycaxbBGYaXMgIJzEVMBMGCSqGSIb3DQEJFTEGBAQBAAAAMDswHzAHBgUrDgMCGgQUA/Hryi7gjlbKpKpGVlTvAnjevyAEFFhGKjlcFPkz5+bUOnz1OcWq/3zPAgIH0A==","password":"password-example"}}}}}},"responses":{"204":{"description":"AD CS Settings certificate for client server is of valid file format and has correct password."}},"x-required-privileges":["Update AD CS Settings","Create AD CS Settings"],"x-action":true}},"/v1/pki/adcs-settings/{id}":{"get":{"tags":["adcs-settings"],"summary":"Get AD CS Settings configuration for the ID value\n","description":"Get AD CS Settings configuration for the ID value including public key information, but not including any password information.\n\n> 📋 **Required privilege:** Read AD CS Settings","parameters":[{"name":"id","in":"path","description":"ID of the AD CS Settings configuration.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdcsSettingsResponse"}}}}},"x-required-privileges":["Read AD CS Settings"]},"delete":{"tags":["adcs-settings"],"summary":"Delete AD CS Settings configuration by ID\n","description":"Delete AD CS Settings configuration, only if reassignment of Certificate Authority succeeds and no config profiles are using the configuration.\n\n> 📋 **Required privilege:** Delete AD CS Settings","parameters":[{"name":"id","in":"path","description":"ID of the AD CS Settings configuration.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Delete AD CS Settings"]},"patch":{"tags":["adcs-settings"],"summary":"Update AD CS Settings configuration\n","description":"Update AD CS Settings configuration, where certificate information must be provided in full, or not at all. Cannot change between inbound and outbound modes.\n\n> 📋 **Required privilege:** Update AD CS Settings","parameters":[{"name":"id","in":"path","description":"ID of the AD CS Settings configuration.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/AdcsSettings"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update AD CS Settings"]}},"/v1/pki/adcs-settings/{id}/dependencies":{"get":{"tags":["adcs-settings"],"summary":"Retrieve list of AD CS Settings dependencies","description":"Retrieve list of AD CS Settings dependencies\n\n> 📋 **Required privilege:** Read AD CS Settings","parameters":[{"name":"id","in":"path","description":"AD CS Settings ID","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdcsDependencies"}}}}},"x-required-privileges":["Read AD CS Settings"]}},"/v1/pki/adcs-settings/{id}/history":{"get":{"tags":["adcs-settings"],"summary":"Get specified AD CS Settings history object\n","description":"Get specified AD CS Settings history object.\n\n\n> 📋 **Required privilege:** Read AD CS Settings","parameters":[{"name":"id","in":"path","description":"ID of the AD CS Settings configuration.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["date:desc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Details of AD CS Settings history was found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistorySearchResults"}}}},"404":{"description":"Specified AD CS Settings object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read AD CS Settings"]},"post":{"tags":["adcs-settings"],"summary":"Add specified AD CS Settings object note\n","description":"Adds specified AD CS Settings object note.\n\n\n> 📋 **Required privilege:** Update AD CS Settings","parameters":[{"name":"id","in":"path","description":"Instance ID of AD CS Settings history record.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"AD CS Settings history notes to create.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistoryNote"}}},"required":true},"responses":{"201":{"description":"Notes of AD CS Settings history were added.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"404":{"description":"Specified AD CS Settings object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"AD CS Settings history cannot be saved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update AD CS Settings"]}},"/v1/advanced-mobile-device-searches":{"get":{"tags":["advanced-mobile-device-searches"],"summary":"Get Advanced Search objects\n","description":"Gets Advanced Search Objects\n\n\n> 📋 **Required privilege:** Read Advanced Mobile Device Searches","responses":{"200":{"description":"Successful response - Advanced searches retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvancedSearchSearchResults"}}}}},"x-required-privileges":["Read Advanced Mobile Device Searches"]},"post":{"tags":["advanced-mobile-device-searches"],"summary":"Create Advanced Search object\n","description":"Creates Advanced Search Object\n\n\n> 📋 **Required privilege:** Create Advanced Mobile Device Searches","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvancedSearch"}}},"required":true},"responses":{"201":{"description":"Successful response - Advanced search created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}}},"x-required-privileges":["Create Advanced Mobile Device Searches"]}},"/v1/advanced-mobile-device-searches/choices":{"get":{"tags":["advanced-mobile-device-searches"],"summary":"Get Mobile Device Advanced Search criteria choices\n","description":"Gets Mobile Device Advanced Search criteria choices. A list of potentially valid choices can be found by navigating to the Criteria page of the Advanced Mobile Device Search creation process. A few are \"App Name\", \"Building\", and \"Display Name\".\n\n\n> 📋 **Required privilege:** Read Advanced Mobile Device Searches","parameters":[{"name":"criteria","in":"query","required":true,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"site","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","default":"-1"}},{"name":"contains","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","default":"null"}}],"responses":{"200":{"description":"Successful response - Criteria choices retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvancedSearchCriteriaChoices"}}}}},"x-required-privileges":["Read Advanced Mobile Device Searches"]}},"/v1/advanced-mobile-device-searches/delete-multiple":{"post":{"tags":["advanced-mobile-device-searches"],"summary":"Remove specified Advanced Search objects\n","description":"Removes specified Advanced Search Objects\n\n\n> 📋 **Required privilege:** Delete Advanced Mobile Device Searches","requestBody":{"description":"ids of the building to be deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ids"}}},"required":true},"responses":{"204":{"description":"Successful response - Advanced searches deleted"},"400":{"description":"At least one target Advanced Search does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Delete Advanced Mobile Device Searches"],"x-action":true}},"/v1/advanced-mobile-device-searches/{id}":{"get":{"tags":["advanced-mobile-device-searches"],"summary":"Get specified Advanced Search object\n","description":"Gets Specified Advanced Search Object\n\n\n> 📋 **Required privilege:** Read Advanced Mobile Device Searches","parameters":[{"name":"id","in":"path","description":"id of target Advanced Search","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response - Advanced Search retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvancedSearch"}}}},"404":{"description":"Target Advanced Search does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Advanced Mobile Device Searches"]},"put":{"tags":["advanced-mobile-device-searches"],"summary":"Get specified Advanced Search object\n","description":"Gets Specified Advanced Search Object\n\n\n> 📋 **Required privilege:** Update Advanced Mobile Device Searches","parameters":[{"name":"id","in":"path","description":"id of target Advanced Search","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvancedSearch"}}},"required":true},"responses":{"200":{"description":"Successful response - Advanced Search updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvancedSearch"}}}},"404":{"description":"Target Advanced Search does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Advanced Mobile Device Searches"]},"delete":{"tags":["advanced-mobile-device-searches"],"summary":"Remove specified Advanced Search object\n","description":"Removes specified Advanced Search Object\n\n\n> 📋 **Required privilege:** Delete Advanced Mobile Device Searches","parameters":[{"name":"id","in":"path","description":"instance id of advanced search record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful response - Advanced search deleted"},"404":{"description":"Target Advanced Search does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Delete Advanced Mobile Device Searches"]}},"/v1/advanced-user-content-searches":{"get":{"tags":["advanced-user-content-searches"],"summary":"Get All Advanced User Content Search objects\n","description":"Get All Advanced User Content Search Objects\n\n\n> 📋 **Required privilege:** Read Advanced User Content Searches","responses":{"200":{"description":"Successful response - Advanced User Content Searches retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvancedUserContentSearchSearchResults"}}}}},"x-required-privileges":["Read Advanced User Content Searches"]},"post":{"tags":["advanced-user-content-searches"],"summary":"Create Advanced User Content Search object\n","description":"Creates Advanced User Content Search Object\n\n\n> 📋 **Required privilege:** Create Advanced User Content Searches","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvancedUserContentSearch"}}},"required":true},"responses":{"201":{"description":"Successful response - Advanced User Content Search created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}}},"x-required-privileges":["Create Advanced User Content Searches"]}},"/v1/advanced-user-content-searches/{id}":{"get":{"tags":["advanced-user-content-searches"],"summary":"Get Specified Advanced User Content Search object\n","description":"Gets Specified Advanced User Content Search Object\n\n\n> 📋 **Required privilege:** Read Advanced User Content Searches","parameters":[{"name":"id","in":"path","description":"id of target Advanced User Content Search","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response - Advanced User Content Search retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvancedUserContentSearch"}}}},"404":{"description":"Target Advanced User Content Search does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Advanced User Content Searches"]},"put":{"tags":["advanced-user-content-searches"],"summary":"Get Specified Advanced User Content Search object\n","description":"Gets Specified Advanced User Content Search Object\n\n\n> 📋 **Required privilege:** Update Advanced User Content Searches","parameters":[{"name":"id","in":"path","description":"id of target Advanced User Content Search","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvancedUserContentSearch"}}},"required":true},"responses":{"200":{"description":"Successful response - Advanced User Content Search updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvancedUserContentSearch"}}}},"404":{"description":"Target Advanced User Content Search does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Advanced User Content Searches"]},"delete":{"tags":["advanced-user-content-searches"],"summary":"Remove specified Advanced User Content Search object\n","description":"Removes specified Advanced User Content Search Object\n\n\n> 📋 **Required privilege:** Delete Advanced User Content Searches","parameters":[{"name":"id","in":"path","description":"instance id of Advanced User Content Search record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful response - Advanced User Content Search deleted"},"404":{"description":"Target Advanced User Content Search does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Delete Advanced User Content Searches"]}},"/auth":{"get":{"tags":["api-authentication"],"summary":"Get all the Authorization details associated with the current api\n","description":"Get all the authorization details associated with the current api token","responses":{"200":{"description":"Current authorization details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Authorization"}}}}},"deprecated":true,"security":[{"Bearer":[]}],"x-authentication-required":true,"x-deprecation-date":"2020-06-01"}},"/auth/current":{"post":{"tags":["api-authentication"],"summary":"Get the authorization details associated with the current API token\n","description":"Get the authorization details associated with the current API token for the users current site","responses":{"200":{"description":"Authorization details for users current site.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CurrentAuthorization"}}}}},"deprecated":true,"security":[{"Bearer":[]}],"x-authentication-required":true,"x-action":true,"x-deprecation-date":"2020-06-01"}},"/auth/invalidateToken":{"post":{"tags":["api-authentication"],"summary":"Invalidate current token\n","description":"Invalidates current token","responses":{"204":{"description":"token invalidated"}},"deprecated":true,"security":[{"Bearer":[]}],"x-authentication-required":true,"x-action":true,"x-deprecation-date":"2020-06-01"}},"/auth/keepAlive":{"post":{"tags":["api-authentication"],"summary":"Invalidate existing token and generates new token\n","description":"Invalidates existing token and generates new token with extended expiration based on existing token credentials.","responses":{"200":{"description":"Updated token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthToken"}}}}},"deprecated":true,"security":[{"Bearer":[]}],"x-authentication-required":true,"x-action":true,"x-deprecation-date":"2020-06-01"}},"/v1/auth":{"get":{"tags":["api-authentication"],"summary":"Get all the Authorization details associated with the current api\n","description":"Get all the authorization details associated with the current api token","responses":{"200":{"description":"Current authorization details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationV1"}}}}},"security":[{"Bearer":[]}],"x-authentication-required":true}},"/v1/auth/invalidate-token":{"post":{"tags":["api-authentication"],"summary":"Invalidate current token\n","description":"Invalidates current token","responses":{"204":{"description":"token invalidated"}},"security":[{"Bearer":[]}],"x-authentication-required":true,"x-action":true}},"/v1/auth/keep-alive":{"post":{"tags":["api-authentication"],"summary":"Invalidate existing token and generates new token\n","description":"Invalidates existing token and generates new token with extended expiration based on existing token credentials.","responses":{"200":{"description":"Updated token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthTokenV1"}}}}},"security":[{"Bearer":[]}],"x-authentication-required":true,"x-action":true}},"/v1/auth/token":{"post":{"tags":["api-authentication"],"summary":"Create a token based on other authentication details (basic, etc.)","description":"Create a token based on other authentication details (basic, etc.).\n","responses":{"200":{"description":"New auth token generated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthTokenV1"}}}},"401":{"description":"Authentication failed. If the admin has forced the user to change their password before next user login, or the non-SSO account's password has expired, an ApiError with USER_EXPIRED_PASSWORD will be returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"BasicAuth":[]}],"x-authentication-required":false,"x-action":true}},"/v1/oauth/token":{"post":{"tags":["api-authentication"],"summary":"Obtain an access token using an API Client","description":"Obtain an access token using the OAuth2 client credentials flow","operationId":"postOAuthToken","requestBody":{"description":"Client credential token request","content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/OAuthTokenRequest"}}},"required":true},"responses":{"200":{"description":"OAuth2 token obtained successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthTokenResponse"}}}},"400":{"description":"Bad request. These differ from standard Jamf Pro API error response for better compatability\nwith a wide variety of standard clients. See https://datatracker.ietf.org/doc/html/rfc6749#section-5.2\nfor additional details.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthTokenEndpointErrorResponse"}}}}},"x-action":true,"x-authentication-required":false}},"/v1/api-integrations":{"get":{"tags":["api-integrations"],"summary":"Get the current API Integrations","description":"Get Jamf|Pro API Integrations with Search Criteria\n\n> 📋 **Required privilege:** Read API Integrations","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Fields allowed in the query: id, displayName. Example: sort=displayName:desc","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter app titles collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: id, displayName. Example: displayName==\"*IntegrationName*\"","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"A list of the current Jamf API Integrations","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiIntegrationSearchResult"}}}}},"x-required-privileges":["Read API Integrations"]},"post":{"tags":["api-integrations"],"summary":"Create API integration object","description":"Create API integration object\n\n> 📋 **Required privilege:** Create API Integrations","operationId":"postCreateApiIntegration","requestBody":{"description":"api integration object to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiIntegrationRequest"}}},"required":true},"responses":{"201":{"description":"Api Integration object was created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiIntegrationResponse"}}}}},"x-required-privileges":["Create API Integrations"]}},"/v1/api-integrations/{id}":{"get":{"tags":["api-integrations"],"summary":"Get specified API integration object","description":"Gets specified API integration object\n\n> 📋 **Required privilege:** Read API Integrations","operationId":"getOneApiIntegration","parameters":[{"name":"id","in":"path","description":"instance id of api integration object","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Details of api integration object were found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiIntegrationResponse"}}}},"404":{"description":"Specified api integration object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read API Integrations"]},"put":{"tags":["api-integrations"],"summary":"Update specified API integration object","description":"Update specified API integration object\n\n> 📋 **Required privilege:** Update API Integrations","operationId":"putUpdateApiIntegration","parameters":[{"name":"id","in":"path","description":"instance id of api integration object","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"api object to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiIntegrationRequest"}}},"required":true},"responses":{"200":{"description":"Api Integration updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiIntegrationResponse"}}}},"400":{"description":"Api Integration could not be updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Specified api integration object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update API Integrations"]},"delete":{"tags":["api-integrations"],"summary":"Remove specified API integration","description":"Removes specified API integration\n\n> 📋 **Required privilege:** Delete API Integrations","operationId":"deleteApiIntegration","parameters":[{"name":"id","in":"path","description":"instance id of api integration object","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Api Integration was deleted"},"404":{"description":"Specified api integration object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Delete API Integrations"]}},"/v1/api-integrations/{id}/client-credentials":{"post":{"tags":["api-integrations"],"summary":"Create client credentials for specified API integration","description":"Create client credentials for specified API integration\n\n> 📋 **Required privilege:** Create API Integrations","operationId":"postCreateClientCredentials","parameters":[{"name":"id","in":"path","description":"instance id of api integration object","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Client credentials have been created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthClientCredentials"}}}},"400":{"description":"Client credentials could not be created for this api integration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Specified api integration object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Create API Integrations"],"x-action":true}},"/v1/api-role-privileges":{"get":{"tags":["api-role-privileges"],"summary":"Get the current Jamf API Role Privileges","description":"Get role privileges\n\n> 📋 **Required privilege:** Read API Roles","responses":{"200":{"description":"A sorted list of the current Jamf API Roles Privileges","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiRolePrivileges"}}}}},"x-required-privileges":["Read API Roles"]}},"/v1/api-role-privileges/search":{"get":{"tags":["api-role-privileges"],"summary":"Search the current Jamf API Role Privileges","description":"Search role privileges\n\n> 📋 **Required privilege:** Read API Roles","parameters":[{"name":"name","in":"query","description":"The partial or complete privilege name we are searching for","required":true,"style":"form","explode":true,"schema":{"type":"string","example":"Flush"}},{"name":"limit","in":"query","description":"Limit the query results, defaults to 15","required":false,"style":"form","explode":true,"schema":{"type":"string","example":"50","default":"15"}}],"responses":{"200":{"description":"A list of matches Jamf API Roles Privileges","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiRolePrivileges"}}}}},"x-required-privileges":["Read API Roles"]}},"/v1/api-roles":{"get":{"tags":["api-roles"],"summary":"Get the current Jamf API Roles","description":"Get roles with Search Criteria\n\n> 📋 **Required privilege:** Read API Roles","operationId":"getAllApiRoles","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Fields allowed in the query: id, displayName. Example: sort=displayName:desc","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter app titles collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: id, displayName. Example: displayName==\"*myRole*\"","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"A list of the current Jamf API Roles","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiRoleResult"}}}}},"x-required-privileges":["Read API Roles"]},"post":{"tags":["api-roles"],"summary":"Create a new API role","description":"Post to create new Role\n\n> 📋 **Required privilege:** Create API Roles","operationId":"postCreateApiRole","requestBody":{"description":"API Integrations Role to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiRoleRequest"}}},"required":true},"responses":{"200":{"description":"The created Role","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiRole"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-action":true,"x-required-privileges":["Create API Roles"]}},"/v1/api-roles/{id}":{"get":{"tags":["api-roles"],"summary":"Get the specific Jamf API Role","description":"Get specific Role\n\n> 📋 **Required privilege:** Read API Roles","operationId":"getOneApiRole","parameters":[{"name":"id","in":"path","description":"instance id of API role","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The requested Jamf API Role","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiRole"}}}},"404":{"description":"Role not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read API Roles"]},"put":{"tags":["api-roles"],"summary":"Update API Integrations Role","description":"Update specific Role\n\n> 📋 **Required privilege:** Update API Roles","operationId":"putUpdateApiRole","parameters":[{"name":"id","in":"path","description":"instance id of API role","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"API Integrations Role to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiRoleRequest"}}},"required":true},"responses":{"200":{"description":"Jamf API Integrations Role updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiRole"}}}},"400":{"description":"Bad Request, could not parse input.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Role not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update API Roles"]},"delete":{"tags":["api-roles"],"summary":"Delete API Integrations Role","description":"Delete specific Role\n\n> 📋 **Required privilege:** Delete API Roles","operationId":"deleteApiRole","parameters":[{"name":"id","in":"path","description":"instance id of API role","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Jamf API Integrations Role deleted"},"404":{"description":"Role not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"Role in use by an Integration/Client","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Delete API Roles"]}},"/v1/apns-client-push-status":{"get":{"tags":["apns-client-push-status"],"summary":"Search for clients with push notifications disabled\n","description":"Retrieve a paginated, sortable, and filterable list of MDM clients that have push notifications disabled.\nThe endpoint queries the mdm_client table and returns information about when push was disabled and links to the device records.\n\n\n> 📋 **Required privilege:** View MDM command information in Jamf Pro API","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property(,asc|desc).\nDefault sort order is ascending. Multiple sort criteria are supported.\nSortable fields: pushDisabledTime, deviceType, managementId\n","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["pushDisabledTime:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter results.\nFields allowed in the query: deviceType, disabledAt, managementId.\nThis param can be combined with paging and sorting.\n\nExample: filter=deviceType==\"MOBILE_DEVICE\"\nExample: filter=disabledAt>2024-11-01T00:00:00Z\nExample: filter=deviceType==\"COMPUTER\";disabledAt>2024-01-01T00:00:00Z\n","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Successful operation. Returns a paginated list of clients with push notifications disabled.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApnsClientPushStatusSearchResults"}}}},"400":{"description":"Bad Request - Invalid filter or pagination parameters\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["View MDM command information in Jamf Pro API"]}},"/v1/apns-client-push-status/enable-all-clients":{"post":{"tags":["apns-client-push-status"],"summary":"Enable push notifications for all clients\n","description":"Create a request to enable push notifications for all MDM clients that currently have push disabled.\nThis is an asynchronous operation that processes all disabled clients in the background.\n\n\n> 📋 **Required privilege:** Send MDM command information in Jamf Pro API","responses":{"202":{"description":"Request accepted. Push notifications will be enabled for all clients asynchronously.\n"}},"x-action":true,"x-required-privileges":["Send MDM command information in Jamf Pro API"]}},"/v1/apns-client-push-status/enable-all-clients/status":{"get":{"tags":["apns-client-push-status"],"summary":"Get status of enable all clients request\n","description":"Retrieve the status of the most recent request to enable push notifications for all clients.\nReturns 404 if no recent request exists.\n\n\n> 📋 **Required privilege:** View MDM command information in Jamf Pro API","responses":{"200":{"description":"Successful operation. Returns the status of the recent request.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApnsPushEnableRequest"}}}},"404":{"description":"No recent request found.\n"}},"x-required-privileges":["View MDM command information in Jamf Pro API"]}},"/v1/apns-client-push-status/enable-client":{"post":{"tags":["apns-client-push-status"],"summary":"Enable push notifications for a single client\n","description":"Enable push notifications for a single MDM client that previously had push disabled.\nThis sets the pushEnabled flag to true for the specified client.\nmanagementId field is required in the request body.\n\n\n> 📋 **Required privilege:** Send MDM command information in Jamf Pro API","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnablePushRequest"}}},"required":true},"responses":{"204":{"description":"Push notifications successfully enabled for the client. No content returned.\n"},"400":{"description":"Bad Request - managementId is required or invalid request body\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Client not found - No client exists with the provided management ID\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-action":true,"x-required-privileges":["Send MDM command information in Jamf Pro API"]}},"/v1/app-request/form-input-fields":{"get":{"tags":["app-request-preview"],"summary":"Search for Form Input Fields\n","description":"Search for form input fields\n\n> 📋 **Required privilege:** Read App Request Settings","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppRequestFormInputFieldSearchResults"}}}}},"x-required-privileges":["Read App Request Settings"]},"put":{"tags":["app-request-preview"],"summary":"Replace all Form Input Fields\n","description":"Replace all form input fields. Will delete, update, and create all input fields accordingly.\n\n\n> 📋 **Required privilege:** Update App Request Settings","requestBody":{"description":"list of form input fields to replace all existing fields. Will delete, update, and create all input fields accordingly.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppRequestFormInputField"}}}},"required":true},"responses":{"200":{"description":"form input fields were replaced","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppRequestFormInputField"}}}}},"400":{"description":"Invalid data response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Specified form input field object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update App Request Settings"]},"post":{"tags":["app-request-preview"],"summary":"Create Form Input Field record\n","description":"Create form input field record\n\n\n> 📋 **Required privilege:** Update App Request Settings","requestBody":{"description":"form input field object to create. ids defined in this body will be ignored","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppRequestFormInputField"}}},"required":true},"responses":{"201":{"description":"form input field record was created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppRequestFormInputField"}}}},"400":{"description":"Invalid data response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update App Request Settings"]}},"/v1/app-request/form-input-fields/{id}":{"get":{"tags":["app-request-preview"],"summary":"Get specified Form Input Field object\n","description":"Gets specified form input field object\n\n\n> 📋 **Required privilege:** Read App Request Settings","parameters":[{"name":"id","in":"path","description":"Instance id of form input field record","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Details of form input field were found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppRequestFormInputField"}}}},"404":{"description":"Specified form input field object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read App Request Settings"]},"put":{"tags":["app-request-preview"],"summary":"Update specified Form Input Field object\n","description":"Update specified form input field object\n\n\n> 📋 **Required privilege:** Update App Request Settings","parameters":[{"name":"id","in":"path","description":"Instance id of form input field record","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}}],"requestBody":{"description":"form input field object to create. ids defined in this body will be ignored","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppRequestFormInputField"}}},"required":true},"responses":{"200":{"description":"form input field update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppRequestFormInputField"}}}},"400":{"description":"Invalid data response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Specified form input field object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update App Request Settings"]},"delete":{"tags":["app-request-preview"],"summary":"Remove specified Form Input Field record\n","description":"Removes specified form input field record\n\n\n> 📋 **Required privilege:** Update App Request Settings","parameters":[{"name":"id","in":"path","description":"Instance id of form input field record","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}}],"responses":{"204":{"description":"form input field record was deleted"},"404":{"description":"Specified form input field object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update App Request Settings"]}},"/v1/app-request/settings":{"get":{"tags":["app-request-preview"],"summary":"Get Applicastion Request Settings\n","description":"Get app request settings\n\n\n> 📋 **Required privilege:** Read App Request Settings","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppRequestSettings"}}}}},"x-required-privileges":["Read App Request Settings"]},"put":{"tags":["app-request-preview"],"summary":"Update Application Request Settings\n","description":"Update app request settings\n\n\n> 📋 **Required privilege:** Update App Request Settings","requestBody":{"description":"App request settings object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppRequestSettings"}}},"required":true},"responses":{"200":{"description":"App request settings updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppRequestSettings"}}}},"400":{"description":"Invalid data response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update App Request Settings"]}},"/v1/app-store-country-codes":{"get":{"tags":["app-store-country-codes-preview"],"summary":"Return a list of Countries and the associated Codes\n","description":"Returns a list of countries and the associated codes that can be use for the App Store locale\n","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CountryCodes"}}}}},"x-authentication-required":false}},"/v1/branding-images/download/{id}":{"get":{"tags":["branding"],"summary":"Download a self service branding image\n","description":"Download a self service branding image","parameters":[{"name":"id","in":"path","description":"id of the self service branding image","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"image/*":{"schema":{"type":"string","format":"binary"}}}}},"x-authentication-required":true}},"/v1/buildings":{"get":{"tags":["buildings"],"summary":"Search for sorted and paged Buildings\n","description":"Search for sorted and paged buildings\n\n> 📋 **Required privilege:** Read Buildings","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter buildings collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: name, streetAddress1, streetAddress2, city, stateProvince, zipPostalCode, country. This param can be combined with paging and sorting. Example: filter=city==\"Chicago\" and name==\"*build*\"","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuildingSearchResults"}}}}},"x-required-privileges":["Read Buildings"]},"post":{"tags":["buildings"],"summary":"Create Building record\n","description":"Create building record\n\n\n> 📋 **Required privilege:** Create Buildings","requestBody":{"description":"building object to create. ids defined in this body will be ignored","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Building"}}},"required":true},"responses":{"201":{"description":"Building record was created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}}},"x-required-privileges":["Create Buildings"]}},"/v1/buildings/delete-multiple":{"post":{"tags":["buildings"],"summary":"Delete multiple Buildings by their ids\n","description":"multiple many Buildings by their ids\n\n> 📋 **Required privilege:** Delete Buildings","requestBody":{"description":"ids of the building to be deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ids"}}},"required":true},"responses":{"204":{"description":"All building ids passed in request sucessfully deleted."},"400":{"description":"Request processed.  Returns ids and error codes of any buildings unable to be deleted.  Expected error codes: INVALID_ID - id does not exist SYSTEM_EXCEPTION - a system exception occurred trying to delete the building.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Delete Buildings"],"x-action":true}},"/v1/buildings/export":{"post":{"tags":["buildings"],"summary":"Export Buildings collection\n","description":"Export Buildings collection\n\n\n> 📋 **Required privilege:** Read Buildings","parameters":[{"$ref":"#/components/parameters/export-fields"},{"$ref":"#/components/parameters/export-labels"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is id:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=id:desc,name:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: id, name. This param can be combined with paging and sorting. Example: name==\"*buildings*\"","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"requestBody":{"description":"Optional. Override query parameters since they can make URI exceed 2,000 character limit.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportParameters"}}},"required":false},"responses":{"200":{"description":"Export successful","content":{"text/csv":{"schema":{"format":"binary","example":"id,name\n1,Marketing\n2,Accounting\n"}}}},"400":{"description":"Export fields specified incorrectly - non-existing column or duplicate on the list.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"Export currently unavailable, all export-related resources are in use. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Buildings"],"x-action":true}},"/v1/buildings/{id}":{"get":{"tags":["buildings"],"summary":"Get specified Building object\n","description":"Gets specified Building object\n\n\n> 📋 **Required privilege:** Read Buildings","parameters":[{"name":"id","in":"path","description":"instance id of building record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Details of building were found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Building"}}}},"404":{"description":"Specified building object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Buildings"]},"put":{"tags":["buildings"],"summary":"Update specified Building object\n","description":"Update specified building object\n\n\n> 📋 **Required privilege:** Update Buildings","parameters":[{"name":"id","in":"path","description":"instance id of building record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"building object to update. ids defined in this body will be ignored","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Building"}}},"required":true},"responses":{"200":{"description":"Building update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Building"}}}}},"x-required-privileges":["Update Buildings"]},"delete":{"tags":["buildings"],"summary":"Remove specified Building record\n","description":"Removes specified building record\n\n\n> 📋 **Required privilege:** Delete Buildings","parameters":[{"name":"id","in":"path","description":"instance id of building record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Building record was deleted"}},"x-required-privileges":["Delete Buildings"]}},"/v1/buildings/{id}/history":{"get":{"tags":["buildings"],"summary":"Get specified Building History object\n","description":"Gets specified Building history object\n\n\n> 📋 **Required privilege:** Read Buildings","parameters":[{"name":"id","in":"path","description":"instance id of building history record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["date:desc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Details of building history were found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistorySearchResults"}}}},"404":{"description":"Specified building object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Buildings"]},"post":{"tags":["buildings"],"summary":"Add specified Building history object notes\n","description":"Adds specified Building history object notes\n\n\n> 📋 **Required privilege:** Update Buildings","parameters":[{"name":"id","in":"path","description":"instance id of building history record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"history notes to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistoryNote"}}},"required":true},"responses":{"201":{"description":"Notes of building history were added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistory"}}}},"404":{"description":"Specified building object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"Building history can not be saved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Buildings"]}},"/v1/buildings/{id}/history/export":{"post":{"tags":["buildings"],"summary":"Export history object collection in specified format for specified Buildings\n","description":"Export history object collection in specified format for specified Buildings\n\n\n> 📋 **Required privilege:** Read Buildings","parameters":[{"$ref":"#/components/parameters/export-fields"},{"$ref":"#/components/parameters/export-labels"},{"name":"id","in":"path","description":"instance id of buildings","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["date:desc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"requestBody":{"description":"Optional. Override query parameters since they can make URI exceed 2,000 character limit.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportParameters"}}},"required":false},"responses":{"200":{"description":"Export successful","content":{"text/csv":{"schema":{"format":"binary","example":"id,username,date,note,details\n1,admin,2019-02-04 21:09:31,Buildings update,Some details\n"}}}},"400":{"description":"Export fields specified incorrectly - non-existing column or duplicate on the list.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"Export currently unavailable, all export-related resources are in use. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Buildings"],"x-action":true}},"/v1/cache-settings":{"get":{"tags":["cache-settings"],"summary":"Get Cache Settings\n","description":"gets cache settings\n\n> 📋 **Required privilege:** Read Cache","responses":{"200":{"description":"cache settings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CacheSettings"}}}}},"x-required-privileges":["Read Cache"]},"put":{"tags":["cache-settings"],"summary":"Update Cache Settings\n","description":"updates cache settings\n\n\n> 📋 **Required privilege:** Update Cache","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CacheSettings"}}},"required":true},"responses":{"200":{"description":"cache has been updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CacheSettings"}}}},"403":{"description":"The following code is returned by this call:\nHOSTED_ENVIRONMENT - PUT command is not available in hosted environments.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Cache"]}},"/v1/categories":{"get":{"tags":["categories"],"summary":"Get Category objects\n","description":"Gets `Category` objects.\n\n\n> 📋 **Required privileges:**\n> - Read Categories\n> - Read Self Service","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter categories collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: name, priority. This param can be combined with paging and sorting. Example: filter=name==\"Apps*\" and priority>=5","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoriesSearchResults"}}}}},"x-required-privileges":["Read Categories","Read Self Service"]},"post":{"tags":["categories"],"summary":"Create Category record\n","description":"Create category record\n\n\n> 📋 **Required privilege:** Create Categories","requestBody":{"description":"category object to create. IDs defined in this body will be ignored","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Category"}}},"required":true},"responses":{"201":{"description":"Category record was created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}}},"x-required-privileges":["Create Categories"]}},"/v1/categories/delete-multiple":{"post":{"tags":["categories"],"summary":"Delete multiple Categories by their IDs\n","description":"Delete multiple Categories by their IDs\n\n> 📋 **Required privilege:** Delete Categories","requestBody":{"description":"IDs of the categories to be deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ids"}}},"required":true},"responses":{"204":{"description":"All Category IDs passed in request sucessfully deleted."},"400":{"description":"Request processed.  Returns IDs and error codes of any categories unable to be deleted.  Expected error codes: INVALID_ID - id does not exist SYSTEM_EXCEPTION - a system exception occurred trying to delete the category.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Delete Categories"],"x-action":true}},"/v1/categories/{id}":{"get":{"tags":["categories"],"summary":"Get specified Category object\n","description":"Gets specified Category object\n\n\n> 📋 **Required privilege:** Read Categories","parameters":[{"name":"id","in":"path","description":"instance id of category record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Details of category were found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Category"}}}},"404":{"description":"Specified category object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Categories"]},"put":{"tags":["categories"],"summary":"Update specified Category object\n","description":"Update specified category object\n\n\n> 📋 **Required privilege:** Update Categories","parameters":[{"name":"id","in":"path","description":"instance id of category record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"category object to create. id defined in this body will be ignored","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Category"}}},"required":true},"responses":{"200":{"description":"Category record was updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Category"}}}}},"x-required-privileges":["Update Categories"]},"delete":{"tags":["categories"],"summary":"Remove specified Category record\n","description":"Removes specified category record\n\n\n> 📋 **Required privilege:** Delete Categories","parameters":[{"name":"id","in":"path","description":"instance id of category record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Category record was deleted"}},"x-required-privileges":["Delete Categories"]}},"/v1/categories/{id}/history":{"get":{"tags":["categories"],"summary":"Get specified Category history object\n","description":"Gets specified Category history object\n\n\n> 📋 **Required privilege:** Read Categories","parameters":[{"name":"id","in":"path","description":"instance id of category history record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["date:desc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Details of category history were found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistorySearchResults"}}}},"404":{"description":"Specified category object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Categories"]},"post":{"tags":["categories"],"summary":"Add specified Category history object notes\n","description":"Adds specified Category history object notes\n\n\n> 📋 **Required privilege:** Update Categories","parameters":[{"name":"id","in":"path","description":"instance id of category history record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"history notes to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistoryNote"}}},"required":true},"responses":{"201":{"description":"Notes of category history were added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistory"}}}},"404":{"description":"Specified category object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"Category history can not be saved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Categories"]}},"/v1/pki/certificate-authority/active":{"get":{"tags":["certificate-authority"],"summary":"Returns X.509 details of the active Certificate Authority (CA)","description":"Returns X.509 details of the active Certificate Authority (CA)","responses":{"200":{"description":"Successful response displays the details of the active Certificate Authority (CA)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateRecord"}}}}},"x-authentication-required":false}},"/v1/pki/certificate-authority/active/der":{"get":{"tags":["certificate-authority"],"summary":"Returns X.509 of active Certificate Authority (CA) in DER format","description":"Returns X.509 of active Certificate Authority (CA) in DER format","responses":{"200":{"description":"Successful response returns certificate in DER format","content":{"application/pkix-cert":{"schema":{"type":"string","format":"binary"}}}}},"x-authentication-required":false}},"/v1/pki/certificate-authority/active/pem":{"get":{"tags":["certificate-authority"],"summary":"Returns active Certificate Authority (CA) in PEM format","description":"Returns active Certificate Authority (CA) in PEM format","responses":{"200":{"description":"Successful response returns certificate in PEM format.","content":{"application/pem-certificate-chain":{"schema":{"type":"string","format":"binary"}}}}},"x-authentication-required":false}},"/v1/pki/certificate-authority/{id}":{"get":{"tags":["certificate-authority"],"summary":"Returns X.509 details of Certificate Authority (CA) with provided ID","description":"Returns X.509 details of Certificate Authority (CA) with provided ID\n\n> 📋 **Required privilege:** Read PKI","parameters":[{"name":"id","in":"path","description":"UUID of the Certificate Authority (CA)","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response displays the details of the Certificate Authority (CA) with provided ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateRecord"}}}},"400":{"description":"Invalid ID parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Certificate with that ID does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read PKI"]}},"/v1/pki/certificate-authority/{id}/der":{"get":{"tags":["certificate-authority"],"summary":"Returns X.509 current Certificate Authority (CA) with provided ID in DER format","description":"Returns X.509 current Certificate Authority (CA) with provided ID in DER format\n\n> 📋 **Required privilege:** Read PKI","parameters":[{"name":"id","in":"path","description":"UUID of the Certificate Authority (CA)","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response returns certificate in DER format","content":{"application/pkix-cert":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Invalid ID parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Certificate with that ID does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read PKI"]}},"/v1/pki/certificate-authority/{id}/pem":{"get":{"tags":["certificate-authority"],"summary":"Returns current Certificate Authority (CA) with provided ID in PEM format","description":"Returns current Certificate Authority (CA) with provided ID in PEM format\n\n> 📋 **Required privilege:** Read PKI","parameters":[{"name":"id","in":"path","description":"UUID of the Certificate Authority (CA)","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response returns certificate in PEM format","content":{"application/pem-certificate-chain":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Invalid ID parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Certificate with that ID does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read PKI"]}},"/v1/classic-ldap/{id}":{"get":{"tags":["classic-ldap"],"summary":"Get mappings for OnPrem Ldap configuration with given id.","description":"Get mappings for OnPrem Ldap configuration with given id.\n\n> 📋 **Required privilege:** Read LDAP Servers","parameters":[{"name":"id","in":"path","description":"OnPrem Ldap identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OnPrem Ldap mappings returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClassicLdapMappings"}}}},"400":{"description":"Id can only be a number.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Specified OnPrem Ldap configuration does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read LDAP Servers"]}},"/v3/check-in":{"get":{"tags":["client-check-in"],"summary":"Get Client Check-In settings\n","description":"Gets `Client Check-In` object.\n\n\n> 📋 **Required privilege:** Read Computer Check-In","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientCheckInV3"}}}}},"x-required-privileges":["Read Computer Check-In"]},"put":{"tags":["client-check-in"],"summary":"Update Client Check-In object\n","description":"Update Client Check-In object\n\n\n> 📋 **Required privilege:** Update Computer Check-In","requestBody":{"description":"Client Check-In object to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientCheckInV3"}}},"required":true},"responses":{"200":{"description":"Client Check-In was updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientCheckInV3"}}}}},"x-required-privileges":["Update Computer Check-In"]}},"/v3/check-in/history":{"get":{"tags":["client-check-in"],"summary":"Get Client Check-In history object\n","description":"Gets Client Check-In history object\n\n\n> 📋 **Required privilege:** Read Computer Check-In","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is name:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,username:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","example":["date:desc"],"items":{"type":"string"},"default":["date:desc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Details of Client Check-In history were found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistorySearchResultsV1"}}}}},"x-required-privileges":["Read Computer Check-In"]},"post":{"tags":["client-check-in"],"summary":"Add a Note to Client Check-In History\n","description":"Adds Client Check-In history object notes\n\n\n> 📋 **Required privilege:** Update Computer Check-In","requestBody":{"description":"history notes to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistoryNote"}}},"required":true},"responses":{"201":{"description":"Notes of Client Check-In history were added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"503":{"description":"Client Check-In history can not be saved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Computer Check-In"]}},"/v1/cloud-azure":{"post":{"tags":["cloud-azure"],"summary":"Create Azure Cloud Identity Provider configuration","description":"Create new Azure Cloud Identity Provider configuration with unique display name.\n\n> 📋 **Required privilege:** Create LDAP Servers","requestBody":{"description":"Azure Cloud Identity Provider configuration to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AzureConfigurationRequest"}}},"required":true},"responses":{"201":{"description":"Azure Cloud Identity Provider configuration created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"400":{"description":"Azure Cloud Identity Provider configuration cannot be saved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"This endpoint is not available for your environment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Create LDAP Servers"]}},"/v1/cloud-azure/defaults/mappings":{"get":{"tags":["cloud-azure"],"summary":"Get default mappings","description":"This is the default set of attributes that allows you to return the data you need from Azure AD. Some fields may be empty and may be edited when creating a new configuration.\n\n> 📋 **Required privilege:** Read LDAP Servers","responses":{"200":{"description":"Default mappings returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AzureMappings"}}}},"400":{"description":"Files cannot be loaded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"This endpoint is not available for your environment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2025-05-21","x-required-privileges":["Read LDAP Servers"]}},"/v1/cloud-azure/defaults/server-configuration":{"get":{"tags":["cloud-azure"],"summary":"Get default server configuration","description":"This is the default set of attributes that allows you to return the data you need from Azure AD. Some fields may be empty and may be edited when creating a new configuration.\n\n> 📋 **Required privilege:** Read LDAP Servers","responses":{"200":{"description":"Default server configuration returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AzureServerConfiguration"}}}},"400":{"description":"Default server configuration cannot be loaded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"This endpoint is not available for your environment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read LDAP Servers"]}},"/v1/cloud-azure/{id}":{"get":{"tags":["cloud-azure"],"summary":"Get Azure Cloud Identity Provider configuration with given ID.","description":"Get Azure Cloud Identity Provider configuration with given ID.\n\n> 📋 **Required privilege:** Read LDAP Servers","parameters":[{"name":"id","in":"path","description":"Cloud Identity Provider identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Cloud Identity Provider configuration returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AzureConfiguration"}}}},"400":{"description":"ID can only be a number.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"This endpoint is not available for your environment if CLOUD_ONLY reason code or specified Azure Cloud Identity Provider configuration does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read LDAP Servers"]},"put":{"tags":["cloud-azure"],"summary":"Update Azure Cloud Identity Provider configuration","description":"Update Azure Cloud Identity Provider configuration. Cannot be used for partial updates, all content body must be sent.\n\n> 📋 **Required privilege:** Update LDAP Servers","parameters":[{"name":"id","in":"path","description":"Cloud Identity Provider identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Azure Cloud Identity Provider configuration to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AzureConfigurationUpdate"}}},"required":true},"responses":{"200":{"description":"Cloud Identity Provider configuration updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AzureConfiguration"}}}},"400":{"description":"One or more parameters were invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"This endpoint is not available for your environment if CLOUD_ONLY reason code or Cloud Identity Provider configuration does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"The request URL configuration id value does not match the id value in the request body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update LDAP Servers"]},"delete":{"tags":["cloud-azure"],"summary":"Delete Cloud Identity Provider configuration.","description":"Delete Cloud Identity Provider configuration.\n\n> 📋 **Required privilege:** Delete LDAP Servers","parameters":[{"name":"id","in":"path","description":"Cloud Identity Provider identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Cloud Identity Provider configuration deleted."},"400":{"description":"ID can only be a number.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"This endpoint is not available for your environment if CLOUD_ONLY reason code or Cloud Identity Provider configuration does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Delete LDAP Servers"]}},"/v1/cloud-distribution-point":{"get":{"tags":["cloud-distribution-point"],"summary":"Get the cloud distribution point Details.\n","description":"Retrieves the details of the cloud distribution point. The distribution point exists only when a content delivery network (CDN) is configured, such as Jamf Cloud(JAMF_CLOUD), Rackspace Cloud Files(RACKSPACE_CLOUD_FILES), Amazon Web Services(AMAZON_S3) or Akamai(AKAMAI). If the **cdnType** is **NONE** the response will be NONE empty CDP object, indicating no distribution point is set up.\n\n\n> 📋 **Required privilege:** Read Cloud Distribution Point","responses":{"200":{"description":"The request was successful, and the details of the cloud distribution point (CDP) have been retrieved. The response contains the current configuration of the CDP, including the CDN service being used (e.g., Jamf Cloud(JAMF_CLOUD), Rackspace Cloud Files(RACKSPACE_CLOUD_FILES), Amazon Web Services(AMAZON_S3), Akamai(AKAMAI)), the CDN URL, and the status of the test connection.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudDistributionPoint"}}}},"404":{"description":"cloud distribution point object could not be found. The server either did not find a current representation for the requested resource or is trying to hide its existence from an unauthorized client.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Cloud Distribution Point"]},"post":{"tags":["cloud-distribution-point"],"summary":"Create cloud distribution point","description":"Creates cloud distribution point. This operation is triggered when the content delivery network (CDN) settings change, specifically when the network type is updated from \"None\" to any other supported type. Upon successful creation,the API returns the updated details of the cloud distribution point.\n\n> 📋 **Required privilege:** Update Cloud Distribution Point","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudDistributionPoint"}}},"required":true},"responses":{"201":{"description":"The cloud distribution point was successfully created. After creation, a connection test was performed to ensure that the distribution point is properly configured and accessible. If the connection test passes, files will be uploaded to the distribution point. The response returns the details of the newly created cloud distribution point, including:\n    - The unique identifier assigned to the cloud distribution point, along with the configured data.\n    - The CDN type and URL where content will be distributed.\n    - The connection test result (success or failure).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudDistributionPoint"}}}},"400":{"description":"Bad Request. The server could not understand the request because of invalid syntax. Possible reasons are:</br> 1) Required fields are not provided in request body.</br> 2) Fields which are not associated with provided cdnType has some value.</br> 3) Any values outside of the allowed range are included in the request body.</br>","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Cloud Distribution Point"]},"delete":{"tags":["cloud-distribution-point"],"summary":"Delete cloud distribution point.","description":"The cloud distribution point and inventory details to be deleted.\n\n> 📋 **Required privilege:** Update Cloud Distribution Point","responses":{"204":{"description":"cloud distribution point deleted successfully."},"404":{"description":"No cloud distribution point has been configured."},"409":{"description":"The request could not be completed due to a conflict caused by multiple records existing in the system."},"500":{"description":"An unexpected error occurred while attempting to delete the cloud distribution point. This could be due to a server issue, database error, or failure to perform the necessary cleanup actions."}},"x-required-privileges":["Update Cloud Distribution Point"]},"patch":{"tags":["cloud-distribution-point"],"summary":"Update specific fields on a cloud distribution point","description":"Update specific fields on a cloud distribution point, then return the updated cloud distribution point details object.\n\n> 📋 **Required privilege:** Update Cloud Distribution Point","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudDistributionPoint"}}},"required":true},"responses":{"200":{"description":"The cloud distribution point was successfully updated. After the update, a connection test was performed to verify the configuration, and files were successfully uploaded to the distribution point.\nThe response body will return the most up-to-date information about the cloud distribution point, including:\n    - Updated configuration fields.\n    - Connection test status (success or failure).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudDistributionPoint"}}}},"400":{"description":"Bad Request. The server could not understand the request because of invalid syntax. Possible reasons are:</br> 1) Required fields are not provided in request body.</br> 2) Fields which are not associated with provided cdnType has some value.</br> 3) Any values outside of the allowed range are included in the request body.</br>","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Cloud Distribution Point"]}},"/v1/cloud-distribution-point/fail-upload/{id}":{"post":{"tags":["cloud-distribution-point"],"summary":"Marks a specific file upload as failed for the currently configured cloud distribution point.\n","description":"Marks a specific file upload as failed for the currently configured cloud distribution point.\n\n\n> 📋 **Required privilege:** Update Cloud Distribution Point","parameters":[{"name":"id","in":"path","description":"The identifier of the inventory file to be marked as failed. The type and ID will make a unique identifier for the file.","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"1"}},{"name":"file-name","in":"query","description":"Name of the file to mark failure for.","required":true,"style":"form","explode":true,"schema":{"maxLength":255,"type":"string","example":"filename.pkg","default":""}},{"name":"type","in":"query","description":"Type of file to mark failure for. Possible values are PACKAGE, EBOOK, MOBILE_DEVICE_APP.","required":true,"style":"form","explode":true,"schema":{"maxLength":50,"type":"string","example":"PACKAGE","default":""}}],"responses":{"204":{"description":"Successfully marked the specified file upload as failed for the currently configured cloud distribution point.\n"},"404":{"description":"The specified inventory file could not be found. The server either did not find a current representation for the requested resource or is trying to hide its existence from an unauthorized client.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-action":true,"x-required-privileges":["Update Cloud Distribution Point"]}},"/v1/cloud-distribution-point/files":{"get":{"tags":["cloud-distribution-point"],"summary":"Get the cloud distribution point Inventory files details","description":"Retrieves the details of the inventory files associated with a cloud distribution point.This includes information about the files used for content distribution,\nsuch as their type, status, and categorization.The response provides a comprehensive list of inventory files, which may include packages, ebooks, or mobile device apps,\nallowing users to view the current state and metadata for each file in the distribution system.\n\n\n> 📋 **Required privilege:** Read Cloud Distribution Point","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorts results by one or more criteria, following the format property:asc/desc.<br/> Default sort is id:asc.<br/> If using multiple criteria, separate with commas. Allows sort for id, fileName, inventoryId and type etc.","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id.asc"]}},{"name":"filter","in":"query","description":"Filters results. Use RSQL format for query. Allows for many fields, including fileName and type<br/> Can be combined with paging and sorting.<br/> Fields allowed in the query: fileName, inventoryId and type <br/> Default filter is an empty query and returns all results from the requested page.","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"cloud distribution point Inventory objects has been fetched successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudDistributionPointInventoryFilesResults"}}}},"404":{"description":"cloud distribution point Inventory objects could not be found. The server either did not find a current representation for the requested resource or is trying to hide its existence from an unauthorized client.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Cloud Distribution Point"]}},"/v1/cloud-distribution-point/history":{"get":{"tags":["cloud-distribution-point"],"summary":"Get cloud distribution point history details","description":"Get cloud distribution point history details\n\n> 📋 **Required privilege:** Read Cloud Distribution Point","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorts results by one or more criteria, following the format property:asc/desc. Default sort is ID:asc. If using multiple criteria, separate with commas.","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}},{"name":"filter","in":"query","description":"Filters results. Use RSQL format for query. Allows for many fields, including ID, name, etc. Can be combined with paging and sorting. Default filter is an empty query and returns all results from the requested page.","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Details of cloud distribution point history were found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistorySearchResults"}}}},"400":{"description":"Bad Request. Specified cloud distribution point history object could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Cloud Distribution Point"]},"post":{"tags":["cloud-distribution-point"],"summary":"Add specified cloud distribution point history object notes","description":"Add specified cloud distribution point history object notes\n\n> 📋 **Required privilege:** Update Cloud Distribution Point","requestBody":{"description":"History note to be created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistoryNote"}}},"required":true},"responses":{"201":{"description":"cloud distribution point history note created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistory"}}}},"400":{"description":"Bad Request. Error creating history note.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Cloud Distribution Point"]}},"/v1/cloud-distribution-point/refresh-inventory":{"post":{"tags":["cloud-distribution-point"],"summary":"Updates inventory data for the currently configured cloud distribution point.\n","description":"Updates inventory data for the currently configured cloud distribution point.\n\n\n> 📋 **Required privilege:** Read Cloud Distribution Point","parameters":[{"name":"file-name","in":"query","description":"Name of the file to check the availability of. If available, the inventory and status will be updated in Jamf Pro. If no file is specified, it will force an immediate inventory refresh at a rate-limit of once every 15 seconds.","required":false,"style":"form","explode":true,"schema":{"maxLength":255,"type":"string","example":"filename.pkg","default":""}}],"responses":{"204":{"description":"Successfully updated inventory data for the currently configured cloud distribution point.\n"}},"x-action":true,"x-required-privileges":["Read Cloud Distribution Point"]}},"/v1/cloud-distribution-point/test-connection":{"get":{"tags":["cloud-distribution-point"],"summary":"Get the cloud distribution point test connection details.\n","description":"Verifies the connection to the cloud distribution point after updating its configuration. \nThis endpoint returns the connection status and a message indicating whether the connection is successful or failed.\n\n\n> 📋 **Required privilege:** Read Cloud Distribution Point","responses":{"200":{"description":"This response indicates the test connection of the cloud distribution point (CDP). \nThe response includes the following details:\n   - **hasConnectionSucceeded**: A status indicating whether the connection test was successful or failed. \n        This will be either `true` or `false`, based on the outcome of the connection test.\n   - **message**: A detailed message providing additional context regarding the test result. \n        For example, if the connection failed, the message might contain an error description.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudDistributionPointTestConnection"}}}}},"x-required-privileges":["Read Cloud Distribution Point"],"x-authentication-required":true}},"/v1/cloud-distribution-point/upload-capability":{"get":{"tags":["cloud-distribution-point"],"summary":"Finds specific information for the currently configured cloud distribution point.\n","description":"Finds a variety of values based on the currently configured cloud distribution point.\n","responses":{"200":{"description":"The request was successful, and the upload capability details for the currently configured cloud distribution point (CDP) have been retrieved. \nThis response provides information about whether the cloud distribution point supports direct uploads and the principal distribution technology being used.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudDistributionPointUploadCapability"}}}}},"x-authentication-required":true}},"/v1/cloud-idp":{"get":{"tags":["cloud-idp"],"summary":"Get information about all Cloud Identity Providers configurations.","description":"Returns basic informations about all configured Cloud Identity Provider.\n\n> 📋 **Required privilege:** Read LDAP Servers","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:desc"]}}],"responses":{"200":{"description":"Cloud Identity Provider configurations informations returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigurationSearchResults"}}}}},"x-required-privileges":["Read LDAP Servers"]}},"/v1/cloud-idp/export":{"post":{"tags":["cloud-idp"],"summary":"Export Cloud Identity Providers collection\n","description":"Export Cloud Identity Providers collection\n\n\n> 📋 **Required privilege:** Read LDAP Servers","parameters":[{"$ref":"#/components/parameters/export-fields"},{"$ref":"#/components/parameters/export-labels"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is id:desc. Multiple sort criteria are supported and must be seperated with a comma. Example: sort=id:desc,name:asc","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: id, name. This param can be combined with paging and sorting. Example: name==\"*department*\"","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"requestBody":{"description":"Optional. Override query parameters since they can make URI exceed 2,000 character limit.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportParameters"}}},"required":false},"responses":{"200":{"description":"Export successful","content":{"text/csv":{"schema":{"format":"binary","example":"Name,\"Provider Name\",Status\n\"Google LDAP\",GOOGLE,true\n\"Azure LDAP\",AZURE,true\n"}}}},"400":{"description":"Export fields specified incorrectly - non-existing column or duplicate on the list.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"Export currently unavailable, all export-related resources are in use. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read LDAP Servers"],"x-action":true}},"/v1/cloud-idp/{id}":{"get":{"tags":["cloud-idp"],"summary":"Get Cloud Identity Provider configuration with given ID.","description":"Get Cloud Identity Provider configuration with given ID.\n\n> 📋 **Required privilege:** Read LDAP Servers","parameters":[{"name":"id","in":"path","description":"Cloud Identity Provider identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Cloud Identity Provider configuration returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudIdPCommon"}}}},"400":{"description":"ID can only be a number.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Specified Cloud Identity Provider configuration does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read LDAP Servers"]}},"/v1/cloud-idp/{id}/history":{"get":{"tags":["cloud-idp"],"summary":"Get Cloud Identity Provider history","description":"Gets specified Cloud Identity Provider object history\n\n> 📋 **Required privilege:** Read LDAP Servers","parameters":[{"name":"id","in":"path","description":"Cloud Identity Provider identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["date:desc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Details of Cloud Identity Provider history were found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistorySearchResults"}}}},"400":{"description":"Id can only be a number.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Specified Cloud Identity Provider object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read LDAP Servers"]},"post":{"tags":["cloud-idp"],"summary":"Add Cloud Identity Provider history note","description":"Adds specified Cloud Identity Provider object history notes\n\n\n> 📋 **Required privilege:** Update LDAP Servers","parameters":[{"name":"id","in":"path","description":"Cloud Identity Provider identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"history notes to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistoryNote"}}},"required":true},"responses":{"201":{"description":"Notes of Cloud Identity Provider history were added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistory"}}}},"404":{"description":"Specified Cloud Identity Provider object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"Notes of Cloud Identity Provider can not be saved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update LDAP Servers"]}},"/v1/cloud-idp/{id}/test-group":{"post":{"tags":["cloud-idp"],"summary":"Get group test search","description":"Do test search to ensure about configuration and mappings\n\n> 📋 **Required privilege:** Read LDAP Servers","parameters":[{"name":"id","in":"path","description":"Cloud Identity Provider identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Search request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupTestSearchRequest"}}},"required":true},"responses":{"200":{"description":"Cloud Identity Provider test search result returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupTestSearchResponse"}}}},"404":{"description":"Cloud Identity Provider does not exist or is not active.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-action":true,"x-required-privileges":["Read LDAP Servers"]}},"/v1/cloud-idp/{id}/test-user":{"post":{"tags":["cloud-idp"],"summary":"Get user test search","description":"Do test search to ensure about configuration and mappings\n\n> 📋 **Required privilege:** Read LDAP Servers","parameters":[{"name":"id","in":"path","description":"Cloud Identity Provider identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Search request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserTestSearchRequest"}}},"required":true},"responses":{"200":{"description":"Cloud Identity Provider test search result returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserTestSearchResponse"}}}},"404":{"description":"Cloud Identity Provider does not exist or is not active.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-action":true,"x-required-privileges":["Read LDAP Servers"]}},"/v1/cloud-idp/{id}/test-user-membership":{"post":{"tags":["cloud-idp"],"summary":"Get membership test search","description":"Do test search to ensure about configuration and mappings\n\n> 📋 **Required privilege:** Read LDAP Servers","parameters":[{"name":"id","in":"path","description":"Cloud Identity Provider identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Search request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MembershipTestSearchRequest"}}},"required":true},"responses":{"200":{"description":"Cloud Identity Provider test search result returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MembershipTestSearchResponse"}}}},"404":{"description":"Cloud Identity Provider does not exist or is not active.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"The membership lookup could not be completed (directory service unavailable or errored).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-action":true,"x-required-privileges":["Read LDAP Servers"]}},"/v1/cloud-information":{"get":{"tags":["cloud-information"],"summary":"Retrieve information related to cloud setup.\n","description":"Retrieve information related to cloud setup.\nRetrieves information related to cloud setup. Provides details about cloud instance configuration.\n","responses":{"200":{"description":"Result of verification for being cloud-based instance","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudResponse"}}}}},"x-authentication-required":false}},"/v1/ldap-keystore/verify":{"post":{"tags":["cloud-ldap"],"summary":"Validate keystore for Cloud Identity Provider secure connection","description":"Validate keystore for Cloud Identity Provider secure connection\n\n> 📋 **Required privilege:** Create LDAP Servers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudLdapKeystoreFile"}}},"required":true},"responses":{"200":{"description":"Keystore verified.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudLdapKeystore"}}}},"400":{"description":"One or more invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-action":true,"x-required-privileges":["Create LDAP Servers"]}},"/v2/cloud-ldaps":{"post":{"tags":["cloud-ldap"],"summary":"Create Cloud Identity Provider configuration","description":"Create new Cloud Identity Provider configuration with unique display name. If mappings not provided, then defaults will be generated instead.\n\n> 📋 **Required privilege:** Create LDAP Servers","requestBody":{"description":"Cloud Identity Provider configuration to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LdapConfigurationRequest"}}},"required":true},"responses":{"201":{"description":"Cloud Identity Provider configuration created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"400":{"description":"Cloud Identity Provider configuration cannot be saved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Create LDAP Servers"]}},"/v2/cloud-ldaps/defaults/{provider}/mappings":{"get":{"tags":["cloud-ldap"],"summary":"Get default mappings","description":"Get default mappings for Cloud Identity Provider Provider.\n\n> 📋 **Required privilege:** Read LDAP Servers","parameters":[{"name":"provider","in":"path","description":"Cloud Identity Provider name","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"google"}],"responses":{"200":{"description":"Default mappings returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudLdapMappingsResponse"}}}},"400":{"description":"Files cannot be loaded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"The provider name in the URL is invalid or not supported.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read LDAP Servers"]}},"/v2/cloud-ldaps/defaults/{provider}/server-configuration":{"get":{"tags":["cloud-ldap"],"summary":"Get default server configuration","description":"Get default server configuration for Cloud Identity Provider Identity Provider.\n\n> 📋 **Required privilege:** Read LDAP Servers","parameters":[{"name":"provider","in":"path","description":"Cloud Identity Provider name","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"google"}],"responses":{"200":{"description":"Default server configuration returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudLdapServerResponse"}}}},"400":{"description":"Default server configuration cannot be loaded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"The provider name in the URL is invalid or not supported.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read LDAP Servers"]}},"/v2/cloud-ldaps/{id}":{"get":{"tags":["cloud-ldap"],"summary":"Get Cloud Identity Provider configuration with given id.","description":"Get Cloud Identity Provider configuration with given id.\n\n> 📋 **Required privilege:** Read LDAP Servers","parameters":[{"name":"id","in":"path","description":"Cloud Identity Provider identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Cloud Identity Provider configuration returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LdapConfigurationResponse"}}}},"400":{"description":"Id can only be a number.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Specified Cloud Identity Provider configuration does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read LDAP Servers"]},"put":{"tags":["cloud-ldap"],"summary":"Update Cloud Identity Provider configuration","description":"Update Cloud Identity Provider configuration. Cannot be used for partial updates, all content body must be sent.\n\n> 📋 **Required privilege:** Update LDAP Servers","parameters":[{"name":"id","in":"path","description":"Cloud Identity Provider identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Cloud Identity Provider configuration to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LdapConfigurationUpdate"}}},"required":true},"responses":{"200":{"description":"Cloud Identity Provider configuration updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LdapConfigurationResponse"}}}},"400":{"description":"One or more parameters were invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Cloud Identity Provider configuration does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"The request URL configuration id value does not match the id value in the request body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update LDAP Servers"]},"delete":{"tags":["cloud-ldap"],"summary":"Delete Cloud Identity Provider configuration.","description":"Delete Cloud Identity Provider configuration.\n\n> 📋 **Required privilege:** Delete LDAP Servers","parameters":[{"name":"id","in":"path","description":"Cloud Identity Provider identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Cloud Identity Provider configuration deleted."},"400":{"description":"Id can only be a number.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Cloud Identity Provider configuration does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Delete LDAP Servers"]}},"/v2/cloud-ldaps/{id}/connection/bind":{"get":{"tags":["cloud-ldap"],"summary":"Get bind connection pool statistics","description":"Get all search connection pool for chosen Cloud Identity Provider.\nnumConnectionsClosedDefunct - The number of connections that have been closed as defunct.\nnumConnectionsClosedExpired - The number of connections that have been closed because they were expired.\nnumConnectionsClosedUnneeded - The number of connections that have been closed because they were no longer needed.\nnumFailedCheckouts - The number of failed attempts to check out a connection from the pool.\nnumFailedConnectionAttempts - The number of failed attempts to create a connection for use in the pool.\nnumReleasedValid - The number of valid connections released back to the pool.\nnumSuccessfulCheckouts - The number of successful attempts to check out a connection from the pool.\nnumSuccessfulCheckoutsNewConnection - The number of successful checkout attempts that had to create a new connection because none were available.\nnumSuccessfulConnectionAttempts - The number successful attempts to create a connection for use in the pool.\nmaximumAvailableConnections - The maximum number of connections that may be available in the pool at any time.\nnumSuccessfulCheckoutsWithoutWait - The number of successful checkout attempts that were able to take an existing connection without waiting.\nnumSuccessfulCheckoutsAfterWait - The number of successful checkout attempts that retrieved a connection from the pool after waiting for it to become available.\nnumAvailableConnections - The number of connections currently available for use in the pool.\n\n\n> 📋 **Required privilege:** Read LDAP Servers","parameters":[{"name":"id","in":"path","description":"Cloud Identity Provider identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Cloud Identity Provider bind connection pool statistics returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudLdapConnectionPoolStatistics"}}}},"400":{"description":"Bind connection pool statistics data is not available.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Cloud Identity Provider bind connection pool statistics does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read LDAP Servers"]}},"/v2/cloud-ldaps/{id}/connection/search":{"get":{"tags":["cloud-ldap"],"summary":"Get search connection pool statistics","description":"Get all search connection pool for chosen Cloud Identity Provider.\nnumConnectionsClosedDefunct - The number of connections that have been closed as defunct.\nnumConnectionsClosedExpired - The number of connections that have been closed because they were expired.\nnumConnectionsClosedUnneeded - The number of connections that have been closed because they were no longer needed.\nnumFailedCheckouts - The number of failed attempts to check out a connection from the pool.\nnumFailedConnectionAttempts - The number of failed attempts to create a connection for use in the pool.\nnumReleasedValid - The number of valid connections released back to the pool.\nnumSuccessfulCheckouts - The number of successful attempts to check out a connection from the pool.\nnumSuccessfulCheckoutsNewConnection - The number of successful checkout attempts that had to create a new connection because none were available.\nnumSuccessfulConnectionAttempts - The number successful attempts to create a connection for use in the pool.\nmaximumAvailableConnections - The maximum number of connections that may be available in the pool at any time.\nnumSuccessfulCheckoutsWithoutWait - The number of successful checkout attempts that were able to take an existing connection without waiting.\nnumSuccessfulCheckoutsAfterWait - The number of successful checkout attempts that retrieved a connection from the pool after waiting for it to become available.\nnumAvailableConnections - The number of connections currently available for use in the pool.\n\n\n> 📋 **Required privilege:** Read LDAP Servers","parameters":[{"name":"id","in":"path","description":"Cloud Identity Provider identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Cloud Identity Provider search connection pool statistics returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudLdapConnectionPoolStatistics"}}}},"400":{"description":"Search connection pool statistics data is not available.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Cloud Identity Provider search connection pool statistics does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read LDAP Servers"]}},"/v2/cloud-ldaps/{id}/connection/status":{"get":{"tags":["cloud-ldap"],"summary":"Tests the communication with the specified cloud connection\n","description":"Tests the communication with the specified cloud connection\n\n\n> 📋 **Required privilege:** Read LDAP Servers","parameters":[{"name":"id","in":"path","description":"Cloud Identity Provider identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully connected to the specified cloud connection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudLdapConnectionStatus"}}}},"400":{"description":"One or more parameters were invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Cloud Identity Provider does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read LDAP Servers"]}},"/v2/cloud-ldaps/{id}/mappings":{"get":{"tags":["cloud-ldap"],"summary":"Get mappings configurations for Cloud Identity Providers server configuration.","description":"Get all mappings configurations for Cloud Identity Providers server configuration.\n\n> 📋 **Required privilege:** Read LDAP Servers","parameters":[{"name":"id","in":"path","description":"Cloud Identity Provider identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Cloud Identity Provider mappings configuration returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudLdapMappingsResponse"}}}},"400":{"description":"Id can only be a number.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Specified mappings settings for Cloud Identity Provider configuration do not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read LDAP Servers"]},"put":{"tags":["cloud-ldap"],"summary":"Update Cloud Identity Provider mappings configuration.","description":"Update Cloud Identity Provider mappings configuration. Cannot be used for partial updates, all content body must be sent.\n\n> 📋 **Required privilege:** Update LDAP Servers","parameters":[{"name":"id","in":"path","description":"Cloud Identity Provider identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Cloud Identity Provider mappings to update.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudLdapMappingsRequest"}}},"required":true},"responses":{"200":{"description":"Cloud Identity Provider mappings configuration updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudLdapMappingsResponse"}}}},"400":{"description":"One or more parameters were invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Specified Cloud Identity Provider configuration does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"Cloud Identity Provider id from request path do not match id in request body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update LDAP Servers"]}},"/v1/computer-extension-attributes":{"get":{"tags":["computer-extension-attributes"],"summary":"Retrieve Computer Extension Attributes.","description":"Retrieves All Computer Extension Attributes Configuration.\n\n> 📋 **Required privilege:** Read Computer Extension Attributes","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorts results by one or more criteria, following the format property:asc/desc.<br/> Default sort is name:asc.<br/> If using multiple criteria, separate with commas. Allows sort for id and name.","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["name.asc"]}},{"name":"filter","in":"query","description":"Filters results. Use RSQL format for query. Allows for many fields, including ID, name, etc.<br/> Can be combined with paging and sorting.<br/> Fields allowed in the query: id, name <br/> Default filter is an empty query and returns all results from the requested page.","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Computer Extension Attribute objects has been fetched successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerExtensionAttributeSearchResults"}}}},"404":{"description":"Computer Extension Attribute objects could not be found. The server either did not find a current representation for the requested resource or is trying to hide its existence from an unauthorized client.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Computer Extension Attributes"]},"post":{"tags":["computer-extension-attributes"],"summary":"Create Computer Extension Attribute.","description":"Create Computer Extension Attribute to collect extra inventory information.\n\n> 📋 **Required privilege:** Create Computer Extension Attributes","requestBody":{"description":"Computer Extension Attribute to be created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerExtensionAttributes"}}},"required":true},"responses":{"201":{"description":"Computer Extension Attribute was successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"400":{"description":"Bad Request. The server could not understand the request because of invalid syntax. Possible reasons are:</br> 1) Required fields are not provided in request body.</br> 2) Fields which are not associated with provided inputType has some value.</br> 3) Any values outside of the allowed range are included in the request body.</br> 4) LDAP is not configured.</br> 5) Error occured during database create operation.</br> 6) Duplicate_Field","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Create Computer Extension Attributes"],"x-action":true}},"/v1/computer-extension-attributes/delete-multiple":{"post":{"tags":["computer-extension-attributes"],"summary":"Delete multiple Computer Extension Attribute at once.","description":"IDs of the Computer Extension Attribute to be deleted.\n\n> 📋 **Required privilege:** Delete Computer Extension Attributes","requestBody":{"description":"IDs of the Computer Extension Attribute to be deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ids"}}},"required":true},"responses":{"204":{"description":"All specified Computer Extension Attribute deleted successfully."},"400":{"description":"Bad Request. Returns error codes and IDs for any Computer Extension Attribute that were unable to be deleted. Possible reasons are:</br> 1) The specified extension attribute id does not include a valid number.</br> 2) The specified extension attribute id does not exist in Jamf Pro.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Delete Computer Extension Attributes"],"x-action":true}},"/v1/computer-extension-attributes/templates":{"get":{"tags":["computer-extension-attributes"],"summary":"Retrieve All Computer Extension Attributes Templates.","description":"Retrieves All Computer Extension Attributes Templates.\n\n> 📋 **Required privilege:** Read Computer Extension Attributes","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorts results by one or more criteria, following the format property:asc/desc.<br/> Default sort is templateName:asc.<br/> If using multiple criteria, separate with commas. Allows sort for templateName and templateCategory.","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["templateName.asc"]}},{"name":"filter","in":"query","description":"Filters results. Use RSQL format for queries. which allows filtering by multiple fields such as templateName, templateCategoryName.<br/> Can be combined with paging and sorting.<br/> Fields allowed in the query: templateName, templateCategoryName <br/> Default filter is an empty query and returns all results from the requested page.","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Computer Extension Attribute templates objects has been fetched successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CeaTemplatesResults"}}}}},"x-required-privileges":["Read Computer Extension Attributes"]}},"/v1/computer-extension-attributes/templates/{id}":{"get":{"tags":["computer-extension-attributes"],"summary":"Get specified Computer Extension Attribute Template object.","description":"Gets specified Computer Extension Attribute Template object.\n\n> 📋 **Required privilege:** Read Computer Extension Attributes","parameters":[{"name":"id","in":"path","description":"Unique Id of the Template.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Computer Extension Attribute Template object has been fetched successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerExtensionAttributes"}}}},"404":{"description":"Specified Computer Extension Attribute Template object could not be found. The server either did not find a current representation for the requested resource or is trying to hide its existence from an unauthorized client.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Computer Extension Attributes"]}},"/v1/computer-extension-attributes/upload":{"post":{"tags":["computer-extension-attributes"],"summary":"Upload Computer Extension Attribute.","description":"Uploads a Computer Extension Attribute.\n\n> 📋 **Required privileges:**\n> - Create Computer Extension Attributes\n> - Read Computer Extension Attributes","requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"The file to upload","format":"binary"}}}}},"required":true},"responses":{"200":{"description":"Computer Extension Attribute object has been fetched successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerExtensionAttributes"}}}},"404":{"description":"Bad Request. Possible reasons are:</br> 1) Unsupported file extension. Acceptable format is xml.</br> 2) Uploaded file should not be empty.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Create Computer Extension Attributes","Read Computer Extension Attributes"],"x-action":true}},"/v1/computer-extension-attributes/{id}":{"get":{"tags":["computer-extension-attributes"],"summary":"Get specified Computer Extension Attribute object.","description":"Gets specified Computer Extension Attribute object.\n\n> 📋 **Required privilege:** Read Computer Extension Attributes","parameters":[{"name":"id","in":"path","description":"Unique ID of Computer Extension Attribute.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Computer Extension Attribute object has been fetched successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerExtensionAttributes"}}}},"400":{"description":"Bad Request. The server could not understand the request because of invalid syntax. Possible reason can be 'The specified extension attribute id does not include a valid number.'"},"404":{"description":"Specified Computer Extension Attribute object could not be found. The server either did not find a current representation for the requested resource or is trying to hide its existence from an unauthorized client.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Computer Extension Attributes"]},"put":{"tags":["computer-extension-attributes"],"summary":"Update specified Computer Extension Attribute object.","description":"Update specified Computer Extension Attribute object.\n\n> 📋 **Required privilege:** Update Computer Extension Attributes","parameters":[{"name":"id","in":"path","description":"Unique ID of Computer Extension Attribute.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Computer Extension Attribute object to be updated. IDs defined in this body will be ignored.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerExtensionAttributes"}}},"required":true},"responses":{"202":{"description":"Computer Extension Attribute updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerExtensionAttributes"}}}},"400":{"description":"Bad Request. Specified Computer Extension Attribute could not be updated due to bad request. Possible reasons are:</br> 1) The specified extension attribute id does not include a valid number.</br> 2) Duplicate_Field.</br> 3) Required fields are not provided in request body.</br> 4) Fields which are not associated with provided inputType has some value.</br> 5) Any values outside of the allowed range are included in the request body.</br> 6) LDAP is not configured.</br> 7) Error occured during database update operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Specified Computer Extension Attribute object does not exist. The server either did not find a current representation for the requested resource or is trying to hide its existence from an unauthorized client.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Computer Extension Attributes"]},"delete":{"tags":["computer-extension-attributes"],"summary":"Remove specified Computer Extension Attribute.","description":"ID of the Computer Extension Attribute to be deleted.\n\n> 📋 **Required privilege:** Delete Computer Extension Attributes","parameters":[{"name":"id","in":"path","description":"Unique ID of Computer Extension Attribute.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Computer Extension Attribute deleted successfully."},"400":{"description":"Bad Request. The server could not understand the request because of invalid syntax. Possible reason can be 'The specified extension attribute id does not include a valid number.'"},"404":{"description":"Specified Computer Extension Attribute object could not be found. The server either did not find a current representation for the requested resource or is trying to hide its existence from an unauthorized client."}},"x-required-privileges":["Delete Computer Extension Attributes"]}},"/v1/computer-extension-attributes/{id}/data-dependency":{"get":{"tags":["computer-extension-attributes"],"summary":"Get smart group/advance search dependent objects for a specified computer extension attribute","description":"Get smart group/advance search dependent objects for a specified computer extension attribute\n\n> 📋 **Required privilege:** Read Computer Extension Attributes","parameters":[{"name":"id","in":"path","description":"Unique ID of computer extension attribute.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Fetches list of dependent objects for a specified computer extension attribute.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DependencyObjectResults"}}}},"400":{"description":"Bad Request. The server could not understand the request because of invalid syntax.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Specified computer extension attribute id were not found in database.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Computer Extension Attributes"]}},"/v1/computer-extension-attributes/{id}/download":{"get":{"tags":["computer-extension-attributes"],"summary":"Download the specified Computer Extension Attribute.","description":"Retrieves the specified Computer Extension Attribute in XML format based on the provided unique ID.\n\n> 📋 **Required privilege:** Read Computer Extension Attributes","parameters":[{"name":"id","in":"path","description":"The unique ID of the Computer Extension Attribute to be downloaded.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The requested Computer Extension Attribute XML file was fetched successfully.","content":{"application/xml":{"schema":{"type":"string","example":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><extensionAttribute><displayName>Testing</displayName></extensionAttribute>"}}}},"400":{"description":"Bad Request. The server could not understand the request because of invalid syntax. Possible reason can be 'The specified extension attribute id does not include a valid number.'"},"404":{"description":"Specified Computer Extension Attribute object could not be found. The server either did not find a current representation for the requested resource or is trying to hide its existence from an unauthorized client.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Computer Extension Attributes"]}},"/v1/computer-extension-attributes/{id}/history":{"get":{"tags":["computer-extension-attributes"],"summary":"Get specified Computer Extension Attribute History object","description":"Get specified Computer Extension Attribute history object\n\n> 📋 **Required privilege:** Read Computer Extension Attributes","parameters":[{"name":"id","in":"path","description":"Instance ID of Computer Extension Attribute history","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorts results by one or more criteria, following the format property:asc/desc. Default sort is ID:asc. If using multiple criteria, separate with commas.","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}},{"name":"filter","in":"query","description":"Filters results. Use RSQL format for query. Allows for many fields, including ID, name, etc. Can be combined with paging and sorting. Default filter is an empty query and returns all results from the requested page.","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Details of Computer Extension Attribute history were found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistorySearchResults"}}}},"400":{"description":"Bad Request. Specified Computer Extension Attribute history object could not be found. Possible reason can be 'Provided id field is not string of positive numeric value or -1'.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Computer Extension Attributes"]},"post":{"tags":["computer-extension-attributes"],"summary":"Add specified Computer Extension Attribute history object notes","description":"Add specified Computer Extension Attribute history object notes\n\n> 📋 **Required privilege:** Update Computer Extension Attributes","parameters":[{"name":"id","in":"path","description":"Instance ID of Computer Extension Attribute history","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"History note to be created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistoryNote"}}},"required":true},"responses":{"201":{"description":"Computer Extension Attribute history note created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistory"}}}},"400":{"description":"Bad Request. Error creating history note. Possible reason can be 'Provided id field is not string of positive numeric value or -1'.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Computer Extension Attributes"]}},"/v1/computer-groups":{"get":{"tags":["computer-groups"],"summary":"Returns the list of all computer groups\n","description":"Use it to get the list of all computer groups.\n\n\n> 📋 **Required privileges:**\n> - Read Smart Computer Groups\n> - Read Static Computer Groups","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ComputerGroup"}}}}}},"x-required-privileges":["Read Smart Computer Groups","Read Static Computer Groups"]}},"/v2/computer-groups/smart-group-membership/{id}":{"get":{"tags":["computer-groups"],"summary":"Get the membership of a Smart Computer Group\n","description":"Gets the membership of a Smart Computer Group\n\n\n> 📋 **Required privilege:** Read Smart Computer Groups","parameters":[{"name":"id","in":"path","description":"id of the Smart Computer Group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response - Smart Computer Group membership retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartGroupMembership"}}}},"404":{"description":"Smart Computer Group with the specified id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2026-05-28","x-required-privileges":["Read Smart Computer Groups"]}},"/v2/computer-groups/smart-groups":{"get":{"tags":["computer-groups"],"summary":"Search for Smart Computer Groups\n","description":"Search for Smart Computer Groups\n\n\n> 📋 **Required privilege:** Read Smart Computer Groups","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=name:asc","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter smart computer group collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: id, name, siteId. The siteId field can only be filtered by admins with full access. Any sited admin will have siteId filtered automatically. Example: name==\"*group*\"","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartGroupSearchResult"}}}}},"deprecated":true,"x-deprecation-date":"2026-05-28","x-required-privileges":["Read Smart Computer Groups"]},"post":{"tags":["computer-groups"],"summary":"Create a Smart Computer Group\n","description":"Creates a Smart Computer Group\n\n\n> 📋 **Required privilege:** Create Smart Computer Groups","parameters":[{"name":"platform","in":"query","description":"Optional. Return platform identifiers instead of internal identifiers when set to true.","required":false,"style":"form","explode":true,"schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartComputerGroupV2"}}},"required":true},"responses":{"201":{"description":"Successful response - Smart Computer Group created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}}},"deprecated":true,"x-deprecation-date":"2026-05-28","x-required-privileges":["Create Smart Computer Groups"]}},"/v2/computer-groups/smart-groups/{id}":{"get":{"tags":["computer-groups"],"summary":"Get Smart Computer Group by Id\n","description":"Get Smart Computer Group by Id\n\n\n> 📋 **Required privilege:** Read Smart Computer Groups","parameters":[{"name":"id","in":"path","description":"instance id of smart computer group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartComputerGroupV2"}}}},"404":{"description":"Smart Computer Group with the specified id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2026-05-28","x-required-privileges":["Read Smart Computer Groups"]},"put":{"tags":["computer-groups"],"summary":"Update a Smart Computer Group\n","description":"Updates a Smart Computer Group\n\n\n> 📋 **Required privilege:** Update Smart Computer Groups","parameters":[{"name":"id","in":"path","description":"id of target Smart Computer Group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartComputerGroupV2"}}},"required":true},"responses":{"202":{"description":"Successful response - Smart Computer Group updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartComputerGroupV2"}}}},"404":{"description":"Target Smart Computer Group does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2026-05-28","x-required-privileges":["Update Smart Computer Groups"]},"delete":{"tags":["computer-groups"],"summary":"Remove specified Smart Computer Group\n","description":"Remove specified Smart Computer Group\n\n\n> 📋 **Required privilege:** Delete Smart Computer Groups","parameters":[{"name":"id","in":"path","description":"id of target Smart Computer Group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful response - Smart Computer Group removed"},"404":{"description":"Target Smart Computer Group does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2026-05-28","x-required-privileges":["Delete Smart Computer Groups"]}},"/v2/computer-groups/static-groups":{"get":{"tags":["computer-groups"],"summary":"Search for Static Computer Groups\n","description":"Search for Static Computer Groups\n\n\n> 📋 **Required privilege:** Read Static Computer Groups","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=name:asc","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter static computer group collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: id, name, siteId. The siteId field can only be filtered by admins with full access. Any sited admin will have siteId filtered automatically. Example: name==\"*group*\"","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StaticComputerGroupSearchResults"}}}}},"deprecated":true,"x-deprecation-date":"2026-05-28","x-required-privileges":["Read Static Computer Groups"]},"post":{"tags":["computer-groups"],"summary":"Create membership of a static computer group.\n","description":"Create membership of a static computer group.\n\n\n> 📋 **Required privilege:** Create Static Computer Groups","parameters":[{"name":"platform","in":"query","description":"Optional. Return platform identifiers instead of internal identifiers when set to true.","required":false,"style":"form","explode":true,"schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StaticComputerGroupAssignment"}}},"required":true},"responses":{"201":{"description":"Static computer group created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"400":{"description":"Could not save static computer group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"Duplicated name in static computer group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2026-05-28","x-required-privileges":["Create Static Computer Groups"]}},"/v2/computer-groups/static-groups/{id}":{"get":{"tags":["computer-groups"],"summary":"Get Static Computer Group by Id\n","description":"Get Static Computer Group by Id\n\n\n> 📋 **Required privilege:** Read Static Computer Groups","parameters":[{"name":"id","in":"path","description":"instance id of static computer group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StaticComputerGroup"}}}},"404":{"description":"Static Computer Group with the specified id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2026-05-28","x-required-privileges":["Read Static Computer Groups"]},"put":{"tags":["computer-groups"],"summary":"Update membership of a static computer group.\n","description":"Update membership of a static computer group.\n\n\n> 📋 **Required privilege:** Update Static Computer Groups","parameters":[{"name":"id","in":"path","description":"instance id of a static computer group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StaticComputerGroupAssignment"}}},"required":true},"responses":{"202":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StaticComputerGroupAssignment"}}}},"404":{"description":"No static computer group found with the given id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"Duplicated name in static computer group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2026-05-28","x-required-privileges":["Update Static Computer Groups"]},"delete":{"tags":["computer-groups"],"summary":"Remove Static Computer Group by Id\n","description":"Remove Static Computer Group by Id\n\n\n> 📋 **Required privilege:** Delete Static Computer Groups","parameters":[{"name":"id","in":"path","description":"instance id of static computer group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Static Computer Group successfully removed"},"404":{"description":"Unable to delete static computer group with given id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2026-05-28","x-required-privileges":["Delete Static Computer Groups"]}},"/v3/computer-groups/smart-group-membership/{id}":{"get":{"tags":["computer-groups"],"summary":"Get the membership of a Smart Computer Group\n","description":"Gets the membership of a Smart Computer Group\n\n\n> 📋 **Required privilege:** Read Smart Computer Groups","parameters":[{"name":"id","in":"path","description":"id of the Smart Computer Group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response - Smart Computer Group membership retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartGroupMembership"}}}},"404":{"description":"The requested resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Smart Computer Groups"]}},"/v3/computer-groups/smart-groups":{"get":{"tags":["computer-groups"],"summary":"Search for Smart Computer Groups\n","description":"Search for Smart Computer Groups\n\n\n> 📋 **Required privilege:** Read Smart Computer Groups","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=name:asc","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter smart computer group collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: id, name, siteId. The siteId field can only be filtered by admins with full access. Any sited admin will have siteId filtered automatically. Example: name==\"*group*\"","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartGroupSearchResult"}}}}},"x-required-privileges":["Read Smart Computer Groups"]},"post":{"tags":["computer-groups"],"summary":"Create a Smart Computer Group\n","description":"Creates a Smart Computer Group with strict andOr enum validation.\n\n\n> 📋 **Required privilege:** Create Smart Computer Groups","parameters":[{"name":"platform","in":"query","description":"Optional. Return platform identifiers instead of internal identifiers when set to true.","required":false,"style":"form","explode":true,"schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartComputerGroupV3"}}},"required":true},"responses":{"201":{"description":"Successful response - Smart Computer Group created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"400":{"description":"Could not save smart computer group due to validation errors. Common causes include:\n- Invalid priority order in criteria\n- Invalid field values (e.g., andOr must be \"and\" or \"or\")\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"Duplicate group name","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Create Smart Computer Groups"]}},"/v3/computer-groups/smart-groups/{id}":{"get":{"tags":["computer-groups"],"summary":"Get Smart Computer Group by Id\n","description":"Get Smart Computer Group by Id\n\n\n> 📋 **Required privilege:** Read Smart Computer Groups","parameters":[{"name":"id","in":"path","description":"instance id of smart computer group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartComputerGroupV3"}}}},"404":{"description":"The requested resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Smart Computer Groups"]},"put":{"tags":["computer-groups"],"summary":"Update a Smart Computer Group\n","description":"Updates a Smart Computer Group with strict andOr enum validation.\n\n\n> 📋 **Required privilege:** Update Smart Computer Groups","parameters":[{"name":"id","in":"path","description":"id of target Smart Computer Group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartComputerGroupV3"}}},"required":true},"responses":{"202":{"description":"Successful response - Smart Computer Group updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartComputerGroupV3"}}}},"400":{"description":"Could not update smart computer group due to validation errors. Common causes include:\n- Invalid priority order in criteria\n- Invalid field values (e.g., andOr must be \"and\" or \"or\")\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"The requested resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"Duplicate group name","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Smart Computer Groups"]},"delete":{"tags":["computer-groups"],"summary":"Remove specified Smart Computer Group\n","description":"Remove specified Smart Computer Group. Returns 422 if the group has dependencies.\n\n\n> 📋 **Required privilege:** Delete Smart Computer Groups","parameters":[{"name":"id","in":"path","description":"id of target Smart Computer Group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful response - Smart Computer Group removed"},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"Cannot delete smart computer group due to dependencies","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Delete Smart Computer Groups"]}},"/v3/computer-groups/static-groups":{"get":{"tags":["computer-groups"],"summary":"Search for Static Computer Groups\n","description":"Search for Static Computer Groups\n\n\n> 📋 **Required privilege:** Read Static Computer Groups","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=name:asc","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter static computer group collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: id, name, siteId. The siteId field can only be filtered by admins with full access. Any sited admin will have siteId filtered automatically. Example: name==\"*group*\"","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StaticComputerGroupSearchResults"}}}}},"x-required-privileges":["Read Static Computer Groups"]},"post":{"tags":["computer-groups"],"summary":"Create membership of a static computer group.\n","description":"Create membership of a static computer group.\n\n\n> 📋 **Required privilege:** Create Static Computer Groups","parameters":[{"name":"platform","in":"query","description":"Optional. Return platform identifiers instead of internal identifiers when set to true.","required":false,"style":"form","explode":true,"schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StaticComputerGroupAssignment"}}},"required":true},"responses":{"201":{"description":"Static computer group created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"400":{"description":"Could not save static computer group (e.g., invalid device IDs).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"Duplicate group name.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Create Static Computer Groups"]}},"/v3/computer-groups/static-groups/{id}":{"get":{"tags":["computer-groups"],"summary":"Get Static Computer Group by Id\n","description":"Get Static Computer Group by Id\n\n\n> 📋 **Required privilege:** Read Static Computer Groups","parameters":[{"name":"id","in":"path","description":"instance id of static computer group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StaticComputerGroup"}}}},"404":{"description":"The requested resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Static Computer Groups"]},"put":{"tags":["computer-groups"],"summary":"Update membership of a static computer group.\n","description":"Update membership of a static computer group.\n\n\n> 📋 **Required privilege:** Update Static Computer Groups","parameters":[{"name":"id","in":"path","description":"instance id of a static computer group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StaticComputerGroupAssignment"}}},"required":true},"responses":{"202":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StaticComputerGroupAssignment"}}}},"400":{"description":"Invalid device IDs provided.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"The requested resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"Duplicate group name.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Static Computer Groups"]},"delete":{"tags":["computer-groups"],"summary":"Remove Static Computer Group by Id\n","description":"Remove Static Computer Group by Id. Returns 422 if the group has dependencies.\n\n\n> 📋 **Required privilege:** Delete Static Computer Groups","parameters":[{"name":"id","in":"path","description":"instance id of static computer group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Static Computer Group successfully removed"},"404":{"description":"The requested resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"Cannot delete static computer group due to dependencies.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Delete Static Computer Groups"]}},"/v1/computer-inventory/{id}/erase":{"post":{"tags":["computer-inventory"],"summary":"Erase a computer\n","description":"Erase a computer\n\n> 📋 **Required privilege:** Send Computer Remote Wipe Command","parameters":[{"name":"id","in":"path","description":"Id of the computer to erase","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Options for eraseDevice command","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EraseDeviceComputerRequest"}}}},"responses":{"200":{"description":"Erase command was queued for this device.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EraseDeviceComputerResponse"}}}},"403":{"description":"Insufficient privileges to perform this action."},"404":{"description":"Computer not found."},"500":{"description":"Failure, unable to queue command.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2026-07-14","x-required-privileges":["Send Computer Remote Wipe Command"],"x-action":true}},"/v1/computer-inventory/{id}/remove-mdm-profile":{"post":{"tags":["computer-inventory"],"summary":"Remove a computer's MDM profile\n","description":"Remove a computer's MDM profile\n\n> 📋 **Required privilege:** Send Computer Unmanage Command","parameters":[{"name":"id","in":"path","description":"Id of the computer to remove the MDM profile from","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Command to remove the mdm profile was queued","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveComputerMdmProfileResponse"}}}},"403":{"description":"Insufficient privileges to perform this action."},"500":{"description":"Failure, unable to queue command.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2026-07-14","x-required-privileges":["Send Computer Unmanage Command"],"x-action":true}},"/v1/computers-inventory":{"get":{"tags":["computer-inventory"],"summary":"Return paginated Computer Inventory records","description":"Return paginated Computer Inventory records\n\n> 📋 **Required privilege:** Read Computers","parameters":[{"name":"section","in":"query","description":"section of computer details, if not specified, General section data is returned. Multiple section parameters are supported, e.g. section=GENERAL&amp;section=HARDWARE","required":false,"style":"form","explode":true,"schema":{"type":"array","example":["GENERAL"],"items":{"$ref":"#/components/schemas/ComputerSection"},"default":["GENERAL"]}},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: `property:asc/desc`. Default sort\nis `general.name:asc`. Multiple sort criteria are supported and must be separated with\na comma.\n\nFields allowed in the sort: `general.name`, `udid`, `id`, `general.assetTag`,\n`general.jamfBinaryVersion`, `general.lastContactTime`, `general.lastEnrolledDate`, `general.lastCloudBackupDate`,\n`general.reportDate`,\n`general.mdmCertificateExpiration`, `general.platform`, `general.lastLoggedInUsernameSelfService`, `general.lastLoggedInUsernameSelfServiceTimestamp`,\n`general.lastLoggedInUsernameBinary`, `general.lastLoggedInUsernameBinaryTimestamp`,\n`general.lastLoggedInUsernameMdm`, `general.lastLoggedInUsernameMdmTimestamp`\n`hardware.make`, `hardware.model`,\n`operatingSystem.build`, `operatingSystem.supplementalBuildVersion`, `operatingSystem.rapidSecurityResponse`, `operatingSystem.name`, `operatingSystem.version`,\n`userAndLocation.realname`,\n`purchasing.lifeExpectancy`, `purchasing.warrantyDate`\n\nExample: `sort=udid:desc,general.name:asc`.\n","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["general.name:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter computer inventory collection.\nDefault filter is empty query - returning all results for the requested page.\n\nFields allowed in the query: `general.name`, `udid`, `id`, `general.assetTag`, `general.barcode1`, `general.barcode2`,\n`general.enrolledViaAutomatedDeviceEnrollment`, `general.lastIpAddress`, `general.itunesStoreAccountActive`,\n`general.jamfBinaryVersion`, `general.lastContactTime`, `general.lastEnrolledDate`, `general.lastCloudBackupDate`,\n`general.reportDate`, `general.lastReportedIp`, `general.lastReportedIpV4`, `general.lastReportedIpV6`, `general.managementId`, `general.remoteManagement.managed`,\n`general.mdmCapable.capable`, `general.mdmCertificateExpiration`, `general.platform`, `general.supervised`, `general.userApprovedMdm`, `general.declarativeDeviceManagementEnabled`, \n`general.lastLoggedInUsernameSelfService`, `general.lastLoggedInUsernameSelfServiceTimestamp`,\n`general.lastLoggedInUsernameBinary`, `general.lastLoggedInUsernameBinaryTimestamp`,\n`general.lastLoggedInUsernameMdm`, `general.lastLoggedInUsernameMdmTimestamp`,\n`hardware.bleCapable`, `hardware.macAddress`, `hardware.make`, `hardware.model`, `hardware.modelIdentifier`, `hardware.serialNumber`,\n`hardware.supportsIosAppInstalls`,`hardware.appleSilicon`, `operatingSystem.activeDirectoryStatus`, `operatingSystem.fileVault2Status`,\n`operatingSystem.build`, `operatingSystem.supplementalBuildVersion`, `operatingSystem.rapidSecurityResponse`, `operatingSystem.name`, `operatingSystem.version`, `security.activationLockEnabled`,\n`security.recoveryLockEnabled`,`security.firewallEnabled`,`userAndLocation.buildingId`, `userAndLocation.departmentId`, `userAndLocation.email`, `userAndLocation.realname`,\n`userAndLocation.phone`, `userAndLocation.position`,`userAndLocation.room`, `userAndLocation.username`, `diskEncryption.fileVault2Enabled`,\n`purchasing.appleCareId`, `purchasing.lifeExpectancy`, `purchasing.purchased`, `purchasing.leased`, `purchasing.vendor`, `purchasing.warrantyDate`,\n\nThis param can be combined with paging and sorting.\nExample: `filter=general.name==\"Orchard\"`\n","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerInventorySearchResults"}}}}},"deprecated":true,"x-deprecation-date":"2025-06-30","x-required-privileges":["Read Computers"]},"post":{"tags":["computer-inventory"],"summary":"Create Computer Inventory record","description":"Creates Computer Inventory record\n\n> 📋 **Required privilege:** Create Computers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerInventoryCreateRequest"}}},"required":true},"responses":{"201":{"description":"Successful response - Computer Inventory record created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}}},"deprecated":true,"x-deprecation-date":"2025-06-30","x-required-privileges":["Create Computers"]}},"/v1/computers-inventory-detail/{id}":{"get":{"tags":["computer-inventory"],"summary":"Return all sections of a computer","description":"Return all sections of a computer\n\n> 📋 **Required privilege:** Read Computers","parameters":[{"name":"id","in":"path","description":"instance id of computer record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Details of computer were found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerInventory"}}}},"404":{"description":"Specified computer object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2025-06-30","x-required-privileges":["Read Computers"]},"patch":{"tags":["computer-inventory"],"summary":"Update specific fields on a computer","description":"Update specific fields on a computer, then return the updated computer object.\n\n> 📋 **Required privilege:** Update Computers","parameters":[{"name":"id","in":"path","description":"instance id of computer record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerInventoryUpdateRequest"}}},"required":true},"responses":{"200":{"description":"Details of computer were found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerInventory"}}}},"404":{"description":"Specified computer object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2025-06-30","x-required-privileges":["Update Computers"]}},"/v1/computers-inventory/filevault":{"get":{"tags":["computer-inventory"],"summary":"Return paginated FileVault information for all computers","description":"Return paginated FileVault information for all computers\n\n> 📋 **Required privilege:** View Disk Encryption Recovery Key","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerInventoryFileVaultSearchResults"}}}}},"deprecated":true,"x-deprecation-date":"2025-06-30","x-required-privileges":["View Disk Encryption Recovery Key"]}},"/v1/computers-inventory/{id}":{"get":{"tags":["computer-inventory"],"summary":"Return General section of a Computer","description":"Return General section of a Computer\n\n> 📋 **Required privilege:** Read Computers","parameters":[{"name":"id","in":"path","description":"instance id of computer record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"section","in":"query","description":"section of computer details, if not specified, General section data is returned. Multiple section parameters are supported, e.g. section=general&amp;section=hardware","required":false,"style":"form","explode":true,"schema":{"type":"array","example":["GENERAL"],"items":{"$ref":"#/components/schemas/ComputerSection"},"default":["GENERAL"]}}],"responses":{"200":{"description":"Details of computer were found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerInventory"}}}},"404":{"description":"Specified computer object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2025-06-30","x-required-privileges":["Read Computers"]},"delete":{"tags":["computer-inventory"],"summary":"Remove specified Computer record","description":"Remove specified Computer record\n\n> 📋 **Required privilege:** Delete Computers","parameters":[{"name":"id","in":"path","description":"instance id of computer record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Computer record successfully removed"},"404":{"description":"Specified computer object id does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2025-06-30","x-required-privileges":["Delete Computers"]}},"/v1/computers-inventory/{id}/attachments":{"post":{"tags":["computer-inventory"],"summary":"Upload attachment and assign to computer","description":"Upload attachment and assign to computer\n\n> 📋 **Required privilege:** Update Computers","parameters":[{"name":"id","in":"path","description":"instance id of computer record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"The file to upload","format":"binary"}}}}},"required":true},"responses":{"201":{"description":"Successfully uploaded attachment","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"404":{"description":"Specified computer object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2025-06-30","x-required-privileges":["Update Computers"]}},"/v1/computers-inventory/{id}/attachments/{attachmentId}":{"get":{"tags":["computer-inventory"],"summary":"Download attachment file","description":"Download attachment file\n\n> 📋 **Required privilege:** Read Computers","parameters":[{"name":"id","in":"path","description":"instance id of computer record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"attachmentId","in":"path","description":"instance id of attachment object","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Attachment successfully downloaded","content":{"text/plain":{"schema":{"type":"string","description":"Downloaded binary file, Content-Type will be dynamic, based on a file extension","format":"binary"}}}},"404":{"description":"Specified computer object or attachment does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2025-06-30","x-required-privileges":["Read Computers"]},"delete":{"tags":["computer-inventory"],"summary":"Remove attachment","description":"Remove attachment\n\n> 📋 **Required privilege:** Update Computers","parameters":[{"name":"id","in":"path","description":"instance id of computer record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"attachmentId","in":"path","description":"instance id of attachment object","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Attachment successfully removed"},"404":{"description":"Specified computer object or attachment does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2025-06-30","x-required-privileges":["Update Computers"]}},"/v1/computers-inventory/{id}/filevault":{"get":{"tags":["computer-inventory"],"summary":"Return FileVault information for a specific computer","description":"Return FileVault information for a specific computer\n\n> 📋 **Required privilege:** View Disk Encryption Recovery Key","parameters":[{"name":"id","in":"path","description":"instance id of computer record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"FileVault information for computer was found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerInventoryFileVault"}}}},"404":{"description":"FileVault information for specified computer does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2025-06-30","x-required-privileges":["View Disk Encryption Recovery Key"]}},"/v1/computers-inventory/{id}/view-device-lock-pin":{"get":{"tags":["computer-inventory"],"summary":"Return a computer's Device Lock PIN","description":"Return a computer's Device Lock PIN\n\n> 📋 **Required privilege:** View Computer Device Lock Pin","parameters":[{"name":"id","in":"path","description":"instance id of computer record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Device Lock PIN","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerInventoryDeviceLockPinResponse"}}}},"404":{"description":"Specified computer object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2025-06-30","x-required-privileges":["View Computer Device Lock Pin"]}},"/v1/computers-inventory/{id}/view-recovery-lock-password":{"get":{"tags":["computer-inventory"],"summary":"Return a Computers Recovery Lock Password","description":"Return a Computers Recovery Lock Password\n\n> 📋 **Required privilege:** View Recovery Lock","parameters":[{"name":"id","in":"path","description":"instance id of computer record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Recovery Lock Password","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerInventoryRecoveryLockPasswordResponse"}}}},"404":{"description":"Specified computer object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2025-06-30","x-required-privileges":["View Recovery Lock"]}},"/v2/computers-inventory":{"get":{"tags":["computer-inventory"],"summary":"Return paginated Computer Inventory records","description":"Return paginated Computer Inventory records\n\n> 📋 **Required privilege:** Read Computers","parameters":[{"name":"section","in":"query","description":"section of computer details, if not specified, General section data is returned. Multiple section parameters are supported, e.g. section=GENERAL&amp;section=HARDWARE","required":false,"style":"form","explode":true,"schema":{"type":"array","example":["GENERAL"],"items":{"$ref":"#/components/schemas/ComputerSectionV2"},"default":["GENERAL"]}},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: `property:asc/desc`. Default sort\nis `general.name:asc`. Multiple sort criteria are supported and must be separated with\na comma.\n\nFields allowed in the sort: `general.name`, `udid`, `id`, `general.assetTag`,\n`general.jamfBinaryVersion`, `general.lastContactTime`, `general.lastEnrolledDate`, `general.lastCloudBackupDate`,\n`general.reportDate`,\n`general.mdmCertificateExpiration`, `general.platform`, `general.lastLoggedInUsernameSelfService`, `general.lastLoggedInUsernameSelfServiceTimestamp`,\n`general.lastLoggedInUsernameBinary`, `general.lastLoggedInUsernameBinaryTimestamp`,\n`general.lastLoggedInUsernameMdm`, `general.lastLoggedInUsernameMdmTimestamp`,\n`hardware.make`, `hardware.model`,\n`operatingSystem.build`, `operatingSystem.supplementalBuildVersion`, `operatingSystem.rapidSecurityResponse`, `operatingSystem.name`, `operatingSystem.version`,\n`userAndLocation.realname`,\n`purchasing.lifeExpectancy`, `purchasing.warrantyDate`\n\nExample: `sort=udid:desc,general.name:asc`.\n","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["general.name:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter computer inventory collection.\nDefault filter is empty query - returning all results for the requested page.\n\nFields allowed in the query: `general.name`, `udid`, `id`, `general.assetTag`, `general.barcode1`, `general.barcode2`,\n`general.enrolledViaAutomatedDeviceEnrollment`, `general.lastIpAddress`, `general.itunesStoreAccountActive`,\n`general.jamfBinaryVersion`, `general.lastContactTime`, `general.lastEnrolledDate`, `general.lastCloudBackupDate`,\n`general.reportDate`, `general.lastReportedIp`, `general.lastReportedIpV4`, `general.lastReportedIpV6`, `general.managementId`, `general.remoteManagement.managed`,\n`general.mdmCapable.capable`, `general.mdmCertificateExpiration`, `general.platform`, `general.supervised`, `general.userApprovedMdm`, `general.declarativeDeviceManagementEnabled`, \n`general.lastLoggedInUsernameSelfService`, `general.lastLoggedInUsernameSelfServiceTimestamp`,\n`general.lastLoggedInUsernameBinary`, `general.lastLoggedInUsernameBinaryTimestamp`,\n`general.lastLoggedInUsernameMdm`, `general.lastLoggedInUsernameMdmTimestamp`,\n`hardware.bleCapable`, `hardware.macAddress`, `hardware.make`, `hardware.model`, `hardware.modelIdentifier`, `hardware.serialNumber`,\n`hardware.supportsIosAppInstalls`,`hardware.appleSilicon`, `operatingSystem.activeDirectoryStatus`, `operatingSystem.fileVault2Status`,\n`operatingSystem.build`, `operatingSystem.supplementalBuildVersion`, `operatingSystem.rapidSecurityResponse`, `operatingSystem.name`, `operatingSystem.version`, `security.activationLockEnabled`,\n`security.recoveryLockEnabled`,`security.firewallEnabled`,`userAndLocation.buildingId`, `userAndLocation.departmentId`, `userAndLocation.email`, `userAndLocation.realname`,\n`userAndLocation.phone`, `userAndLocation.position`,`userAndLocation.room`, `userAndLocation.username`, `diskEncryption.fileVault2Enabled`,\n`purchasing.appleCareId`, `purchasing.lifeExpectancy`, `purchasing.purchased`, `purchasing.leased`, `purchasing.vendor`, `purchasing.warrantyDate`,\n\nThis param can be combined with paging and sorting.\nExample: `filter=general.name==\"Orchard\"`\n","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerInventorySearchResultsV2"}}}}},"deprecated":true,"x-deprecation-date":"2025-11-06","x-required-privileges":["Read Computers"]},"post":{"tags":["computer-inventory"],"summary":"Create Computer Inventory record","description":"Creates Computer Inventory record\n\n> 📋 **Required privilege:** Create Computers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerInventoryCreateRequestV2"}}},"required":true},"responses":{"201":{"description":"Successful response - Computer Inventory record created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}}},"deprecated":true,"x-deprecation-date":"2025-11-06","x-required-privileges":["Create Computers"]}},"/v2/computers-inventory-detail/{id}":{"get":{"tags":["computer-inventory"],"summary":"Return all sections of a computer","description":"Return all sections of a computer\n\n> 📋 **Required privilege:** Read Computers","parameters":[{"name":"id","in":"path","description":"instance id of computer record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Details of computer were found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerInventoryV2"}}}},"404":{"description":"Specified computer object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2025-11-06","x-required-privileges":["Read Computers"]},"patch":{"tags":["computer-inventory"],"summary":"Update specific fields on a computer","description":"Update specific fields on a computer, then return the updated computer object.\n\n> 📋 **Required privilege:** Update Computers","parameters":[{"name":"id","in":"path","description":"instance id of computer record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerInventoryUpdateRequest"}}},"required":true},"responses":{"204":{"description":"Details of computer were updated"},"404":{"description":"Specified computer object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2025-11-06","x-required-privileges":["Update Computers"]}},"/v2/computers-inventory/filevault":{"get":{"tags":["computer-inventory"],"summary":"Return paginated FileVault information for all computers","description":"Return paginated FileVault information for all computers\n\n> 📋 **Required privilege:** View Disk Encryption Recovery Key","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerInventoryFileVaultSearchResults"}}}}},"deprecated":true,"x-deprecation-date":"2025-11-06","x-required-privileges":["View Disk Encryption Recovery Key"]}},"/v2/computers-inventory/{id}":{"get":{"tags":["computer-inventory"],"summary":"Return General section of a Computer","description":"Return General section of a Computer\n\n> 📋 **Required privilege:** Read Computers","parameters":[{"name":"id","in":"path","description":"instance id of computer record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"section","in":"query","description":"section of computer details, if not specified, General section data is returned. Multiple section parameters are supported, e.g. section=general&amp;section=hardware","required":false,"style":"form","explode":true,"schema":{"type":"array","example":["GENERAL"],"items":{"$ref":"#/components/schemas/ComputerSectionV2"},"default":["GENERAL"]}}],"responses":{"200":{"description":"Details of computer were found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerInventoryV2"}}}},"404":{"description":"Specified computer object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2025-11-06","x-required-privileges":["Read Computers"]},"delete":{"tags":["computer-inventory"],"summary":"Remove specified Computer record","description":"Remove specified Computer record\n\n> 📋 **Required privilege:** Delete Computers","parameters":[{"name":"id","in":"path","description":"instance id of computer record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Computer record successfully removed"},"404":{"description":"Specified computer object id does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2025-11-06","x-required-privileges":["Delete Computers"]}},"/v2/computers-inventory/{id}/attachments":{"post":{"tags":["computer-inventory"],"summary":"Upload attachment and assign to computer","description":"Upload attachment and assign to computer\n\n> 📋 **Required privilege:** Update Computers","parameters":[{"name":"id","in":"path","description":"instance id of computer record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"The file to upload","format":"binary"}}}}},"required":true},"responses":{"201":{"description":"Successfully uploaded attachment","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"404":{"description":"Specified computer object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2025-11-06","x-required-privileges":["Update Computers"]}},"/v2/computers-inventory/{id}/attachments/{attachmentId}":{"get":{"tags":["computer-inventory"],"summary":"Download attachment file","description":"Download attachment file\n\n> 📋 **Required privilege:** Read Computers","parameters":[{"name":"id","in":"path","description":"instance id of computer record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"attachmentId","in":"path","description":"instance id of attachment object","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Attachment successfully downloaded","content":{"text/plain":{"schema":{"type":"string","description":"Downloaded binary file, Content-Type will be dynamic, based on a file extension","format":"binary"}}}},"404":{"description":"Specified computer object or attachment does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2025-11-06","x-required-privileges":["Read Computers"]},"delete":{"tags":["computer-inventory"],"summary":"Remove attachment","description":"Remove attachment\n\n> 📋 **Required privilege:** Update Computers","parameters":[{"name":"id","in":"path","description":"instance id of computer record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"attachmentId","in":"path","description":"instance id of attachment object","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Attachment successfully removed"},"404":{"description":"Specified computer object or attachment does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2025-11-06","x-required-privileges":["Update Computers"]}},"/v2/computers-inventory/{id}/filevault":{"get":{"tags":["computer-inventory"],"summary":"Return FileVault information for a specific computer","description":"Return FileVault information for a specific computer\n\n> 📋 **Required privilege:** View Disk Encryption Recovery Key","parameters":[{"name":"id","in":"path","description":"instance id of computer record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"FileVault information for computer was found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerInventoryFileVault"}}}},"404":{"description":"FileVault information for specified computer does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2025-11-06","x-required-privileges":["View Disk Encryption Recovery Key"]}},"/v2/computers-inventory/{id}/view-device-lock-pin":{"get":{"tags":["computer-inventory"],"summary":"Return a computer's Device Lock PIN","description":"Return a computer's Device Lock PIN\n\n> 📋 **Required privilege:** View Computer Device Lock Pin","parameters":[{"name":"id","in":"path","description":"instance id of computer record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Device Lock PIN","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerInventoryDeviceLockPinResponse"}}}},"404":{"description":"Specified computer object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2025-11-06","x-required-privileges":["View Computer Device Lock Pin"]}},"/v2/computers-inventory/{id}/view-recovery-lock-password":{"get":{"tags":["computer-inventory"],"summary":"Return a Computers Recovery Lock Password","description":"Return a Computers Recovery Lock Password\n\n> 📋 **Required privilege:** View Recovery Lock","parameters":[{"name":"id","in":"path","description":"instance id of computer record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Recovery Lock Password","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerInventoryRecoveryLockPasswordResponse"}}}},"404":{"description":"Specified computer object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2025-11-06","x-required-privileges":["View Recovery Lock"]}},"/v3/computers-inventory":{"get":{"tags":["computer-inventory"],"summary":"Return paginated Computer Inventory records","description":"Return paginated Computer Inventory records\n\n> 📋 **Required privilege:** Read Computers","parameters":[{"name":"section","in":"query","description":"section of computer details, if not specified, General section data is returned. Multiple section parameters are supported, e.g. section=GENERAL&amp;section=HARDWARE","required":false,"style":"form","explode":true,"schema":{"type":"array","example":["GENERAL"],"items":{"$ref":"#/components/schemas/ComputerSectionV3"},"default":["GENERAL"]}},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: `property:asc/desc`. Default sort\nis `general.name:asc`. Multiple sort criteria are supported and must be separated with\na comma.\n\nFields allowed in the sort: `general.name`, `udid`, `id`, `general.assetTag`,\n`general.jamfBinaryVersion`, `general.lastContactTime`, `general.lastEnrolledDate`, `general.lastCloudBackupDate`,\n`general.reportDate`,\n`general.mdmCertificateExpiration`, `general.platform`, `general.lastLoggedInUsernameSelfService`, `general.lastLoggedInUsernameSelfServiceTimestamp`,\n`general.lastLoggedInUsernameBinary`, `general.lastLoggedInUsernameBinaryTimestamp`,\n`general.lastLoggedInUsernameMdm`, `general.lastLoggedInUsernameMdmTimestamp`,\n`hardware.make`, `hardware.model`,\n`operatingSystem.build`, `operatingSystem.supplementalBuildVersion`, `operatingSystem.rapidSecurityResponse`, `operatingSystem.name`, `operatingSystem.version`,\n`userAndLocation.realname`,\n`purchasing.lifeExpectancy`, `purchasing.warrantyDate`\n\nExample: `sort=udid:desc,general.name:asc`.\n","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["general.name:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter computer inventory collection.\nDefault filter is empty query - returning all results for the requested page.\n\nFields allowed in the query: `general.name`, `udid`, `id`, `general.assetTag`, `general.barcode1`, `general.barcode2`,\n`general.enrolledViaAutomatedDeviceEnrollment`, `general.lastIpAddress`, `general.itunesStoreAccountActive`,\n`general.jamfBinaryVersion`, `general.lastContactTime`, `general.lastEnrolledDate`, `general.lastCloudBackupDate`,\n`general.reportDate`, `general.lastReportedIp`, `general.lastReportedIpV4`, `general.lastReportedIpV6`, `general.managementId`, `general.remoteManagement.managed`,\n`general.mdmCapable.capable`, `general.mdmCertificateExpiration`, `general.platform`, `general.supervised`, `general.userApprovedMdm`, `general.declarativeDeviceManagementEnabled`, \n`general.lastLoggedInUsernameSelfService`, `general.lastLoggedInUsernameSelfServiceTimestamp`,\n`general.lastLoggedInUsernameBinary`, `general.lastLoggedInUsernameBinaryTimestamp`,\n`general.lastLoggedInUsernameMdm`, `general.lastLoggedInUsernameMdmTimestamp`,\n`hardware.bleCapable`, `hardware.macAddress`, `hardware.make`, `hardware.model`, `hardware.modelIdentifier`, `hardware.serialNumber`,\n`hardware.supportsIosAppInstalls`,`hardware.appleSilicon`, `operatingSystem.activeDirectoryStatus`, `operatingSystem.fileVault2Status`,\n`operatingSystem.build`, `operatingSystem.supplementalBuildVersion`, `operatingSystem.rapidSecurityResponse`, `operatingSystem.name`, `operatingSystem.version`, `security.activationLockEnabled`,\n`security.recoveryLockEnabled`,`security.firewallEnabled`,`userAndLocation.buildingId`, `userAndLocation.departmentId`, `userAndLocation.email`, `userAndLocation.realname`,\n`userAndLocation.phone`, `userAndLocation.position`,`userAndLocation.room`, `userAndLocation.username`, `diskEncryption.fileVault2Enabled`,\n`purchasing.appleCareId`, `purchasing.lifeExpectancy`, `purchasing.purchased`, `purchasing.leased`, `purchasing.vendor`, `purchasing.warrantyDate`,\n\nThis param can be combined with paging and sorting.\nExample: `filter=general.name==\"Orchard\"`\n","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerInventorySearchResultsV3"}}}}},"deprecated":true,"x-deprecation-date":"2026-07-14","x-required-privileges":["Read Computers"]},"post":{"tags":["computer-inventory"],"summary":"Create Computer Inventory record","description":"Creates Computer Inventory record\n\n> 📋 **Required privilege:** Create Computers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerInventoryCreateRequestV2"}}},"required":true},"responses":{"201":{"description":"Successful response - Computer Inventory record created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}}},"deprecated":true,"x-deprecation-date":"2026-07-14","x-required-privileges":["Create Computers"]}},"/v3/computers-inventory-detail/{id}":{"get":{"tags":["computer-inventory"],"summary":"Return all sections of a computer","description":"Return all sections of a computer\n\n> 📋 **Required privilege:** Read Computers","parameters":[{"name":"id","in":"path","description":"instance id of computer record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Details of computer were found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerInventoryV3"}}}},"404":{"description":"Specified computer object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2026-07-14","x-required-privileges":["Read Computers"]},"patch":{"tags":["computer-inventory"],"summary":"Update specific fields on a computer","description":"Update specific fields on a computer, then return the updated computer object.\n\n> 📋 **Required privilege:** Update Computers","parameters":[{"name":"id","in":"path","description":"instance id of computer record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerInventoryUpdateRequest"}}},"required":true},"responses":{"204":{"description":"Details of computer were updated"},"404":{"description":"Specified computer object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2026-07-14","x-required-privileges":["Update Computers"]}},"/v3/computers-inventory/filevault":{"get":{"tags":["computer-inventory"],"summary":"Return paginated FileVault information for all computers","description":"Return paginated FileVault information for all computers\n\n> 📋 **Required privilege:** View Disk Encryption Recovery Key","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerInventoryFileVaultSearchResults"}}}}},"deprecated":true,"x-deprecation-date":"2026-07-14","x-required-privileges":["View Disk Encryption Recovery Key"]}},"/v3/computers-inventory/{id}":{"get":{"tags":["computer-inventory"],"summary":"Return General section of a Computer","description":"Return General section of a Computer\n\n> 📋 **Required privilege:** Read Computers","parameters":[{"name":"id","in":"path","description":"instance id of computer record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"section","in":"query","description":"section of computer details, if not specified, General section data is returned. Multiple section parameters are supported, e.g. section=general&amp;section=hardware","required":false,"style":"form","explode":true,"schema":{"type":"array","example":["GENERAL"],"items":{"$ref":"#/components/schemas/ComputerSectionV3"},"default":["GENERAL"]}}],"responses":{"200":{"description":"Details of computer were found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerInventoryV3"}}}},"404":{"description":"Specified computer object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2026-07-14","x-required-privileges":["Read Computers"]},"delete":{"tags":["computer-inventory"],"summary":"Remove specified Computer record","description":"Remove specified Computer record\n\n> 📋 **Required privilege:** Delete Computers","parameters":[{"name":"id","in":"path","description":"instance id of computer record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Computer record successfully removed"},"404":{"description":"Specified computer object id does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2026-07-14","x-required-privileges":["Delete Computers"]}},"/v3/computers-inventory/{id}/attachments":{"post":{"tags":["computer-inventory"],"summary":"Upload attachment and assign to computer","description":"Upload attachment and assign to computer\n\n> 📋 **Required privilege:** Update Computers","parameters":[{"name":"id","in":"path","description":"instance id of computer record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"The file to upload","format":"binary"}}}}},"required":true},"responses":{"201":{"description":"Successfully uploaded attachment","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"404":{"description":"Specified computer object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2026-07-14","x-required-privileges":["Update Computers"]}},"/v3/computers-inventory/{id}/attachments/{attachmentId}":{"get":{"tags":["computer-inventory"],"summary":"Download attachment file","description":"Download attachment file\n\n> 📋 **Required privilege:** Read Computers","parameters":[{"name":"id","in":"path","description":"instance id of computer record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"attachmentId","in":"path","description":"instance id of attachment object","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Attachment successfully downloaded","content":{"text/plain":{"schema":{"type":"string","description":"Downloaded binary file, Content-Type will be dynamic, based on a file extension","format":"binary"}}}},"404":{"description":"Specified computer object or attachment does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2026-07-14","x-required-privileges":["Read Computers"]},"delete":{"tags":["computer-inventory"],"summary":"Remove attachment","description":"Remove attachment\n\n> 📋 **Required privilege:** Update Computers","parameters":[{"name":"id","in":"path","description":"instance id of computer record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"attachmentId","in":"path","description":"instance id of attachment object","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Attachment successfully removed"},"404":{"description":"Specified computer object or attachment does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2026-07-14","x-required-privileges":["Update Computers"]}},"/v3/computers-inventory/{id}/filevault":{"get":{"tags":["computer-inventory"],"summary":"Return FileVault information for a specific computer","description":"Return FileVault information for a specific computer\n\n> 📋 **Required privilege:** View Disk Encryption Recovery Key","parameters":[{"name":"id","in":"path","description":"instance id of computer record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"FileVault information for computer was found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerInventoryFileVault"}}}},"404":{"description":"FileVault information for specified computer does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2026-07-14","x-required-privileges":["View Disk Encryption Recovery Key"]}},"/v3/computers-inventory/{id}/view-device-lock-pin":{"get":{"tags":["computer-inventory"],"summary":"Return a computer's Device Lock PIN","description":"Return a computer's Device Lock PIN\n\n> 📋 **Required privilege:** View Computer Device Lock Pin","parameters":[{"name":"id","in":"path","description":"instance id of computer record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Device Lock PIN","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerInventoryDeviceLockPinResponse"}}}},"404":{"description":"Specified computer object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2026-07-14","x-required-privileges":["View Computer Device Lock Pin"]}},"/v3/computers-inventory/{id}/view-recovery-lock-password":{"get":{"tags":["computer-inventory"],"summary":"Return a Computers Recovery Lock Password","description":"Return a Computers Recovery Lock Password\n\n> 📋 **Required privilege:** View Recovery Lock","parameters":[{"name":"id","in":"path","description":"instance id of computer record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Recovery Lock Password","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerInventoryRecoveryLockPasswordResponse"}}}},"404":{"description":"Specified computer object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2026-07-14","x-required-privileges":["View Recovery Lock"]}},"/v4/computers-inventory":{"get":{"tags":["computer-inventory"],"summary":"Return paginated Computer Inventory records","description":"Return paginated Computer Inventory records\n\n> 📋 **Required privilege:** Read Computers","parameters":[{"name":"section","in":"query","description":"section of computer details, if not specified, General section data is returned. Multiple section parameters are supported, e.g. section=GENERAL&amp;section=HARDWARE","required":false,"style":"form","explode":true,"schema":{"type":"array","example":["GENERAL"],"items":{"$ref":"#/components/schemas/ComputerSectionV4"},"default":["GENERAL"]}},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: `property:asc/desc`. Default sort\nis `general.name:asc`. Multiple sort criteria are supported and must be separated with\na comma.\n\nFields allowed in the sort: `general.name`, `udid`, `id`, `general.assetTag`,\n`general.jamfBinaryVersion`, `general.lastCheckIn`, `general.lastContact`, `general.lastEnrolledDate`, `general.lastCloudBackupDate`,\n`general.reportDate`,\n`general.mdmCertificateExpiration`, `general.platform`, `general.lastLoggedInUsernameSelfService`, `general.lastLoggedInUsernameSelfServiceTimestamp`,\n`general.lastLoggedInUsernameBinary`, `general.lastLoggedInUsernameBinaryTimestamp`,\n`general.lastLoggedInUsernameMdm`, `general.lastLoggedInUsernameMdmTimestamp`,\n`hardware.make`, `hardware.model`,\n`operatingSystem.build`, `operatingSystem.supplementalBuildVersion`, `operatingSystem.rapidSecurityResponse`, `operatingSystem.name`, `operatingSystem.version`,\n`userAndLocation.realname`,\n`purchasing.lifeExpectancy`, `purchasing.warrantyDate`\n\nExample: `sort=udid:desc,general.name:asc`.\n","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["general.name:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter computer inventory collection.\nDefault filter is empty query - returning all results for the requested page.\n\nFields allowed in the query: `general.name`, `udid`, `id`, `general.assetTag`, `general.awaitingConfiguration`, `general.barcode1`, `general.barcode2`,\n`general.enrolledViaAutomatedDeviceEnrollment`, `general.lastIpAddress`, `general.itunesStoreAccountActive`,\n`general.jamfBinaryVersion`, `general.lastCheckIn`, `general.lastContact`, `general.lastEnrolledDate`, `general.lastCloudBackupDate`,\n`general.reportDate`, `general.lastReportedIp`, `general.lastReportedIpV4`, `general.lastReportedIpV6`, `general.managementId`, `general.remoteManagement.managed`,\n`general.mdmCapable.capable`, `general.mdmCertificateExpiration`, `general.platform`, `general.supervised`, `general.userApprovedMdm`, `general.declarativeDeviceManagementEnabled`,\n`general.lastLoggedInUsernameSelfService`, `general.lastLoggedInUsernameSelfServiceTimestamp`,\n`general.lastLoggedInUsernameBinary`, `general.lastLoggedInUsernameBinaryTimestamp`,\n`general.lastLoggedInUsernameMdm`, `general.lastLoggedInUsernameMdmTimestamp`,\n`hardware.bleCapable`, `hardware.macAddress`, `hardware.make`, `hardware.model`, `hardware.modelIdentifier`, `hardware.serialNumber`,\n`hardware.supportsIosAppInstalls`,`hardware.appleSilicon`, `operatingSystem.activeDirectoryStatus`, `operatingSystem.fileVault2Status`,\n`operatingSystem.build`, `operatingSystem.supplementalBuildVersion`, `operatingSystem.rapidSecurityResponse`, `operatingSystem.name`, `operatingSystem.version`, `security.activationLockEnabled`,\n`security.lockdownModeEnabled`, `security.recoveryLockEnabled`,`security.firewallEnabled`,`userAndLocation.buildingId`, `userAndLocation.departmentId`, `userAndLocation.email`, `userAndLocation.realname`,\n`userAndLocation.phone`, `userAndLocation.position`,`userAndLocation.room`, `userAndLocation.username`, `diskEncryption.fileVault2Enabled`,\n`purchasing.appleCareId`, `purchasing.lifeExpectancy`, `purchasing.purchased`, `purchasing.leased`, `purchasing.vendor`, `purchasing.warrantyDate`,\n\nThis param can be combined with paging and sorting.\nExample: `filter=general.name==\"Orchard\"`\n","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerInventorySearchResultsV4"}}}}},"x-required-privileges":["Read Computers"]},"post":{"tags":["computer-inventory"],"summary":"Create Computer Inventory record","description":"Creates Computer Inventory record\n\n> 📋 **Required privilege:** Create Computers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerInventoryCreateRequestV4"}}},"required":true},"responses":{"201":{"description":"Successful response - Computer Inventory record created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}}},"x-required-privileges":["Create Computers"]}},"/v4/computers-inventory-detail/{id}":{"get":{"tags":["computer-inventory"],"summary":"Return all sections of a computer","description":"Return all sections of a computer\n\n> 📋 **Required privilege:** Read Computers","parameters":[{"name":"id","in":"path","description":"instance id of computer record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Details of computer were found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerInventoryV4"}}}},"404":{"description":"Specified computer object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Computers"]},"patch":{"tags":["computer-inventory"],"summary":"Update specific fields on a computer","description":"Update specific fields on a computer, then return the updated computer object.\n\n> 📋 **Required privilege:** Update Computers","parameters":[{"name":"id","in":"path","description":"instance id of computer record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerInventoryUpdateRequest"}}},"required":true},"responses":{"204":{"description":"Details of computer were updated"},"404":{"description":"Specified computer object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Computers"]}},"/v4/computers-inventory/filevault":{"get":{"tags":["computer-inventory"],"summary":"Return paginated FileVault information for all computers","description":"Return paginated FileVault information for all computers\n\n> 📋 **Required privilege:** View Disk Encryption Recovery Key","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerInventoryFileVaultSearchResults"}}}}},"x-required-privileges":["View Disk Encryption Recovery Key"]}},"/v4/computers-inventory/{id}":{"get":{"tags":["computer-inventory"],"summary":"Return General section of a Computer","description":"Return General section of a Computer\n\n> 📋 **Required privilege:** Read Computers","parameters":[{"name":"id","in":"path","description":"instance id of computer record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"section","in":"query","description":"section of computer details, if not specified, General section data is returned. Multiple section parameters are supported, e.g. section=general&amp;section=hardware","required":false,"style":"form","explode":true,"schema":{"type":"array","example":["GENERAL"],"items":{"$ref":"#/components/schemas/ComputerSectionV4"},"default":["GENERAL"]}}],"responses":{"200":{"description":"Details of computer were found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerInventoryV4"}}}},"404":{"description":"Specified computer object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Computers"]},"delete":{"tags":["computer-inventory"],"summary":"Remove specified Computer record","description":"Remove specified Computer record\n\n> 📋 **Required privilege:** Delete Computers","parameters":[{"name":"id","in":"path","description":"instance id of computer record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Computer record successfully removed"},"404":{"description":"Specified computer object id does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Delete Computers"]}},"/v4/computers-inventory/{id}/attachments":{"post":{"tags":["computer-inventory"],"summary":"Upload attachment and assign to computer","description":"Upload attachment and assign to computer\n\n> 📋 **Required privilege:** Update Computers","parameters":[{"name":"id","in":"path","description":"instance id of computer record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"The file to upload","format":"binary"}}}}},"required":true},"responses":{"201":{"description":"Successfully uploaded attachment","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"404":{"description":"Specified computer object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Computers"]}},"/v4/computers-inventory/{id}/attachments/{attachmentId}":{"get":{"tags":["computer-inventory"],"summary":"Download attachment file","description":"Download attachment file\n\n> 📋 **Required privilege:** Read Computers","parameters":[{"name":"id","in":"path","description":"instance id of computer record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"attachmentId","in":"path","description":"instance id of attachment object","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Attachment successfully downloaded","content":{"text/plain":{"schema":{"type":"string","description":"Downloaded binary file, Content-Type will be dynamic, based on a file extension","format":"binary"}}}},"404":{"description":"Specified computer object or attachment does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Computers"]},"delete":{"tags":["computer-inventory"],"summary":"Remove attachment","description":"Remove attachment\n\n> 📋 **Required privilege:** Update Computers","parameters":[{"name":"id","in":"path","description":"instance id of computer record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"attachmentId","in":"path","description":"instance id of attachment object","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Attachment successfully removed"},"404":{"description":"Specified computer object or attachment does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Computers"]}},"/v4/computers-inventory/{id}/erase":{"post":{"tags":["computer-inventory"],"summary":"Erase a computer","description":"Erase a computer\n\n> 📋 **Required privilege:** Send Computer Remote Wipe Command","parameters":[{"name":"id","in":"path","description":"Id of the computer to erase","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Options for eraseDevice command","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EraseDeviceComputerRequest"}}}},"responses":{"200":{"description":"Erase command was queued for this device.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EraseDeviceComputerResponse"}}}},"403":{"description":"Insufficient privileges to perform this action."},"404":{"description":"Computer not found."},"500":{"description":"Failure, unable to queue command.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Send Computer Remote Wipe Command"],"x-action":true}},"/v4/computers-inventory/{id}/filevault":{"get":{"tags":["computer-inventory"],"summary":"Return FileVault information for a specific computer","description":"Return FileVault information for a specific computer\n\n> 📋 **Required privilege:** View Disk Encryption Recovery Key","parameters":[{"name":"id","in":"path","description":"instance id of computer record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"FileVault information for computer was found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerInventoryFileVault"}}}},"404":{"description":"FileVault information for specified computer does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["View Disk Encryption Recovery Key"]}},"/v4/computers-inventory/{id}/remove-mdm-profile":{"post":{"tags":["computer-inventory"],"summary":"Remove a computer's MDM profile","description":"Remove a computer's MDM profile\n\n> 📋 **Required privilege:** Send Computer Unmanage Command","parameters":[{"name":"id","in":"path","description":"Id of the computer to remove the MDM profile from","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Command to remove the MDM profile was queued.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveComputerMdmProfileResponse"}}}},"403":{"description":"Insufficient privileges to perform this action."},"500":{"description":"Failure, unable to queue command.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Send Computer Unmanage Command"],"x-action":true}},"/v4/computers-inventory/{id}/view-device-lock-pin":{"get":{"tags":["computer-inventory"],"summary":"Return a computer's Device Lock PIN","description":"Return a computer's Device Lock PIN\n\n> 📋 **Required privilege:** View Computer Device Lock Pin","parameters":[{"name":"id","in":"path","description":"instance id of computer record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Device Lock PIN","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerInventoryDeviceLockPinResponse"}}}},"404":{"description":"Specified computer object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["View Computer Device Lock Pin"]}},"/v4/computers-inventory/{id}/view-recovery-lock-password":{"get":{"tags":["computer-inventory"],"summary":"Return a Computers Recovery Lock Password","description":"Return a Computers Recovery Lock Password\n\n> 📋 **Required privilege:** View Recovery Lock","parameters":[{"name":"id","in":"path","description":"instance id of computer record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Recovery Lock Password","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerInventoryRecoveryLockPasswordResponse"}}}},"404":{"description":"Specified computer object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["View Recovery Lock"]}},"/v1/computer-inventory-collection-settings":{"get":{"tags":["computer-inventory-collection-settings"],"summary":"Returns computer inventory settings","description":"Returns computer inventory settings\n\n> 📋 **Required privilege:** Read Computer Inventory Collection Settings","responses":{"200":{"description":"Successful response returns the computer inventory settings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerInventoryCollectionSettings"}}}}},"deprecated":true,"x-required-privileges":["Read Computer Inventory Collection Settings"],"x-deprecation-date":"2025-06-30"},"patch":{"tags":["computer-inventory-collection-settings"],"summary":"Update computer inventory settings","description":"Update computer inventory settings\n\n> 📋 **Required privilege:** Update Computer Inventory Collection Settings","requestBody":{"description":"Computer inventory settings to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerInventoryCollectionSettings"}}},"required":true},"responses":{"200":{"description":"Computer inventory settings updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerInventoryCollectionSettings"}}}}},"deprecated":true,"x-required-privileges":["Update Computer Inventory Collection Settings"],"x-deprecation-date":"2025-06-30"}},"/v1/computer-inventory-collection-settings/custom-path":{"post":{"tags":["computer-inventory-collection-settings"],"summary":"Create Computer Inventory Collection Settings Custom Path","description":"Creates a custom search path to use when collecting applications, fonts, and plug-ins.\n\n> 📋 **Required privilege:** Create Custom Paths","requestBody":{"description":"Computer inventory settings to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePath"}}},"required":true},"responses":{"201":{"description":"Custom path created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"400":{"description":"Invalid data response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-required-privileges":["Create Custom Paths"],"x-deprecation-date":"2025-06-30"}},"/v1/computer-inventory-collection-settings/custom-path/{id}":{"delete":{"tags":["computer-inventory-collection-settings"],"summary":"Delete Custom Path from Computer Inventory Collection Settings","description":"Delete Custom Path from Computer Inventory Collection Settings\n\n> 📋 **Required privilege:** Delete Custom Paths","parameters":[{"name":"id","in":"path","description":"id of Custom Path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Custom path deleted"},"404":{"description":"Invalid data response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-required-privileges":["Delete Custom Paths"],"x-deprecation-date":"2025-06-30"}},"/v2/computer-inventory-collection-settings":{"get":{"tags":["computer-inventory-collection-settings"],"summary":"Returns computer inventory settings","description":"Returns computer inventory settings\n\n> 📋 **Required privilege:** Read Computer Inventory Collection Settings","responses":{"200":{"description":"Successful response returns the computer inventory settings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerInventoryCollectionSettingsV2"}}}}},"x-required-privileges":["Read Computer Inventory Collection Settings"]},"patch":{"tags":["computer-inventory-collection-settings"],"summary":"Update computer inventory settings","description":"Update computer inventory settings\n\n> 📋 **Required privilege:** Update Computer Inventory Collection Settings","requestBody":{"description":"Computer inventory settings to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerInventoryCollectionSettingsV2"}}},"required":true},"responses":{"204":{"description":"Computer inventory settings updated"}},"x-required-privileges":["Update Computer Inventory Collection Settings"]}},"/v2/computer-inventory-collection-settings/custom-path":{"post":{"tags":["computer-inventory-collection-settings"],"summary":"Create Computer Inventory Collection Settings Custom Path","description":"Creates a custom search path to use when collecting applications.\n\n> 📋 **Required privilege:** Create Custom Paths","requestBody":{"description":"Computer inventory settings to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePathV2"}}},"required":true},"responses":{"201":{"description":"Custom path created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"400":{"description":"Invalid data response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Create Custom Paths"]}},"/v2/computer-inventory-collection-settings/custom-path/{id}":{"delete":{"tags":["computer-inventory-collection-settings"],"summary":"Delete Custom Path from Computer Inventory Collection Settings","description":"Delete Custom Path from Computer Inventory Collection Settings\n\n> 📋 **Required privilege:** Delete Custom Paths","parameters":[{"name":"id","in":"path","description":"id of Custom Path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Custom path deleted"},"404":{"description":"Invalid data response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Delete Custom Paths"]}},"/v2/computer-prestages/scope":{"get":{"tags":["computer-prestages"],"summary":"Get all device Scope for all Computer Prestages\n","description":"Get all device scope for all computer prestages\n\n> 📋 **Required privilege:** Read Computer PreStage Enrollments","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrestageScopeV2"}}}}},"x-required-privileges":["Read Computer PreStage Enrollments"]}},"/v2/computer-prestages/{id}/scope":{"get":{"tags":["computer-prestages"],"summary":"Get device Scope for a specific Computer Prestage\n","description":"Get device scope for a specific computer prestage\n\n> 📋 **Required privilege:** Read Computer PreStage Enrollments","parameters":[{"name":"id","in":"path","description":"Computer Prestage identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrestageScopeResponseV2"}}}},"404":{"description":"Computer Prestage with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Computer PreStage Enrollments"],"x-action":true},"put":{"tags":["computer-prestages"],"summary":"Replace device Scope for a specific Computer Prestage\n","description":"Replace device scope for a specific computer prestage\n\n> 📋 **Required privilege:** Update Computer PreStage Enrollments","parameters":[{"name":"id","in":"path","description":"Computer Prestage identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Serial Numbers to scope","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrestageScopeUpdate"}}},"required":true},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrestageScopeResponseV2"}}}},"400":{"description":"One or more serial numbers are not valid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Computer Prestage with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"Optimistic Lock Error - The prestage you are trying to update has been updated by another process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Computer PreStage Enrollments"]},"post":{"tags":["computer-prestages"],"summary":"Add device Scope for a specific Computer Prestage\n","description":"Add device scope for a specific computer prestage\n\n> 📋 **Required privilege:** Update Computer PreStage Enrollments","parameters":[{"name":"id","in":"path","description":"Computer Prestage identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Serial Numbers to scope","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrestageScopeUpdate"}}},"required":true},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrestageScopeResponseV2"}}}},"400":{"description":"One or more serial numbers are not valid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Computer Prestage with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"Optimistic Lock Error - The prestage you are trying to update has been updated by another process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Computer PreStage Enrollments"],"x-action":true}},"/v2/computer-prestages/{id}/scope/delete-multiple":{"post":{"tags":["computer-prestages"],"summary":"Remove device Scope for a specific Computer Prestage\n","description":"Remove device scope for a specific computer prestage\n\n> 📋 **Required privilege:** Update Computer PreStage Enrollments","parameters":[{"name":"id","in":"path","description":"Computer Prestage identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Serial Numbers to remove from scope","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrestageScopeUpdate"}}},"required":true},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrestageScopeResponseV2"}}}},"400":{"description":"One or more serial numbers are not valid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Computer Prestage with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"Optimistic Lock Error - The prestage you are trying to update has been updated by another process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Computer PreStage Enrollments"],"x-action":true}},"/v3/computer-prestages":{"get":{"tags":["computer-prestages"],"summary":"Get sorted and paged Computer Prestages\n","description":"Gets sorted and paged computer prestages\n\n> 📋 **Required privilege:** Read Computer PreStage Enrollments","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:desc"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputerPrestageSearchResultsV3"}}}}},"x-required-privileges":["Read Computer PreStage Enrollments"]},"post":{"tags":["computer-prestages"],"summary":"Create a Computer Prestage\n","description":"Create a computer prestage\n\n> 📋 **Required privilege:** Create Computer PreStage Enrollments","requestBody":{"description":"Computer Prestage to create. ids defined in this body will be ignored","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostComputerPrestageV3"}}},"required":true},"responses":{"201":{"description":"Computer Prestage was created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Create Computer PreStage Enrollments"]}},"/v3/computer-prestages/{id}":{"get":{"tags":["computer-prestages"],"summary":"Retrieve a Computer Prestage with the supplied id\n","description":"Retrieves a Computer Prestage with the supplied id\n\n> 📋 **Required privilege:** Read Computer PreStage Enrollments","parameters":[{"name":"id","in":"path","description":"Computer Prestage identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetComputerPrestageV3"}}}},"404":{"description":"Computer Prestage with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Computer PreStage Enrollments"]},"put":{"tags":["computer-prestages"],"summary":"Update a Computer Prestage\n","description":"Updates a Computer Prestage\n\n> 📋 **Required privilege:** Update Computer PreStage Enrollments","parameters":[{"name":"id","in":"path","description":"Computer Prestage identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Computer Prestage to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PutComputerPrestageV3"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetComputerPrestageV3"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Computer Prestage with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"The Computer Prestage was modified by another process. Read the Computer Prestage again for updated changes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Computer PreStage Enrollments"]},"delete":{"tags":["computer-prestages"],"summary":"Delete a Computer Prestage with the supplied id\n","description":"Deletes a Computer Prestage with the supplied id\n\n> 📋 **Required privilege:** Delete Computer PreStage Enrollments","parameters":[{"name":"id","in":"path","description":"Computer Prestage identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Success"}},"x-required-privileges":["Delete Computer PreStage Enrollments"]}},"/preview/computers":{"get":{"tags":["computers-preview"],"summary":"Return a list of Computers\n","description":"Returns a list of computers.\n\n> 📋 **Required privilege:** Read Computers","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/size"},{"$ref":"#/components/parameters/pagesize"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is name:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc","required":false,"style":"form","explode":true,"schema":{"type":"string","default":"name:asc"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputersSearchResults"}}}}},"x-required-privileges":["Read Computers"]}},"/v1/conditional-access/device-compliance-information/computer/{deviceId}":{"get":{"tags":["conditional-access"],"summary":"Get compliance information for a single computer device","description":"Return basic compliance information for the given computer device\n\n> 📋 **Required privilege:** Read Device Compliance Information","parameters":[{"name":"deviceId","in":"path","description":"ID of the device the query pertains","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Array of device compliance information records","content":{"application/json":{"schema":{"type":"array","example":[{"deviceId":"1","applicable":true,"complianceState":"COMPLIANT","complianceVendor":"Vendor A","complianceVendorDeviceInformation":[{"deviceIds":["device-id-1","device-id-2"]}]},{"deviceId":"1","applicable":false,"complianceState":"NON_COMPLIANT","complianceVendor":"Vendor B","complianceVendorDeviceInformation":[{"deviceIds":[]}]}],"items":{"$ref":"#/components/schemas/DeviceComplianceInformation"}}}}}},"x-required-privileges":["Read Device Compliance Information"]}},"/v1/conditional-access/device-compliance-information/mobile/{deviceId}":{"get":{"tags":["conditional-access"],"summary":"Get compliance information for a single mobile device","description":"Return basic compliance information for the given mobile device\n\n> 📋 **Required privilege:** Read Device Compliance Information","parameters":[{"name":"deviceId","in":"path","description":"ID of the device the query pertains","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Array of device compliance information records","content":{"application/json":{"schema":{"type":"array","example":[{"deviceId":"1","applicable":true,"complianceState":"COMPLIANT","complianceVendor":"Vendor A","complianceVendorDeviceInformation":[{"deviceIds":["device-id-1","device-id-2"]}]},{"deviceId":"1","applicable":false,"complianceState":"NON_COMPLIANT","complianceVendor":"Vendor B","complianceVendorDeviceInformation":[{"deviceIds":[]}]}],"items":{"$ref":"#/components/schemas/DeviceComplianceInformation"}}}}}},"x-required-privileges":["Read Device Compliance Information"]}},"/v1/conditional-access/device-compliance/feature-toggle":{"get":{"tags":["conditional-access"],"summary":"Retrieves Status of the Feature Toggle","description":"Retrieves Status of the Feature Toggle\n\n> 📋 **Required privilege:** Read Conditional Access","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedDeviceComplianceFeatureToggle"}}}}},"x-required-privileges":["Read Conditional Access"]}},"/v1/csa/tenant-id":{"get":{"tags":["csa"],"summary":"Returns the CSA tenant ID.","description":"Returns the CSA tenant ID.","responses":{"200":{"description":"CSA tenant ID is returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CsaTenantIdInfo"}}}}},"x-authentication-required":true}},"/v1/csa/token":{"get":{"tags":["csa"],"summary":"Get details regarding the CSA token exchange\n","description":"Get details regarding the CSA token exchange\n\n\n> 📋 **Required privilege:** Read Cloud Services Settings","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CsaToken"}}}},"404":{"description":"CSA token exchange has not been initialized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Cloud Services Settings"]},"delete":{"tags":["csa"],"summary":"Delete the CSA token exchange - This will disable Jamf Pro's ability to authenticate with cloud-hosted services\n","description":"Delete the CSA token exchange - This will disable Jamf Pro's ability to authenticate with cloud-hosted services\n\n\n> 📋 **Required privilege:** Update Cloud Services Settings","responses":{"204":{"description":"CSA Token Exchange successfully deleted"},"404":{"description":"CSA Token Exchange has not been initialized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"CSA manual enablement feature toggle is disabled","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Cloud Services Settings"]}},"/v1/dashboard":{"get":{"tags":["dashboard"],"summary":"Get all the dashboard setup information\n","description":"Get all the dashboard information for widgets and setup tasks\n","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardSetup"}}}},"503":{"description":"Dashboard service is unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorCause"}}}}},"x-authentication-required":true}},"/v1/dashboard/toggle":{"post":{"tags":["dashboard"],"summary":"Add or remove an object to the Jamf Pro dashboard\n","description":"Add or remove dashboard detail by the type of object, and the object's ID. Duplicates will not be added again.\n","requestBody":{"description":"Dashboard object with the associated type and ID with a toggle to add or remove the object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardObject"}}},"required":true},"responses":{"202":{"description":"Object toggled on/off for the Jamf Pro dashboard","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}}},"x-authentication-required":true,"x-action":true}},"/v1/ddm/{clientManagementId}/status-items":{"get":{"tags":["declarative-device-management"],"summary":"Retrieve the Status Items from the latest Status Report for a device","description":"Retrieves the Status Items from the latest Status Report for a device\n\n> 📋 **Required privileges:**\n> - Read Mobile Devices\n> - Read Computers","parameters":[{"name":"clientManagementId","in":"path","description":"client management id of the target device.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusItems"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"The client could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Mobile Devices","Read Computers"]}},"/v1/ddm/{clientManagementId}/status-items/{key}":{"get":{"tags":["declarative-device-management"],"summary":"Retrieve a Status Item from the latest Status Report for a device","description":"Retrieves a Status Item from the latest Status Report for a device\n\n> 📋 **Required privileges:**\n> - Read Mobile Devices\n> - Read Computers","parameters":[{"name":"clientManagementId","in":"path","description":"client management id of the target device.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"key","in":"path","description":"the status item key to retrieve.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusItem"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"The client or specified key could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Mobile Devices","Read Computers"]}},"/v1/ddm/{clientManagementId}/sync":{"post":{"tags":["declarative-device-management"],"summary":"Force a device DDM sync","description":"Force a device to sync by queuing a new DeclarativeManagementCommand\n\n> 📋 **Required privilege:** Send Declarative Management Command","parameters":[{"name":"clientManagementId","in":"path","description":"The client management id of the target device.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"The device was successfully synced."},"403":{"description":"Insufficient privileges to perform this action."},"500":{"description":"Failure, unable to complete sync request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Send Declarative Management Command"],"x-action":true}},"/v1/dss-declarations/{declarationId}":{"get":{"tags":["declarative-device-management"],"summary":"Retrieve an existing declaration","description":"Retrieves a stored declaration based on the provided declaration id\n\n> 📋 **Required privileges:**\n> - Read Mobile Devices\n> - Read Computers","parameters":[{"name":"declarationId","in":"path","description":"Declaration UUID","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"538F90D7-9383-4A2B-B1C8-81E845A9CFD7"}],"responses":{"200":{"description":"The Declaration request was sent successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DssDeclarations"}}}},"403":{"description":"Insufficient privileges to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Existing declaration not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Server Error, unable to complete Declaration request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Mobile Devices","Read Computers"]}},"/v1/departments":{"get":{"tags":["departments"],"summary":"Search for Departments\n","description":"Search for Departments\n\n\n> 📋 **Required privilege:** Read Departments","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter department collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: id, name. Example: name==\"*department*\"","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DepartmentsSearchResults"}}}}},"x-required-privileges":["Read Departments"]},"post":{"tags":["departments"],"summary":"Create department record\n","description":"Create department record\n\n\n> 📋 **Required privilege:** Create Departments","requestBody":{"description":"department object to create. ids defined in this body will be ignored","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Department"}}},"required":true},"responses":{"201":{"description":"Department record was created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}}},"x-required-privileges":["Create Departments"]}},"/v1/departments/delete-multiple":{"post":{"tags":["departments"],"summary":"Deletes all departments by ids passed in body\n","description":"Deletes all departments by ids passed in body\n\n\n> 📋 **Required privilege:** Delete Departments","requestBody":{"description":"ids of departments to be deleted. pass in an array of ids","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ids"}}},"required":true},"responses":{"204":{"description":"All department ids passed in request sucessfully deleted."},"400":{"description":"Request processed.  Returns ids and error codes of any departments unable to be deleted.  Expected error codes: INVALID_ID - id does not exist SYSTEM_EXCEPTION - a system exception occured trying to delete the department.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Delete Departments"],"x-action":true}},"/v1/departments/{id}":{"get":{"tags":["departments"],"summary":"Get specified Department object\n","description":"Gets specified Department object\n\n\n> 📋 **Required privilege:** Read Departments","parameters":[{"name":"id","in":"path","description":"instance id of department record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Details of department were found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Department"}}}},"404":{"description":"Specified department object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Departments"]},"put":{"tags":["departments"],"summary":"Update specified department object\n","description":"Update specified department object\n\n\n> 📋 **Required privilege:** Update Departments","parameters":[{"name":"id","in":"path","description":"instance id of department record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"department object to create. ids defined in this body will be ignored","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Department"}}},"required":true},"responses":{"200":{"description":"Department update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Department"}}}}},"x-required-privileges":["Update Departments"]},"delete":{"tags":["departments"],"summary":"Remove specified department record\n","description":"Removes specified department record\n\n\n> 📋 **Required privilege:** Delete Departments","parameters":[{"name":"id","in":"path","description":"instance id of department record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Department record was deleted"}},"x-required-privileges":["Delete Departments"]}},"/v1/departments/{id}/history":{"get":{"tags":["departments"],"summary":"Get specified Department history object\n","description":"Gets specified Department history object\n\n\n> 📋 **Required privilege:** Read Departments","parameters":[{"name":"id","in":"path","description":"instance id of department history record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["date:desc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Details of department history were found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistorySearchResults"}}}},"404":{"description":"Specified department object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Departments"]},"post":{"tags":["departments"],"summary":"Add specified Department history object notes\n","description":"Adds specified Department history object notes\n\n\n> 📋 **Required privilege:** Update Departments","parameters":[{"name":"id","in":"path","description":"instance id of department history record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"history notes to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistoryNote"}}},"required":true},"responses":{"201":{"description":"Notes of department history were added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"404":{"description":"Specified department object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"Department history can not be saved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Departments"]}},"/v1/device-communication-settings":{"get":{"tags":["device-communication-settings"],"summary":"Retrieves all settings for device communication\n","description":"Retrieves all device communication settings, including automatic renewal of the MDM profile.\n\n\n> 📋 **Required privilege:** Read Automatically Renew MDM Profile Settings","responses":{"200":{"description":"Successful response - Device Communication Settings retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceCommunicationSettings"}}}}},"x-required-privileges":["Read Automatically Renew MDM Profile Settings"]},"put":{"tags":["device-communication-settings"],"summary":"Update device communication settings\n","description":"Update device communication settings\n\n\n> 📋 **Required privilege:** Update Automatically Renew MDM Profile Settings","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceCommunicationSettings"}}},"required":true},"responses":{"200":{"description":"Successful response - Device communication Settings updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceCommunicationSettings"}}}}},"x-required-privileges":["Update Automatically Renew MDM Profile Settings"]}},"/v1/device-communication-settings/history":{"get":{"tags":["device-communication-settings"],"summary":"Get Device Communication settings history\n","description":"Gets Device Communication settings history\n\n\n> 📋 **Required privilege:** Read Automatically Renew MDM Profile Settings","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["date:desc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Details of Device Communication Settings history were found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistorySearchResults"}}}}},"x-required-privileges":["Read Automatically Renew MDM Profile Settings"]},"post":{"tags":["device-communication-settings"],"summary":"Add Device Communication Settings history notes\n","description":"Adds Device Communication Settings history notes\n\n\n> 📋 **Required privilege:** Update Automatically Renew MDM Profile Settings","requestBody":{"description":"history notes to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistoryNote"}}},"required":true},"responses":{"201":{"description":"Notes to Device Communication Settings history were added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistory"}}}},"503":{"description":"Device Communication Settings history can not be saved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Automatically Renew MDM Profile Settings"]}},"/v1/device-enrollments":{"get":{"tags":["device-enrollments"],"summary":"Read all sorted and paged Device Enrollment instances\n","description":"Search for sorted and paged device enrollment instances\n\n> 📋 **Required privilege:** Read Device Enrollment Program Instances","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceEnrollmentInstanceSearchResults"}}}}},"x-required-privileges":["Read Device Enrollment Program Instances"]}},"/v1/device-enrollments/public-key":{"get":{"tags":["device-enrollments"],"summary":"Retrieve the Jamf Pro Device Enrollment public key\n","description":"Retrieve the Jamf Pro device enrollment public key\n\n> 📋 **Required privilege:** Read Device Enrollment Program Instances","responses":{"200":{"description":"Success","content":{"application/x-pem-file":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"Not Found"}},"x-required-privileges":["Read Device Enrollment Program Instances"]}},"/v1/device-enrollments/syncs":{"get":{"tags":["device-enrollments"],"summary":"Get all instance sync states for all Device Enrollment Instances\n","description":"Get all instance sync states for all instances\n\n> 📋 **Required privilege:** Read Device Enrollment Program Instances","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeviceEnrollmentInstanceSyncStatus"}}}}}},"x-required-privileges":["Read Device Enrollment Program Instances"]}},"/v1/device-enrollments/upload-token":{"post":{"tags":["device-enrollments"],"summary":"Create a Device Enrollment Instance with the supplied Token\n","description":"Creates a device enrollment instance with the supplied token.\n\n> 📋 **Required privilege:** Create Device Enrollment Program Instances","requestBody":{"description":"The downloaded token base 64 encoded from the MDM server to be used to create a new Device Enrollment Instance.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceEnrollmentToken"}}},"required":true},"responses":{"201":{"description":"Device Enrollment Instance was created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"500":{"description":"Something went wrong","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Create Device Enrollment Program Instances"],"x-action":true}},"/v1/device-enrollments/{id}":{"get":{"tags":["device-enrollments"],"summary":"Retrieve a Device Enrollment Instance with the supplied id\n","description":"Retrieves a Device Enrollment Instance with the supplied id\n\n> 📋 **Required privilege:** Read Device Enrollment Program Instances","parameters":[{"name":"id","in":"path","description":"Device Enrollment Instance identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceEnrollmentInstance"}}}},"404":{"description":"Device Enrollment Instance with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Device Enrollment Program Instances"]},"put":{"tags":["device-enrollments"],"summary":"Update a Device Enrollment Instance with the supplied id\n","description":"Updates a Device Enrollment Instance with the supplied id\n\n> 📋 **Required privilege:** Update Device Enrollment Program Instances","parameters":[{"name":"id","in":"path","description":"Device Enrollment Instance identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceEnrollmentInstance"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceEnrollmentInstance"}}}},"404":{"description":"Device Enrollment Instance with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Device Enrollment Program Instances"]},"delete":{"tags":["device-enrollments"],"summary":"Delete a Device Enrollment Instance with the supplied id\n","description":"Deletes a Device Enrollment Instance with the supplied id\n\n> 📋 **Required privilege:** Delete Device Enrollment Program Instances","parameters":[{"name":"id","in":"path","description":"Device Enrollment Instance identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Success"},"404":{"description":"Device Enrollment Instance with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Delete Device Enrollment Program Instances"]}},"/v1/device-enrollments/{id}/disown":{"post":{"tags":["device-enrollments"],"summary":"Disown devices from the given Device Enrollment Instance\n","description":"Disowns devices from the given device enrollment instance\n\n> 📋 **Required privilege:** Update Device Enrollment Program Instances","parameters":[{"name":"id","in":"path","description":"Device Enrollment Instance identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"List of device serial numbers to disown","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceEnrollmentDisownBody"}}},"required":false},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceEnrollmentDisownResponse"}}}},"404":{"description":"Could not find device enrollment program instance for given id"},"500":{"description":"Something went wrong."}},"x-required-privileges":["Update Device Enrollment Program Instances"],"x-action":true}},"/v1/device-enrollments/{id}/history":{"get":{"tags":["device-enrollments"],"summary":"Get sorted and paged Device Enrollment history objects\n","description":"Gets sorted and paged device enrollment history objects\n\n> 📋 **Required privilege:** Read Device Enrollment Program Instances","parameters":[{"name":"id","in":"path","description":"Device Enrollment Instance identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property,asc/desc. Default sort order is descending. Multiple sort criteria are supported and must be entered on separate lines in Swagger UI. In the URI the 'sort' query param is duplicated for each sort criterion, e.g., ...&sort=name%2Casc&sort=date%2Cdesc","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["date:desc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter history notes collection. Default search is empty query - returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: search=username!=admin and details==*disabled* and date<2019-12-15","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Details of device enrollment history were found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistorySearchResults"}}}}},"x-required-privileges":["Read Device Enrollment Program Instances"]},"post":{"tags":["device-enrollments"],"summary":"Add Device Enrollment history object notes\n","description":"Adds device enrollment history object notes\n\n> 📋 **Required privilege:** Update Device Enrollment Program Instances","parameters":[{"name":"id","in":"path","description":"Device Enrollment Instance identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"History notes to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistoryNote"}}},"required":true},"responses":{"201":{"description":"Notes of device enrollment history were added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"503":{"description":"Device enrollment history can not be saved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Device Enrollment Program Instances"]}},"/v1/device-enrollments/{id}/syncs":{"get":{"tags":["device-enrollments"],"summary":"Get all instance sync states for a single Device Enrollment Instance\n","description":"Get all instance sync states for a single instance\n\n> 📋 **Required privilege:** Read Device Enrollment Program Instances","parameters":[{"name":"id","in":"path","description":"Device Enrollment Instance identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeviceEnrollmentInstanceSyncStatus"}}}}}},"x-required-privileges":["Read Device Enrollment Program Instances"]}},"/v1/device-enrollments/{id}/syncs/latest":{"get":{"tags":["device-enrollments"],"summary":"Get the latest sync state for a single Device Enrollment Instance\n","description":"Get the latest sync state for a single instance\n\n> 📋 **Required privilege:** Read Device Enrollment Program Instances","parameters":[{"name":"id","in":"path","description":"Device Enrollment Instance identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceEnrollmentInstanceSyncStatus"}}}}},"x-required-privileges":["Read Device Enrollment Program Instances"]}},"/v1/device-enrollments/{id}/upload-token":{"put":{"tags":["device-enrollments"],"summary":"Update a Device Enrollment Instance with the supplied Token\n","description":"Updates a device enrollment instance with the supplied token.\n\n> 📋 **Required privilege:** Update Device Enrollment Program Instances","parameters":[{"name":"id","in":"path","description":"Device Enrollment Instance identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"The downloaded token base 64 encoded from the MDM server to be used to create a new Device Enrollment Instance.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceEnrollmentToken"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceEnrollmentInstance"}}}},"404":{"description":"Device Enrollment Instance with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Something went wrong","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Device Enrollment Program Instances"],"x-action":true}},"/v1/device-enrollments/{id}/devices":{"get":{"tags":["device-enrollments-devices"],"summary":"Retrieve a list of Devices assigned to the supplied id\n","description":"Retrieves a list of devices assigned to the supplied id\n\n> 📋 **Required privilege:** Read Device Enrollment Program Instances","parameters":[{"name":"id","in":"path","description":"Device Enrollment Instance identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceEnrollmentDeviceSearchResults"}}}}},"x-required-privileges":["Read Device Enrollment Program Instances"]}},"/v1/devices/{id}/groups":{"get":{"tags":["devices"],"summary":"Return a list of groups for a device\n","description":"Returns a list of groups that the specified device belongs to.\n\n> 📋 **Required privileges:**\n> - Read Computers\n> - Read Mobile Devices","parameters":[{"name":"id","in":"path","description":"Device Platform ID","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"699bc5b1-efb7-431a-b18f-b2ec5c435631"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeviceGroup"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Specified device object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Computers","Read Mobile Devices"]}},"/v1/pki/digicert/trust-lifecycle-manager":{"post":{"tags":["digicert"],"summary":"Create DigiCert Trust Lifecycle Manager configuration with client authentication via client certificate.\n","description":"Create DigiCert Trust Lifecycle Manager configuration and initialize renewal monitor.\n\n> 📋 **Required privilege:** Create DigiCert Settings","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DigiCertSetting"},"examples":{"sample1":{"value":{"caName":"Example Display Name - 1","fqdn":"digicert.example.com","revocationEnabled":true,"clientCert":{"filename":"client-cert.p12","data":"MIINvwIBAzCCDXsGCSqGSIb3DQEHAaCCDWwEgg1oMIINZDCCBg8GCSqGSIb3DQEHAaCCBgAEggX8MIIF+DCCBfQGCyqGSIb3DQEMCgECoIIE/jCCBPowHAYKKoZIhvcNAQwBAzAOBAhIPjJB7Ls2fAICB9AEggTY3EKQVRtYWdwsisoMtXWIYJXvLTLm3WtBULqFdkVIXiMg0Y6cKtMdYHoLKEhyZwcsFxiUSfM4QkGpo4woshiwjFBEwc7Iu3waIGe5CVmAsZ9ynvqBirCfelmt5mLn6iU+AjR/xcYqwV2MJNO+lo8K3gVGDHvE0caJQB2blFioW7QOsGb+8GWpNNdWkbTHB6zH3XRB1lVm+9rsr1BF1l3lzEQOlc4P1nBtNumf2TVBoU6cM4lgiWA0as896nUilj1w9AAXiQcdhIT4zaaJFP4AnXqL94bDDlfceA60HNpzCYRIGOhohnxBtquUoDw6uHBnmo6PMkB2KkYNVoxk+/+egF3arCdjbj4OkWhZ/wzNGa0uHTA6nG8bNWRXULWZ/QfvQi424vKfuLSGQty1AP0VHOeoY4SkWvDz+gCEfP29C8vk4kWcnl/0dsE1wmmowuydJvL6WhGRAPii1y/BOJW0FTXav03o7SP5aYZXnr8qLKKUkmSziV1toY7YFl7lUCKYj5j/1I+5uaGlEqbjEsQs6GwL6S9M6ggpbGSBT4fp4xH1FSXeRoWbbVKuB3+Sin8lwP4ZrSTarufWpYCnnLNfYgTFiatpbP9u9BS4PaBVZTFygyvl4Gj4QtVMtZy39tRqiN82RkG61DiTeLFI0xXGqMctQLpOHU8Rn07tBZBKWI6U5wc2nDKWr60ohQPVEglt5MEqYgPuPcoUvj2GOG536pHR6HeWiX3nszv3KCNxOog8hkvs1JKoJuByhgzeUR6ylHTBOq+jNrbTJvzWGXEK6+I5rUmViITmMksumg96kUgP2ZPYzGbaJLt0lE1zD+rI05EWroZh4GQpcwfX8PQkbadR10MXbhnPe039TwhbgtDecxgNZQd0Fs4WTZqzpZOkUpcvWxHmPm1iSCd860EvNKwJos4kAlgE2tMtPpAiNqhxOzzgMiSFdxOnTV3khJ2xTL4J8UsObbn2K6qp9EhXcUUl+0Xn7C8+T4PIYkW4G5LNkIjv/3Df7VGjaTwk0rJtFwJh8k09BPA4ETNaxC/C7JFwkW9eJYtYi/UxStMSrVj1HGmnsG036C+IYDjKeUWvNK7QV2mq+Pas5WncgRU8BwgU5D2fLffRjtnP1UnnTkHsk9wocUqIaEpylIDnmUzA6mgM/4vfibF2BHDgkLjo5w2kgSjoSsRp7z23RudESgIyax21aWtmBZvDLTCn7KXGwXPELxLoU3lvOow7G8XTwAymaV/ymn6aQDp9tEwMHL0slRc3okRtAkHvhwUWpy7wXHup/aGhciA0fpkZhU1UECxGybhjPANsBzB9gUoBo2QWmKI7pjAovDWTbqHMylEi0Xumj+FxJgrdSHm9IbkX92ShJKLoD/flGfMS9pNVaqoCSsa66lPSCNqnDEF85/rr1vDBwDHSPChZri7748VWXxNzoCnbp2wYlRTUn8DOvuMDdO5W/tWnxmHgaiOxOKgoiRsl0Rm2N9E9sse5VLkXnQG4/Ybgzdq9xsxB9RdL5pnXsvBjCc+ruH3/XW4ufEq10PvdruBSz7jFqMfXJZ0APqNcRAm6UVsLSIqYbDuaDXMIJATUzy+EGVLdUcLfcMpWWxXgtUr+mJLvWTTlHTdoF57mJoY0XiFe2lz/xsumI0CgA2z0AyUmvDGB4jANBgkrBgEEAYI3EQIxADATBgkqhkiG9w0BCRUxBgQEAQAAADBdBgkqhkiG9w0BCRQxUB5OAHQAZQAtADEANgAxADMANgAxADQANAAtADYAMQA4ADQALQA0ADYAYwAwAC0AOAA3ADIAMgAtAGEAZQBmADgAMgBkADkANABmAGUAZgBkMF0GCSsGAQQBgjcRATFQHk4ATQBpAGMAcgBvAHMAbwBmAHQAIABTAG8AZgB0AHcAYQByAGUAIABLAGUAeQAgAFMAdABvAHIAYQBnAGUAIABQAHIAbwB2AGkAZABlAHIwggdNBgkqhkiG9w0BBwGgggc+BIIHOjCCBzYwggODBgsqhkiG9w0BDAoBA6CCA3AwggNsBgoqhkiG9w0BCRYBoIIDXASCA1gwggNUMIICPKADAgECAhBQpWSN5vK+pExY7iCTjMhhMA0GCSqGSIb3DQEBCwUAMCgxJjAkBgNVBAMMHWt0bnN2bS13aW4yMDE2LmVuemlhbnRlY2guY29tMB4XDTIyMDMxNTEyMjAwM1oXDTMyMDMxNTEyMjk1OFowKDEmMCQGA1UEAwwda3Ruc3ZtLXdpbjIwMTYuZW56aWFudGVjaC5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCh2WEjlnlY37yMtBhNY/2q/Mgx7hSJMpb9sK4HY/RufB0olyVwA4sKG0+ER9wnC+brkT8CDamnzeC+x5OynZ8QaP7m0tQSLCJrfJ9EapUSgD/TZv7Y+qXnVhI5sSpKXMt0g8SCQEzvS5dsLylw6VENlhvEUSFlfjcZbrCsHQgqEahaPlxz2MG35UUkBSwarTK243wtDvSXiBhmAeWQvNDJqpUlLxKNmvAWSzjfpOdEM+iRHf3Nph2wqSSOS61XUJ55fC0UIAMjzGlEYpJrd73PJTyly5ZQGErDwgyLW/Qti65jgRLg8cMNDqBSTwQwo00SvM54EFOmrQP9nq/SrlkXAgMBAAGjejB4MA4GA1UdDwEB/wQEAwIBtjAdBgNVHSUEFjAUBggrBgEFBQcDAgYIKwYBBQUHAwEwKAYDVR0RBCEwH4Ida3Ruc3ZtLXdpbjIwMTYuZW56aWFudGVjaC5jb20wHQYDVR0OBBYEFD6G+I03qqd9Rd1UCSMy8WxzthG7MA0GCSqGSIb3DQEBCwUAA4IBAQBN5NrClbxY4AdOVSbD319s9ApGwzhA7VH2r73Qi07UtQslLUWHjN6D78ZU/rlqYRsF4yOI3Zxcp7KV9rfOVigJPNUPU9wQe0aPnPUy4qEGd0HJpXmmj8t17l/+gtV6I0Vs0de+OY1PkjfcvFLMOfjAzbG2VxPCm0kL1Jd86b60t/iiaE2l0fxn7UfVetpRZLNZV1X9fwB+raUqN2ILhsS7bFwj3PDpzMw/9qLj/hiE6+9QksSpDhkIJDjU48GiGtkidRoATK+paO0xso3nPLNi5s+CY5NprFeqizymTzOX8DJcjtINTU2CL41k7G0r/stv1YgBQDB7Rwg6bxyTfN68MQAwggOrBgsqhkiG9w0BDAoBA6CCA4MwggN/BgoqhkiG9w0BCRYBoIIDbwSCA2swggNnMIICT6ADAgECAhAaVZcv8KdtjUbjDGvLd3toMA0GCSqGSIb3DQEBCwUAMCgxJjAkBgNVBAMMHWt0bnN2bS13aW4yMDE2LmVuemlhbnRlY2guY29tMB4XDTIyMDMxNTEyMjAwM1oXDTMyMDMxNTEyMzAwM1owIDEeMBwGA1UEAwwVaDY4aGNnLnF1aWNrLmphbWYubmV0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAvBD1C4tR8vWZeSDdQ6AhynzMB47plvkqrXnmhcavlsDnu8Zfanr6gjUND0NK2Ufm0BBhH86kIcYMwehLYVNNfC3RTCT+QLo3wIn7VxUnsAPTqD23QjNwYnDTBQDkBrQIrFYaPc0RxO0MYexg/EqgEiAF1nJAZ3tndev1LBSEO5iN+8patoyV7jE3JlgF9qN0T0XCELrRpEi/pxKaVpAupXp38NBWVAJ6yqWuTCP2gcvnvo8KHHUTpJhwUcxr1aKUjX0LBnJ/mStQ8Cfckr7sLaHXyt4ei5uiQID69d/6JNoqpfoWW0EcHW8V3fiLX5fzsMBGjmRa/R8//zVM/ebpSwIDAQABo4GUMIGRMA4GA1UdDwEB/wQEAwIEsDAdBgNVHSUEFjAUBggrBgEFBQcDAgYIKwYBBQUHAwEwIAYDVR0RBBkwF4IVaDY4aGNnLnF1aWNrLmphbWYubmV0MB8GA1UdIwQYMBaAFD6G+I03qqd9Rd1UCSMy8WxzthG7MB0GA1UdDgQWBBT1Gk6lWWBdrF1z7n/FMgxT5Hb5YjANBgkqhkiG9w0BAQsFAAOCAQEAj0UtZ118booksRr7kDg47IhlhSlkhZVnZfkRUHY2QSYBkHNyilcb9rWJIAzrSI5q+RV+FDXDEc0at9CmH2yIb+dYSojxj1ebSCloZb5QiHfAZTFN5+AicESWb0PMGiiz1HeU8Bm2bjHIRx4OLKSm4agMck/6iBDJhduiidrEZkmz8MRFr04GE/9MAg3JG149JeCSS54seKx7tBx+dJjzHJg2HeqZtOKjaKLOnstquEVhwgGXIqH51lQd5SOfYJH1cQyi6xe7SBZ5YYYF1iubhMUqvYnbugskm35nYWk9XObw4QRnfTQNIuW6p1cz2Nk+yaDheraycaxbBGYaXMgIJzEVMBMGCSqGSIb3DQEJFTEGBAQBAAAAMDswHzAHBgUrDgMCGgQUA/Hryi7gjlbKpKpGVlTvAnjevyAEFFhGKjlcFPkz5+bUOnz1OcWq/3zPAgIH0A==","password":"password-example"}}}}}},"required":true},"responses":{"201":{"description":"Created","content":{"*/*":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}}},"x-required-privileges":["Create DigiCert Settings"]}},"/v1/pki/digicert/trust-lifecycle-manager/validate-client-certificate":{"post":{"tags":["digicert"],"summary":"Validate DigiCert Trust Lifecycle Manager client certificate\n","description":"Validate DigiCert Trust Lifecycle Manager client certificate for file format and correct password. Must be base64-encoded PKCS#12 file content, obtainable by `openssl base64 < /file/path/filename.p12 | tr -d '\\n' | pbcopy` in linux terminal, or similar parsing methods.\n\n> 📋 **Required privileges:**\n> - Create DigiCert Settings\n> - Update DigiCert Settings","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Certificate"},"examples":{"sample1":{"value":{"filename":"client-cert.p12","data":"MIINvwIBAzCCDXsGCSqGSIb3DQEHAaCCDWwEgg1oMIINZDCCBg8GCSqGSIb3DQEHAaCCBgAEggX8MIIF+DCCBfQGCyqGSIb3DQEMCgECoIIE/jCCBPowHAYKKoZIhvcNAQwBAzAOBAhIPjJB7Ls2fAICB9AEggTY3EKQVRtYWdwsisoMtXWIYJXvLTLm3WtBULqFdkVIXiMg0Y6cKtMdYHoLKEhyZwcsFxiUSfM4QkGpo4woshiwjFBEwc7Iu3waIGe5CVmAsZ9ynvqBirCfelmt5mLn6iU+AjR/xcYqwV2MJNO+lo8K3gVGDHvE0caJQB2blFioW7QOsGb+8GWpNNdWkbTHB6zH3XRB1lVm+9rsr1BF1l3lzEQOlc4P1nBtNumf2TVBoU6cM4lgiWA0as896nUilj1w9AAXiQcdhIT4zaaJFP4AnXqL94bDDlfceA60HNpzCYRIGOhohnxBtquUoDw6uHBnmo6PMkB2KkYNVoxk+/+egF3arCdjbj4OkWhZ/wzNGa0uHTA6nG8bNWRXULWZ/QfvQi424vKfuLSGQty1AP0VHOeoY4SkWvDz+gCEfP29C8vk4kWcnl/0dsE1wmmowuydJvL6WhGRAPii1y/BOJW0FTXav03o7SP5aYZXnr8qLKKUkmSziV1toY7YFl7lUCKYj5j/1I+5uaGlEqbjEsQs6GwL6S9M6ggpbGSBT4fp4xH1FSXeRoWbbVKuB3+Sin8lwP4ZrSTarufWpYCnnLNfYgTFiatpbP9u9BS4PaBVZTFygyvl4Gj4QtVMtZy39tRqiN82RkG61DiTeLFI0xXGqMctQLpOHU8Rn07tBZBKWI6U5wc2nDKWr60ohQPVEglt5MEqYgPuPcoUvj2GOG536pHR6HeWiX3nszv3KCNxOog8hkvs1JKoJuByhgzeUR6ylHTBOq+jNrbTJvzWGXEK6+I5rUmViITmMksumg96kUgP2ZPYzGbaJLt0lE1zD+rI05EWroZh4GQpcwfX8PQkbadR10MXbhnPe039TwhbgtDecxgNZQd0Fs4WTZqzpZOkUpcvWxHmPm1iSCd860EvNKwJos4kAlgE2tMtPpAiNqhxOzzgMiSFdxOnTV3khJ2xTL4J8UsObbn2K6qp9EhXcUUl+0Xn7C8+T4PIYkW4G5LNkIjv/3Df7VGjaTwk0rJtFwJh8k09BPA4ETNaxC/C7JFwkW9eJYtYi/UxStMSrVj1HGmnsG036C+IYDjKeUWvNK7QV2mq+Pas5WncgRU8BwgU5D2fLffRjtnP1UnnTkHsk9wocUqIaEpylIDnmUzA6mgM/4vfibF2BHDgkLjo5w2kgSjoSsRp7z23RudESgIyax21aWtmBZvDLTCn7KXGwXPELxLoU3lvOow7G8XTwAymaV/ymn6aQDp9tEwMHL0slRc3okRtAkHvhwUWpy7wXHup/aGhciA0fpkZhU1UECxGybhjPANsBzB9gUoBo2QWmKI7pjAovDWTbqHMylEi0Xumj+FxJgrdSHm9IbkX92ShJKLoD/flGfMS9pNVaqoCSsa66lPSCNqnDEF85/rr1vDBwDHSPChZri7748VWXxNzoCnbp2wYlRTUn8DOvuMDdO5W/tWnxmHgaiOxOKgoiRsl0Rm2N9E9sse5VLkXnQG4/Ybgzdq9xsxB9RdL5pnXsvBjCc+ruH3/XW4ufEq10PvdruBSz7jFqMfXJZ0APqNcRAm6UVsLSIqYbDuaDXMIJATUzy+EGVLdUcLfcMpWWxXgtUr+mJLvWTTlHTdoF57mJoY0XiFe2lz/xsumI0CgA2z0AyUmvDGB4jANBgkrBgEEAYI3EQIxADATBgkqhkiG9w0BCRUxBgQEAQAAADBdBgkqhkiG9w0BCRQxUB5OAHQAZQAtADEANgAxADMANgAxADQANAAtADYAMQA4ADQALQA0ADYAYwAwAC0AOAA3ADIAMgAtAGEAZQBmADgAMgBkADkANABmAGUAZgBkMF0GCSsGAQQBgjcRATFQHk4ATQBpAGMAcgBvAHMAbwBmAHQAIABTAG8AZgB0AHcAYQByAGUAIABLAGUAeQAgAFMAdABvAHIAYQBnAGUAIABQAHIAbwB2AGkAZABlAHIwggdNBgkqhkiG9w0BBwGgggc+BIIHOjCCBzYwggODBgsqhkiG9w0BDAoBA6CCA3AwggNsBgoqhkiG9w0BCRYBoIIDXASCA1gwggNUMIICPKADAgECAhBQpWSN5vK+pExY7iCTjMhhMA0GCSqGSIb3DQEBCwUAMCgxJjAkBgNVBAMMHWt0bnN2bS13aW4yMDE2LmVuemlhbnRlY2guY29tMB4XDTIyMDMxNTEyMjAwM1oXDTMyMDMxNTEyMjk1OFowKDEmMCQGA1UEAwwda3Ruc3ZtLXdpbjIwMTYuZW56aWFudGVjaC5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCh2WEjlnlY37yMtBhNY/2q/Mgx7hSJMpb9sK4HY/RufB0olyVwA4sKG0+ER9wnC+brkT8CDamnzeC+x5OynZ8QaP7m0tQSLCJrfJ9EapUSgD/TZv7Y+qXnVhI5sSpKXMt0g8SCQEzvS5dsLylw6VENlhvEUSFlfjcZbrCsHQgqEahaPlxz2MG35UUkBSwarTK243wtDvSXiBhmAeWQvNDJqpUlLxKNmvAWSzjfpOdEM+iRHf3Nph2wqSSOS61XUJ55fC0UIAMjzGlEYpJrd73PJTyly5ZQGErDwgyLW/Qti65jgRLg8cMNDqBSTwQwo00SvM54EFOmrQP9nq/SrlkXAgMBAAGjejB4MA4GA1UdDwEB/wQEAwIBtjAdBgNVHSUEFjAUBggrBgEFBQcDAgYIKwYBBQUHAwEwKAYDVR0RBCEwH4Ida3Ruc3ZtLXdpbjIwMTYuZW56aWFudGVjaC5jb20wHQYDVR0OBBYEFD6G+I03qqd9Rd1UCSMy8WxzthG7MA0GCSqGSIb3DQEBCwUAA4IBAQBN5NrClbxY4AdOVSbD319s9ApGwzhA7VH2r73Qi07UtQslLUWHjN6D78ZU/rlqYRsF4yOI3Zxcp7KV9rfOVigJPNUPU9wQe0aPnPUy4qEGd0HJpXmmj8t17l/+gtV6I0Vs0de+OY1PkjfcvFLMOfjAzbG2VxPCm0kL1Jd86b60t/iiaE2l0fxn7UfVetpRZLNZV1X9fwB+raUqN2ILhsS7bFwj3PDpzMw/9qLj/hiE6+9QksSpDhkIJDjU48GiGtkidRoATK+paO0xso3nPLNi5s+CY5NprFeqizymTzOX8DJcjtINTU2CL41k7G0r/stv1YgBQDB7Rwg6bxyTfN68MQAwggOrBgsqhkiG9w0BDAoBA6CCA4MwggN/BgoqhkiG9w0BCRYBoIIDbwSCA2swggNnMIICT6ADAgECAhAaVZcv8KdtjUbjDGvLd3toMA0GCSqGSIb3DQEBCwUAMCgxJjAkBgNVBAMMHWt0bnN2bS13aW4yMDE2LmVuemlhbnRlY2guY29tMB4XDTIyMDMxNTEyMjAwM1oXDTMyMDMxNTEyMzAwM1owIDEeMBwGA1UEAwwVaDY4aGNnLnF1aWNrLmphbWYubmV0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAvBD1C4tR8vWZeSDdQ6AhynzMB47plvkqrXnmhcavlsDnu8Zfanr6gjUND0NK2Ufm0BBhH86kIcYMwehLYVNNfC3RTCT+QLo3wIn7VxUnsAPTqD23QjNwYnDTBQDkBrQIrFYaPc0RxO0MYexg/EqgEiAF1nJAZ3tndev1LBSEO5iN+8patoyV7jE3JlgF9qN0T0XCELrRpEi/pxKaVpAupXp38NBWVAJ6yqWuTCP2gcvnvo8KHHUTpJhwUcxr1aKUjX0LBnJ/mStQ8Cfckr7sLaHXyt4ei5uiQID69d/6JNoqpfoWW0EcHW8V3fiLX5fzsMBGjmRa/R8//zVM/ebpSwIDAQABo4GUMIGRMA4GA1UdDwEB/wQEAwIEsDAdBgNVHSUEFjAUBggrBgEFBQcDAgYIKwYBBQUHAwEwIAYDVR0RBBkwF4IVaDY4aGNnLnF1aWNrLmphbWYubmV0MB8GA1UdIwQYMBaAFD6G+I03qqd9Rd1UCSMy8WxzthG7MB0GA1UdDgQWBBT1Gk6lWWBdrF1z7n/FMgxT5Hb5YjANBgkqhkiG9w0BAQsFAAOCAQEAj0UtZ118booksRr7kDg47IhlhSlkhZVnZfkRUHY2QSYBkHNyilcb9rWJIAzrSI5q+RV+FDXDEc0at9CmH2yIb+dYSojxj1ebSCloZb5QiHfAZTFN5+AicESWb0PMGiiz1HeU8Bm2bjHIRx4OLKSm4agMck/6iBDJhduiidrEZkmz8MRFr04GE/9MAg3JG149JeCSS54seKx7tBx+dJjzHJg2HeqZtOKjaKLOnstquEVhwgGXIqH51lQd5SOfYJH1cQyi6xe7SBZ5YYYF1iubhMUqvYnbugskm35nYWk9XObw4QRnfTQNIuW6p1cz2Nk+yaDheraycaxbBGYaXMgIJzEVMBMGCSqGSIb3DQEJFTEGBAQBAAAAMDswHzAHBgUrDgMCGgQUA/Hryi7gjlbKpKpGVlTvAnjevyAEFFhGKjlcFPkz5+bUOnz1OcWq/3zPAgIH0A==","password":"password-example"}},"sample2":{"value":{"filename":"client-cert.p12","data":"MIINvwIBAzCCDXsGCSqGSIb3DQEHAaCCDWwEgg1oMIINZDCCBg8GCSqGSIb3DQEHAaCCBgAEggX8MIIF+DCCBfQGCyqGSIb3DQEMCgECoIIE/jCCBPowHAYKKoZIhvcNAQwBAzAOBAhIPjJB7Ls2fAICB9AEggTY3EKQVRtYWdwsisoMtXWIYJXvLTLm3WtBULqFdkVIXiMg0Y6cKtMdYHoLKEhyZwcsFxiUSfM4QkGpo4woshiwjFBEwc7Iu3waIGe5CVmAsZ9ynvqBirCfelmt5mLn6iU+AjR/xcYqwV2MJNO+lo8K3gVGDHvE0caJQB2blFioW7QOsGb+8GWpNNdWkbTHB6zH3XRB1lVm+9rsr1BF1l3lzEQOlc4P1nBtNumf2TVBoU6cM4lgiWA0as896nUilj1w9AAXiQcdhIT4zaaJFP4AnXqL94bDDlfceA60HNpzCYRIGOhohnxBtquUoDw6uHBnmo6PMkB2KkYNVoxk+/+egF3arCdjbj4OkWhZ/wzNGa0uHTA6nG8bNWRXULWZ/QfvQi424vKfuLSGQty1AP0VHOeoY4SkWvDz+gCEfP29C8vk4kWcnl/0dsE1wmmowuydJvL6WhGRAPii1y/BOJW0FTXav03o7SP5aYZXnr8qLKKUkmSziV1toY7YFl7lUCKYj5j/1I+5uaGlEqbjEsQs6GwL6S9M6ggpbGSBT4fp4xH1FSXeRoWbbVKuB3+Sin8lwP4ZrSTarufWpYCnnLNfYgTFiatpbP9u9BS4PaBVZTFygyvl4Gj4QtVMtZy39tRqiN82RkG61DiTeLFI0xXGqMctQLpOHU8Rn07tBZBKWI6U5wc2nDKWr60ohQPVEglt5MEqYgPuPcoUvj2GOG536pHR6HeWiX3nszv3KCNxOog8hkvs1JKoJuByhgzeUR6ylHTBOq+jNrbTJvzWGXEK6+I5rUmViITmMksumg96kUgP2ZPYzGbaJLt0lE1zD+rI05EWroZh4GQpcwfX8PQkbadR10MXbhnPe039TwhbgtDecxgNZQd0Fs4WTZqzpZOkUpcvWxHmPm1iSCd860EvNKwJos4kAlgE2tMtPpAiNqhxOzzgMiSFdxOnTV3khJ2xTL4J8UsObbn2K6qp9EhXcUUl+0Xn7C8+T4PIYkW4G5LNkIjv/3Df7VGjaTwk0rJtFwJh8k09BPA4ETNaxC/C7JFwkW9eJYtYi/UxStMSrVj1HGmnsG036C+IYDjKeUWvNK7QV2mq+Pas5WncgRU8BwgU5D2fLffRjtnP1UnnTkHsk9wocUqIaEpylIDnmUzA6mgM/4vfibF2BHDgkLjo5w2kgSjoSsRp7z23RudESgIyax21aWtmBZvDLTCn7KXGwXPELxLoU3lvOow7G8XTwAymaV/ymn6aQDp9tEwMHL0slRc3okRtAkHvhwUWpy7wXHup/aGhciA0fpkZhU1UECxGybhjPANsBzB9gUoBo2QWmKI7pjAovDWTbqHMylEi0Xumj+FxJgrdSHm9IbkX92ShJKLoD/flGfMS9pNVaqoCSsa66lPSCNqnDEF85/rr1vDBwDHSPChZri7748VWXxNzoCnbp2wYlRTUn8DOvuMDdO5W/tWnxmHgaiOxOKgoiRsl0Rm2N9E9sse5VLkXnQG4/Ybgzdq9xsxB9RdL5pnXsvBjCc+ruH3/XW4ufEq10PvdruBSz7jFqMfXJZ0APqNcRAm6UVsLSIqYbDuaDXMIJATUzy+EGVLdUcLfcMpWWxXgtUr+mJLvWTTlHTdoF57mJoY0XiFe2lz/xsumI0CgA2z0AyUmvDGB4jANBgkrBgEEAYI3EQIxADATBgkqhkiG9w0BCRUxBgQEAQAAADBdBgkqhkiG9w0BCRQxUB5OAHQAZQAtADEANgAxADMANgAxADQANAAtADYAMQA4ADQALQA0ADYAYwAwAC0AOAA3ADIAMgAtAGEAZQBmADgAMgBkADkANABmAGUAZgBkMF0GCSsGAQQBgjcRATFQHk4ATQBpAGMAcgBvAHMAbwBmAHQAIABTAG8AZgB0AHcAYQByAGUAIABLAGUAeQAgAFMAdABvAHIAYQBnAGUAIABQAHIAbwB2AGkAZABlAHIwggdNBgkqhkiG9w0BBwGgggc+BIIHOjCCBzYwggODBgsqhkiG9w0BDAoBA6CCA3AwggNsBgoqhkiG9w0BCRYBoIIDXASCA1gwggNUMIICPKADAgECAhBQpWSN5vK+pExY7iCTjMhhMA0GCSqGSIb3DQEBCwUAMCgxJjAkBgNVBAMMHWt0bnN2bS13aW4yMDE2LmVuemlhbnRlY2guY29tMB4XDTIyMDMxNTEyMjAwM1oXDTMyMDMxNTEyMjk1OFowKDEmMCQGA1UEAwwda3Ruc3ZtLXdpbjIwMTYuZW56aWFudGVjaC5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCh2WEjlnlY37yMtBhNY/2q/Mgx7hSJMpb9sK4HY/RufB0olyVwA4sKG0+ER9wnC+brkT8CDamnzeC+x5OynZ8QaP7m0tQSLCJrfJ9EapUSgD/TZv7Y+qXnVhI5sSpKXMt0g8SCQEzvS5dsLylw6VENlhvEUSFlfjcZbrCsHQgqEahaPlxz2MG35UUkBSwarTK243wtDvSXiBhmAeWQvNDJqpUlLxKNmvAWSzjfpOdEM+iRHf3Nph2wqSSOS61XUJ55fC0UIAMjzGlEYpJrd73PJTyly5ZQGErDwgyLW/Qti65jgRLg8cMNDqBSTwQwo00SvM54EFOmrQP9nq/SrlkXAgMBAAGjejB4MA4GA1UdDwEB/wQEAwIBtjAdBgNVHSUEFjAUBggrBgEFBQcDAgYIKwYBBQUHAwEwKAYDVR0RBCEwH4Ida3Ruc3ZtLXdpbjIwMTYuZW56aWFudGVjaC5jb20wHQYDVR0OBBYEFD6G+I03qqd9Rd1UCSMy8WxzthG7MA0GCSqGSIb3DQEBCwUAA4IBAQBN5NrClbxY4AdOVSbD319s9ApGwzhA7VH2r73Qi07UtQslLUWHjN6D78ZU/rlqYRsF4yOI3Zxcp7KV9rfOVigJPNUPU9wQe0aPnPUy4qEGd0HJpXmmj8t17l/+gtV6I0Vs0de+OY1PkjfcvFLMOfjAzbG2VxPCm0kL1Jd86b60t/iiaE2l0fxn7UfVetpRZLNZV1X9fwB+raUqN2ILhsS7bFwj3PDpzMw/9qLj/hiE6+9QksSpDhkIJDjU48GiGtkidRoATK+paO0xso3nPLNi5s+CY5NprFeqizymTzOX8DJcjtINTU2CL41k7G0r/stv1YgBQDB7Rwg6bxyTfN68MQAwggOrBgsqhkiG9w0BDAoBA6CCA4MwggN/BgoqhkiG9w0BCRYBoIIDbwSCA2swggNnMIICT6ADAgECAhAaVZcv8KdtjUbjDGvLd3toMA0GCSqGSIb3DQEBCwUAMCgxJjAkBgNVBAMMHWt0bnN2bS13aW4yMDE2LmVuemlhbnRlY2guY29tMB4XDTIyMDMxNTEyMjAwM1oXDTMyMDMxNTEyMzAwM1owIDEeMBwGA1UEAwwVaDY4aGNnLnF1aWNrLmphbWYubmV0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAvBD1C4tR8vWZeSDdQ6AhynzMB47plvkqrXnmhcavlsDnu8Zfanr6gjUND0NK2Ufm0BBhH86kIcYMwehLYVNNfC3RTCT+QLo3wIn7VxUnsAPTqD23QjNwYnDTBQDkBrQIrFYaPc0RxO0MYexg/EqgEiAF1nJAZ3tndev1LBSEO5iN+8patoyV7jE3JlgF9qN0T0XCELrRpEi/pxKaVpAupXp38NBWVAJ6yqWuTCP2gcvnvo8KHHUTpJhwUcxr1aKUjX0LBnJ/mStQ8Cfckr7sLaHXyt4ei5uiQID69d/6JNoqpfoWW0EcHW8V3fiLX5fzsMBGjmRa/R8//zVM/ebpSwIDAQABo4GUMIGRMA4GA1UdDwEB/wQEAwIEsDAdBgNVHSUEFjAUBggrBgEFBQcDAgYIKwYBBQUHAwEwIAYDVR0RBBkwF4IVaDY4aGNnLnF1aWNrLmphbWYubmV0MB8GA1UdIwQYMBaAFD6G+I03qqd9Rd1UCSMy8WxzthG7MB0GA1UdDgQWBBT1Gk6lWWBdrF1z7n/FMgxT5Hb5YjANBgkqhkiG9w0BAQsFAAOCAQEAj0UtZ118booksRr7kDg47IhlhSlkhZVnZfkRUHY2QSYBkHNyilcb9rWJIAzrSI5q+RV+FDXDEc0at9CmH2yIb+dYSojxj1ebSCloZb5QiHfAZTFN5+AicESWb0PMGiiz1HeU8Bm2bjHIRx4OLKSm4agMck/6iBDJhduiidrEZkmz8MRFr04GE/9MAg3JG149JeCSS54seKx7tBx+dJjzHJg2HeqZtOKjaKLOnstquEVhwgGXIqH51lQd5SOfYJH1cQyi6xe7SBZ5YYYF1iubhMUqvYnbugskm35nYWk9XObw4QRnfTQNIuW6p1cz2Nk+yaDheraycaxbBGYaXMgIJzEVMBMGCSqGSIb3DQEJFTEGBAQBAAAAMDswHzAHBgUrDgMCGgQUA/Hryi7gjlbKpKpGVlTvAnjevyAEFFhGKjlcFPkz5+bUOnz1OcWq/3zPAgIH0A==","password":"password-example"}}}}}},"responses":{"204":{"description":"DigiCert Trust Lifecycle Manager certificate for client server is of valid file format and has correct password."}},"x-required-privileges":["Create DigiCert Settings","Update DigiCert Settings"],"x-action":true}},"/v1/pki/digicert/trust-lifecycle-manager/{id}":{"get":{"tags":["digicert"],"summary":"Retrieve DigiCert Trust Lifecycle Manager configuration","description":"Retrieve the current configuration of the DigiCert Trust Lifecycle\nManager.\n\n\n> 📋 **Required privilege:** Read DigiCert Settings","parameters":[{"name":"id","in":"path","description":"ID of the DigiCert Trust Lifecycle Manager configuration","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response returns a DigiCert Trust Lifecycle Manager\nconfiguration\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DigiCertSettingResponse"}}}},"404":{"description":"DigiCert Trust Lifecycle Manager configuration not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read DigiCert Settings"]},"delete":{"tags":["digicert"],"summary":"Delete DigiCert Trust Lifecycle Manager configuration","description":"Delete the current configuration of the DigiCert Trust Lifecycle\nManager.\n\n\n> 📋 **Required privilege:** Delete DigiCert Settings","parameters":[{"name":"id","in":"path","description":"ID of the DigiCert Trust Lifecycle Manager configuration","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful deletion of the DigiCert Trust Lifecycle Manager\nconfiguration\n"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Delete DigiCert Settings"]},"patch":{"tags":["digicert"],"summary":"Update DigiCert Trust Lifecycle Manager configuration\n","description":"Update DigiCert Trust Lifecycle Manager configuration, where the client certificate information must be provided in full or not at all.\n\n> 📋 **Required privilege:** Update DigiCert Settings","parameters":[{"name":"id","in":"path","description":"ID of the DigiCert Trust Lifecycle Manager configuration.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/DigiCertSetting"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update DigiCert Settings"]}},"/v1/pki/digicert/trust-lifecycle-manager/{id}/connection-status":{"get":{"tags":["digicert"],"summary":"Get connection status of DigiCert Trust Lifecycle Manager for a given ID","description":"Get connection status of DigiCert Trust Lifecycle Manager for a given ID.\n\n> 📋 **Required privilege:** Read DigiCert Settings","parameters":[{"name":"id","in":"path","description":"ID of the DigiCert Trust Lifecycle Manager settings.","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"12"}}],"responses":{"200":{"description":"Successful connection to DigiCert Trust Lifecycle Manager.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DigicertConnectionStatus"}}}},"404":{"description":"DigiCert Trust Lifecycle Manager settings not found."}},"x-required-privileges":["Read DigiCert Settings"]}},"/v1/pki/digicert/trust-lifecycle-manager/{id}/dependencies":{"get":{"tags":["digicert"],"summary":"Retrieve list of DigiCert Trust Lifecycle Manager Settings dependencies","description":"Retrieve list of DigiCert Trust Lifecycle Manager Settings dependencies.\n\n> 📋 **Required privilege:** Read DigiCert Settings","parameters":[{"name":"id","in":"path","description":"ID of the DigiCert Trust Lifecycle Manager configuration.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DigicertDependencies"}}}}},"x-required-privileges":["Read DigiCert Settings"]}},"/v1/pki/digicert/trust-lifecycle-manager/{id}/privilege-check":{"get":{"tags":["digicert"],"summary":"Check DigiCert account permissions for certificate deployment","description":"Checks that the DigiCert account associated with the given ID holds all\npermissions required to deploy certificates via the Trust Lifecycle Manager.\nReturns 204 if all required permissions are present. Returns 403 with a\nlist of missing permission names if any are absent.\n\n\n> 📋 **Required privilege:** Read DigiCert Settings","parameters":[{"name":"id","in":"path","description":"ID of the DigiCert Trust Lifecycle Manager settings.","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"12"}}],"responses":{"204":{"description":"DigiCert account has all required permissions for certificate deployment."},"403":{"description":"DigiCert account is missing one or more required permissions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"DigiCert Trust Lifecycle Manager settings not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read DigiCert Settings"]}},"/v1/distribution-points":{"get":{"tags":["distribution-point"],"summary":"Finds all Distribution Points","description":"Finds all Distribution Points\n\n> 📋 **Required privilege:** Read Distribution Points","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorts results by one or more criteria, following the format property:asc/desc. Default sort is id:asc. If using multiple criteria, separate with commas. Allows fields such as - name, serverName","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}},{"name":"filter","in":"query","description":"Filters results. Use RSQL format for query. Allows fields such as - name, serverName, principal, fileSharingConnectionType, and httpsEnabled Can be combined with paging and sorting. Default filter is an empty query and returns all results from the requested page.","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DistributionPointSearchResults"}}}}},"x-required-privileges":["Read Distribution Points"]},"post":{"tags":["distribution-point"],"summary":"Create distribution point","description":"Create distribution point\n\n> 📋 **Required privilege:** Create Distribution Points","requestBody":{"description":"distribution point to be created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DistributionPoint"}}},"required":true},"responses":{"201":{"description":"distribution point was created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}}},"x-required-privileges":["Create Distribution Points"]}},"/v1/distribution-points/delete-multiple":{"post":{"tags":["distribution-point"],"summary":"Delete multiple distribution points at once","description":"Delete multiple distribution points at once\n\n> 📋 **Required privilege:** Delete Distribution Points","requestBody":{"description":"ids of the distribution points to be deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ids"}}},"required":true},"responses":{"204":{"description":"All specified distribution points deleted successfully"},"400":{"description":"Returns error codes and ids for any distribution points that were unable to be deleted. Possible error codes include INVALID_ID (distribution point id does not exist) and SYSTEM_EXCEPTION (a system exception occurred while attempting to delete the distribution point).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Delete Distribution Points"],"x-action":true}},"/v1/distribution-points/{id}":{"get":{"tags":["distribution-point"],"summary":"Get specified distribution point\n","description":"Get specified distribution point\n\n\n> 📋 **Required privilege:** Read Distribution Points","parameters":[{"name":"id","in":"path","description":"instance id of distribution point","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"distribution point found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DistributionPoint"}}}},"404":{"description":"Specified distribution point could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Distribution Points"]},"put":{"tags":["distribution-point"],"summary":"Update specified distribution point object\n","description":"Update specified distribution point object\n\n\n> 📋 **Required privileges:**\n> - Read Distribution Points\n> - Update Distribution Points","parameters":[{"name":"id","in":"path","description":"Instance id of distribution point","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"distribution point object to update. ids defined in this body will be ignored","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DistributionPoint"}}},"required":true},"responses":{"202":{"description":"distribution point updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DistributionPoint"}}}}},"x-required-privileges":["Read Distribution Points","Update Distribution Points"]},"delete":{"tags":["distribution-point"],"summary":"Remove specified distribution point\n","description":"Removes specified distribution point\n\n\n> 📋 **Required privilege:** Delete Distribution Points","parameters":[{"name":"id","in":"path","description":"Instance id of distribution point","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"distribution point deleted successfully"}},"x-required-privileges":["Delete Distribution Points"]},"patch":{"tags":["distribution-point"],"summary":"Update specified distribution point object\n","description":"Updates the specified object configuration of a File Share Distribution Point in Jamf Pro. ID path parameter is mandatory and other fields can be updated as a whole or with minimal object.\n\n\n> 📋 **Required privileges:**\n> - Read Distribution Points\n> - Update Distribution Points","parameters":[{"name":"id","in":"path","description":"Instance id of distribution point","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"distribution point object to update.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DistributionPoint"}}},"required":true},"responses":{"202":{"description":"distribution point updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DistributionPoint"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"The specified distribution point id doesn't exist in database or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Distribution Points","Update Distribution Points"]}},"/v1/distribution-points/{id}/history":{"get":{"tags":["distribution-point"],"summary":"Get specified distribution point History object\n","description":"Gets specified distribution point history object\n\n\n> 📋 **Required privilege:** Read Distribution Points","parameters":[{"name":"id","in":"path","description":"Instance id of distribution point history","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorts results by one or more criteria, following the format property:asc/desc. Default sort is id:asc. If using multiple criteria, separate with commas.","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["date:desc"]}},{"name":"filter","in":"query","description":"Filters results. Use RSQL format for query. Allows for many fields, including id, name, etc. Can be combined with paging and sorting. Default filter is an empty query and returns all results from the requested page.","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Details of distribution point history were found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistorySearchResults"}}}},"404":{"description":"Specified distribution point history object could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Distribution Points"]},"post":{"tags":["distribution-point"],"summary":"Add specified distribution point History object notes\n","description":"Adds specified distribution point History object notes\n\n\n> 📋 **Required privilege:** Update Distribution Points","parameters":[{"name":"id","in":"path","description":"Instance id of distribution point history","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"History note to be created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistoryNote"}}},"required":true},"responses":{"201":{"description":"distribution point History note created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistory"}}}},"404":{"description":"distribution point History note could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"distribution point History note could not be saved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Distribution Points"]}},"/v1/dock-items":{"post":{"tags":["dock-items"],"summary":"Create a DockItem\n","description":"Creates a DockItem\n\n> 📋 **Required privilege:** Create Dock Items","requestBody":{"description":"new DockItem to create. ids defined in this body will be ignored","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DockItem"}}},"required":true},"responses":{"201":{"description":"DockItem created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"409":{"description":"Duplicate","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Create Dock Items"]}},"/v1/dock-items/{id}":{"get":{"tags":["dock-items"],"summary":"Retrieve a full dockItem object\n","description":"Retrieves a full dockItem object\n\n> 📋 **Required privilege:** Read Dock Items","parameters":[{"name":"id","in":"path","description":"DockItem object identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DockItem"}}}},"404":{"description":"Dockitem with that ID does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Dock Items"]},"put":{"tags":["dock-items"],"summary":"Replace the dockItem at the id with the supplied information\n","description":"Replaces the dockItem at the id with the supplied information\n\n> 📋 **Required privilege:** Update Dock Items","parameters":[{"name":"id","in":"path","description":"DockItem object identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"new dockItem to upload to existing id. ids defined in this body will be ignored","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DockItem"}}},"required":true},"responses":{"200":{"description":"DockItem at id was updated","content":{"text/plain":{"schema":{"type":"string"}}}},"404":{"description":"DockItem with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"Duplicate","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Dock Items"]},"delete":{"tags":["dock-items"],"summary":"Delete a DockItem at the specified id\n","description":"Deletes a dockItem at the specified id\n\n> 📋 **Required privilege:** Delete Dock Items","parameters":[{"name":"id","in":"path","description":"DockItem object identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful response"},"404":{"description":"DockItem with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Delete Dock Items"]}},"/v1/ebooks":{"get":{"tags":["ebooks"],"summary":"Get Ebook object\n","description":"Gets ebook object\n\n> 📋 **Required privilege:** Read eBooks","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is name:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["name:asc"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EbookSearchResults"}}}}},"x-required-privileges":["Read eBooks"]}},"/v1/ebooks/{id}":{"get":{"tags":["ebooks"],"summary":"Get specified Ebook object\n","description":"Gets specified Ebook object\n\n\n> 📋 **Required privilege:** Read eBooks","parameters":[{"name":"id","in":"path","description":"instance id of ebook record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Details about ebook were found for given id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ebook"}}}},"404":{"description":"Specified ebook object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read eBooks"]}},"/v1/ebooks/{id}/scope":{"get":{"tags":["ebooks"],"summary":"Get specified scope of Ebook object\n","description":"Gets specified scope of Ebook object\n\n\n> 📋 **Required privilege:** Read eBooks","parameters":[{"name":"id","in":"path","description":"instance id of ebook record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Details of scope for ebook were found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EbookScope"}}}},"404":{"description":"Specified scope for ebook object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read eBooks"]}},"/v1/adue-session-token-settings":{"get":{"tags":["enrollment"],"summary":"Retrieve the Account Driven User Enrollment Session Token Settings\n","description":"Retrieve the Account Driven User Enrollment Session Token Settings\n\n\n> 📋 **Required privilege:** Read User-Initiated Enrollment","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountDrivenUserEnrollmentSessionTokenSettings"}}}}},"x-required-privileges":["Read User-Initiated Enrollment"]},"put":{"tags":["enrollment"],"summary":"Update Account Driven User Enrollment Session Token Settings.\n","description":"Update the Account Driven User Enrollment Session Token Settings object.\n\n\n> 📋 **Required privilege:** Update User-Initiated Enrollment","requestBody":{"description":"Update Account Driven User Enrollment Session Token Settings.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountDrivenUserEnrollmentSessionTokenSettings"}}},"required":true},"responses":{"200":{"description":"Successfully updated Account Driven User Enrollment Session Token Settings object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountDrivenUserEnrollmentSessionTokenSettings"}}}},"400":{"description":"Invalid data response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update User-Initiated Enrollment"]}},"/v2/enrollment/history":{"get":{"tags":["enrollment"],"summary":"Get sorted and paged Enrollment history object\n","description":"Gets sorted and paged Enrollment history object\n\n\n> 📋 **Required privilege:** Read User-Initiated Enrollment","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: `property:asc/desc`. Default sort\nis `date:desc`. Multiple sort criteria are supported and must be separated\nwith a comma. Example: `sort=date:desc,name:asc`.\n","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["date:desc"]}}],"responses":{"200":{"description":"Details of enrollment history were found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistorySearchResults"}}}}},"x-required-privileges":["Read User-Initiated Enrollment"]},"post":{"tags":["enrollment"],"summary":"Add Enrollment history object notes\n","description":"Adds Enrollment history object notes\n\n\n> 📋 **Required privilege:** Update User-Initiated Enrollment","requestBody":{"description":"history notes to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistoryNote"}}},"required":true},"responses":{"201":{"description":"Notes of enrollment history were added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"503":{"description":"Enrollment history can not be saved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update User-Initiated Enrollment"]}},"/v2/enrollment/history/export":{"post":{"tags":["enrollment"],"summary":"Export enrollment history collection\n","description":"Export enrollment history collection\n\n\n> 📋 **Required privilege:** Read User-Initiated Enrollment","parameters":[{"$ref":"#/components/parameters/export-fields"},{"$ref":"#/components/parameters/export-labels"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is id:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=id:desc,name:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: id, name. This param can be combined with paging and sorting. Example: name==\"*script*\"","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"requestBody":{"description":"Optional. Override query parameters since they can make URI exceed 2,000 character limit.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportParameters"}}},"required":false},"responses":{"200":{"description":"Export successful","content":{"text/csv,application/json":{"schema":{"format":"binary","example":"Username,DATE,NOTES,Details\nadmin, 2022-02-04T11:56:26.343Z, Edited ,Re-enrollment Restricted true\n"}}}},"400":{"description":"Export fields specified incorrectly - non-existing column or duplicate in the list.\nSupported columns: id,name,categoryName,categoryId,priority.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"Export currently unavailable, all export-related resources are in use. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read User-Initiated Enrollment"],"x-action":true}},"/v3/enrollment/access-groups":{"get":{"tags":["enrollment"],"summary":"Retrieve the configured LDAP groups configured for User-Initiated Enrollment.\n","description":"Retrieves the configured LDAP groups configured for User-Initiated Enrollment.\n\n\n> 📋 **Required privilege:** Read User-Initiated Enrollment","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: `property:asc/desc`. Default sort\nis `name:asc`. Multiple sort criteria are supported and must be separated\nwith a comma. Example: `sort=date:desc,name:asc`.\n","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["name:asc"]}},{"name":"all-users-option-first","in":"query","description":"Return \"All LDAP Users\" option on the first position if it is present in the current page","required":false,"style":"form","explode":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Found access groups matching search params.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessGroupsPreviewSearchResults"}}}}},"x-required-privileges":["Read User-Initiated Enrollment"]},"post":{"tags":["enrollment"],"summary":"Add the configured LDAP group for User-Initiated Enrollment.\n","description":"Add the configured LDAP group for User-Initiated Enrollment.\n\n\n> 📋 **Required privilege:** Update User-Initiated Enrollment","requestBody":{"description":"Configured LDAP group to create.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollmentAccessGroupPreview"}}},"required":true},"responses":{"201":{"description":"Configured LDAP group record was created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"400":{"description":"A record with given ldapServerId and name already exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update User-Initiated Enrollment"]}},"/v3/enrollment/access-groups/{id}":{"get":{"tags":["enrollment"],"summary":"Retrieve the configured LDAP groups configured for User-Initiated Enrollment\n","description":"Retrieves the configured LDAP groups configured for User-Initiated Enrollment.\n\n> 📋 **Required privilege:** Read User-Initiated Enrollment","parameters":[{"name":"id","in":"path","description":"Autogenerated Access Group ID.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful query","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollmentAccessGroupPreview"}}}},"404":{"description":"Group not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read User-Initiated Enrollment"]},"put":{"tags":["enrollment"],"summary":"Modify the configured LDAP groups configured for User-Initiated Enrollment. Only exiting Access Groups can be updated.\n","description":"Modify the configured LDAP groups configured for User-Initiated Enrollment. Only exiting Access Groups can be updated.\n\n\n> 📋 **Required privilege:** Update User-Initiated Enrollment","parameters":[{"name":"id","in":"path","description":"Autogenerated Access Group ID.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollmentAccessGroupPreview"}}},"required":true},"responses":{"200":{"description":"Successful update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollmentAccessGroupPreview"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update User-Initiated Enrollment"]},"delete":{"tags":["enrollment"],"summary":"Delete an LDAP group's access to user initiated Enrollment.\n","description":"Deletes an LDAP group's access to user initiated enrollment. The group \"All LDAP Users\" cannot be deleted, but it can be modified to disallow User-Initiated Enrollment.\n\n> 📋 **Required privilege:** Update User-Initiated Enrollment","parameters":[{"name":"id","in":"path","description":"Autogenerated Access Group ID.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful deletion"},"400":{"description":"\"All LDAP Users\" cannot be deleted.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Group not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update User-Initiated Enrollment"]}},"/v3/enrollment/filtered-language-codes":{"get":{"tags":["enrollment"],"summary":"Retrieve the list of languages and corresponding ISO 639-1 Codes but only those not already added to Enrollment\n","description":"Retrieves the list of languages and corresponding ISO 639-1 Codes, but only those not already added to Enrollment.\n\n> 📋 **Required privilege:** Read User-Initiated Enrollment","responses":{"200":{"description":"Retrieves the list of languages and corresponding ISO 639-1 Codes, but only those not already added to Enrollment.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LanguageCode"}}}}}},"x-required-privileges":["Read User-Initiated Enrollment"]}},"/v3/enrollment/language-codes":{"get":{"tags":["enrollment"],"summary":"Retrieve the list of languages and corresponding ISO 639-1 Codes\n","description":"Retrieves the list of languages and corresponding ISO 639-1 Codes.\n\n> 📋 **Required privilege:** Read User-Initiated Enrollment","responses":{"200":{"description":"List of languages and corresponding ISO 639-1 Codes.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LanguageCode"}}}}}},"x-required-privileges":["Read User-Initiated Enrollment"]}},"/v3/enrollment/languages":{"get":{"tags":["enrollment"],"summary":"Get an array of the language codes that have Enrollment messaging\n","description":"Returns an array of the language codes that have enrollment messaging currently configured.\n\n> 📋 **Required privilege:** Read User-Initiated Enrollment","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort\nis `languageCode:asc`. Multiple sort criteria are supported and must be separated\nwith a comma. Example: `sort=date:desc,name:asc`.\n","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["languageCode:asc"]}}],"responses":{"200":{"description":"Found languages matching search params.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessTextsSearchResults"}}}}},"x-required-privileges":["Read User-Initiated Enrollment"]}},"/v3/enrollment/languages/delete-multiple":{"post":{"tags":["enrollment"],"summary":"Delete multiple configured languages from User-Initiated Enrollment settings\n","description":"Delete multiple configured languages from User-Initiated Enrollment settings\n\n> 📋 **Required privilege:** Update User-Initiated Enrollment","requestBody":{"description":"ids of each language to delete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ids"}}},"required":true},"responses":{"204":{"description":"All languages ids passed in request sucessfully deleted."},"400":{"description":"Request processed.  Returns ids and error codes of any language unable to be deleted.  Expected error codes: INVALID_ID - id does not exist SYSTEM_EXCEPTION - a system exception occurred trying to delete the language.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update User-Initiated Enrollment"],"x-action":true}},"/v3/enrollment/languages/{languageId}":{"get":{"tags":["enrollment"],"summary":"Retrieve the Enrollment messaging for a language\n","description":"Retrieves the enrollment messaging for a language.\n\n> 📋 **Required privilege:** Read User-Initiated Enrollment","parameters":[{"name":"languageId","in":"path","description":"Two letter ISO 639-1 Language Code","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollmentProcessTextObject"}}}},"404":{"description":"Language not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read User-Initiated Enrollment"]},"put":{"tags":["enrollment"],"summary":"Edit Enrollment messaging for a language\n","description":"Edit enrollment messaging for a language.\n\n> 📋 **Required privilege:** Update User-Initiated Enrollment","parameters":[{"name":"languageId","in":"path","description":"Two letter ISO 639-1 Language Code","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollmentProcessTextObject"}}},"required":false},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollmentProcessTextObject"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update User-Initiated Enrollment"]},"delete":{"tags":["enrollment"],"summary":"Delete the Enrollment messaging for a language\n","description":"Delete the enrollment messaging for a language.\n\n> 📋 **Required privilege:** Update User-Initiated Enrollment","parameters":[{"name":"languageId","in":"path","description":"Two letter ISO 639-1 Language Code","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful deletetion"},"404":{"description":"Language not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update User-Initiated Enrollment"]}},"/v4/enrollment":{"get":{"tags":["enrollment"],"summary":"Get Enrollment object and Re-enrollment settings\n","description":"Gets Enrollment object and re-enrollment settings.\n\n\n> 📋 **Required privilege:** Read User-Initiated Enrollment","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollmentSettingsV4"}}}}},"x-required-privileges":["Read User-Initiated Enrollment"]},"put":{"tags":["enrollment"],"summary":"Update Enrollment object\n","description":"Update enrollment object. Regarding the `developerCertificateIdentity`,\nif this object is omitted, the certificate will not be deleted from Jamf Pro.\nThe `identityKeystore` is the entire cert file as a base64 encoded string. The\n`md5Sum` field is not required in the PUT request, but is calculated and returned\nin the response.\n\n\n> 📋 **Required privilege:** Update User-Initiated Enrollment","requestBody":{"description":"Update enrollment","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollmentSettingsV4"}}},"required":true},"responses":{"200":{"description":"Successfully updated enrollment object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollmentSettingsV4"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update User-Initiated Enrollment"]}},"/v4/enrollment/access-management":{"get":{"tags":["enrollment"],"summary":"Get Access Management settings","description":"Get Access Management settings\n\n> 📋 **Required privilege:** Access Management Setting Read","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessManagementSetting"}}}}},"x-required-privileges":["Access Management Setting Read"]},"post":{"tags":["enrollment"],"summary":"Configure Access Management settings\n","description":"Configure Access Management settings\n\n\n> 📋 **Required privilege:** Access Management Setting Update","requestBody":{"description":"Configure Access Management settings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessManagementSetting"}}},"required":true},"responses":{"200":{"description":"Successfully Configured Access Management settings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessManagementSetting"}}}}},"x-required-privileges":["Access Management Setting Update"],"x-action":true}},"/v2/enrollment-customizations":{"get":{"tags":["enrollment-customization"],"summary":"Retrieve sorted and paged Enrollment Customizations\n","description":"Retrieves sorted and paged Enrollment Customizations\n\n> 📋 **Required privilege:** Read Enrollment Customizations","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollmentCustomizationSearchResultsV2"}}}}},"x-required-privileges":["Read Enrollment Customizations"]},"post":{"tags":["enrollment-customization"],"summary":"Create an Enrollment Customization\n","description":"Create an enrollment customization\n\n> 📋 **Required privilege:** Create Enrollment Customizations","requestBody":{"description":"Enrollment customization to create.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollmentCustomizationV2"}}},"required":true},"responses":{"201":{"description":"Enrollment customization was created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}}},"x-required-privileges":["Create Enrollment Customizations"]}},"/v2/enrollment-customizations/images":{"post":{"tags":["enrollment-customization"],"summary":"Upload an image","description":"Uploads an image\n\n> 📋 **Required privilege:** Update Enrollment Customizations","requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"The file to upload","format":"binary"}}}}},"required":true},"responses":{"201":{"description":"Image successfully uploaded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandingImageUrl"}}}}},"x-required-privileges":["Update Enrollment Customizations"]}},"/v2/enrollment-customizations/images/{id}":{"get":{"tags":["enrollment-customization"],"summary":"Download an enrollment customization image\n","description":"Download an enrollment customization image","parameters":[{"name":"id","in":"path","description":"id of the enrollment customization image","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"image/*":{"schema":{"type":"string","format":"binary"}}}}},"x-authentication-required":false}},"/v2/enrollment-customizations/{id}":{"get":{"tags":["enrollment-customization"],"summary":"Retrieve an Enrollment Customization with the supplied id\n","description":"Retrieves an Enrollment Customization with the supplied id\n\n> 📋 **Required privilege:** Read Enrollment Customizations","parameters":[{"name":"id","in":"path","description":"Enrollment Customization identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollmentCustomizationV2"}}}},"404":{"description":"Enrollment Customization with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Enrollment Customizations"]},"put":{"tags":["enrollment-customization"],"summary":"Update an Enrollment Customization\n","description":"Updates an Enrollment Customization\n\n> 📋 **Required privilege:** Update Enrollment Customizations","parameters":[{"name":"id","in":"path","description":"Enrollment Customization identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Enrollment Customization to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollmentCustomizationV2"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollmentCustomizationV2"}}}},"404":{"description":"Enrollment Customization with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Enrollment Customizations"]},"delete":{"tags":["enrollment-customization"],"summary":"Delete an Enrollment Customization with the supplied id\n","description":"Deletes an Enrollment Customization with the supplied id\n\n> 📋 **Required privileges:**\n> - Delete Enrollment Customizations\n> - Read Enrollment Customizations","parameters":[{"name":"id","in":"path","description":"Enrollment Customization identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Success"}},"x-required-privileges":["Delete Enrollment Customizations","Read Enrollment Customizations"]}},"/v2/enrollment-customizations/{id}/history":{"get":{"tags":["enrollment-customization"],"summary":"Get sorted and paged Enrollment Customization history objects\n","description":"Gets sorted and paged enrollment customization history objects\n\n> 📋 **Required privilege:** Read Enrollment Customizations","parameters":[{"name":"id","in":"path","description":"Enrollment Customization identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property,asc/desc. Default sort order is descending. Multiple sort criteria are supported and must be entered on separate lines in Swagger UI. In the URI the 'sort' query param is duplicated for each sort criterion, e.g., ...&sort=name%2Casc&sort=date%2Cdesc","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["date:desc"]}}],"responses":{"200":{"description":"Details of enrollment customization history were found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistorySearchResults"}}}}},"x-required-privileges":["Read Enrollment Customizations"]},"post":{"tags":["enrollment-customization"],"summary":"Add Enrollment Customization history object notes\n","description":"Adds enrollment customization history object notes\n\n> 📋 **Required privilege:** Update Enrollment Customizations","parameters":[{"name":"id","in":"path","description":"Enrollment Customization identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"History notes to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistoryNote"}}},"required":true},"responses":{"201":{"description":"Notes of enrollment customization history were added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistory"}}}},"503":{"description":"Enrollment customization history can not be saved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Enrollment Customizations"]}},"/v2/enrollment-customizations/{id}/prestages":{"get":{"tags":["enrollment-customization"],"summary":"Retrieve the list of Prestages using this Enrollment Customization\n","description":"Retrieves the list of Prestages using this Enrollment Customization\n\n> 📋 **Required privilege:** Read Enrollment Customizations","parameters":[{"name":"id","in":"path","description":"Enrollment Customization identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrestageDependencies"}}}},"404":{"description":"Enrollment Customization with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Enrollment Customizations"]}},"/v1/enrollment-customization/parse-markdown":{"post":{"tags":["enrollment-customization-preview"],"summary":"Parse the given string as markdown text and return Html output\n","description":"Parse the given string as markdown text and return Html output\n\n> 📋 **Required privilege:** Read Enrollment Customizations","requestBody":{"description":"Enrollment Customization Panel to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Markdown"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Markdown"}}}}},"x-required-privileges":["Read Enrollment Customizations"]}},"/v1/enrollment-customization/{id}/all":{"get":{"tags":["enrollment-customization-preview"],"summary":"Get all Panels for single Enrollment Customization\n","description":"Get all panels for single enrollment customization\n\n> 📋 **Required privilege:** Read Enrollment Customizations","parameters":[{"name":"id","in":"path","description":"Enrollment Customization identifier","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollmentCustomizationPanelList"}}}},"404":{"description":"Enrollment Customization with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Enrollment Customizations"]}},"/v1/enrollment-customization/{id}/all/{panel-id}":{"get":{"tags":["enrollment-customization-preview"],"summary":"Get a single Panel for a single Enrollment Customization\n","description":"Get a single panel for a single enrollment customization\n\n> 📋 **Required privilege:** Read Enrollment Customizations","parameters":[{"name":"id","in":"path","description":"Enrollment Customization identifier","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}},{"name":"panel-id","in":"path","description":"Panel object identifier","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEnrollmentCustomizationPanel"}}}},"404":{"description":"Enrollment Customization with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Enrollment Customizations"]},"delete":{"tags":["enrollment-customization-preview"],"summary":"Delete a single Panel from an Enrollment Customization\n","description":"Delete a single panel from an Enrollment Customization\n\n> 📋 **Required privilege:** Update Enrollment Customizations","parameters":[{"name":"id","in":"path","description":"Enrollment Customization identifier","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}},{"name":"panel-id","in":"path","description":"Panel object identifier","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Success"}},"x-required-privileges":["Update Enrollment Customizations"]}},"/v1/enrollment-customization/{id}/ldap":{"post":{"tags":["enrollment-customization-preview"],"summary":"Create an LDAP Panel for a single Enrollment Customization\n","description":"Create an LDAP panel for a single enrollment customization. If multiple LDAP access groups are defined with the same name and id, only one will be saved.\n\n> 📋 **Required privilege:** Update Enrollment Customizations","parameters":[{"name":"id","in":"path","description":"Enrollment Customization identifier","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}}],"requestBody":{"description":"Enrollment Customization Panel to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollmentCustomizationPanelLdapAuth"}}},"required":true},"responses":{"201":{"description":"LDAP panel was created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEnrollmentCustomizationPanelLdapAuth"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Enrollment Customizations"]}},"/v1/enrollment-customization/{id}/ldap/{panel-id}":{"get":{"tags":["enrollment-customization-preview"],"summary":"Get a single LDAP panel for a single Enrollment Customization\n","description":"Get a single LDAP panel for a single enrollment customization\n\n> 📋 **Required privilege:** Read Enrollment Customizations","parameters":[{"name":"id","in":"path","description":"Enrollment Customization identifier","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}},{"name":"panel-id","in":"path","description":"Panel object identifier","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEnrollmentCustomizationPanelLdapAuth"}}}},"404":{"description":"Enrollment Customization or Panel does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Enrollment Customizations"]},"put":{"tags":["enrollment-customization-preview"],"summary":"Update a single LDAP Panel for a single Enrollment Customization\n","description":"Update a single LDAP panel for a single enrollment customization. If multiple LDAP access groups are defined with the same name and id, only one will be saved.\n\n> 📋 **Required privilege:** Update Enrollment Customizations","parameters":[{"name":"id","in":"path","description":"Enrollment Customization identifier","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}},{"name":"panel-id","in":"path","description":"Panel object identifier","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}}],"requestBody":{"description":"Enrollment Customization Panel to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollmentCustomizationPanelLdapAuth"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEnrollmentCustomizationPanelLdapAuth"}}}},"404":{"description":"Enrollment Customization or Panel does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Enrollment Customizations"]},"delete":{"tags":["enrollment-customization-preview"],"summary":"Delete an LDAP single panel from an Enrollment Customization\n","description":"Delete an LDAP single Panel from an Enrollment Customization\n\n> 📋 **Required privilege:** Update Enrollment Customizations","parameters":[{"name":"id","in":"path","description":"Enrollment Customization identifier","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}},{"name":"panel-id","in":"path","description":"Panel object identifier","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Success"}},"x-required-privileges":["Update Enrollment Customizations"]}},"/v1/enrollment-customization/{id}/sso":{"post":{"tags":["enrollment-customization-preview"],"summary":"Create an SSO Panel for a single Enrollment Customization\n","description":"Create an SSO panel for a single enrollment customization\n\n> 📋 **Required privilege:** Update Enrollment Customizations","parameters":[{"name":"id","in":"path","description":"Enrollment Customization identifier","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}}],"requestBody":{"description":"Enrollment Customization Panel to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollmentCustomizationPanelSsoAuth"}}},"required":true},"responses":{"201":{"description":"Auth panel was created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEnrollmentCustomizationPanelSsoAuth"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Enrollment Customizations"]}},"/v1/enrollment-customization/{id}/sso/{panel-id}":{"get":{"tags":["enrollment-customization-preview"],"summary":"Get a single SSO Panel for a single Enrollment Customization\n","description":"Get a single SSO panel for a single enrollment customization\n\n> 📋 **Required privilege:** Read Enrollment Customizations","parameters":[{"name":"id","in":"path","description":"Enrollment Customization identifier","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}},{"name":"panel-id","in":"path","description":"Panel object identifier","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEnrollmentCustomizationPanelSsoAuth"}}}},"404":{"description":"Enrollment Customization or Panel does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Enrollment Customizations"]},"put":{"tags":["enrollment-customization-preview"],"summary":"Update a single SSO Panel for a single Enrollment Customization\n","description":"Update a single SSO panel for a single enrollment customization\n\n> 📋 **Required privilege:** Update Enrollment Customizations","parameters":[{"name":"id","in":"path","description":"Enrollment Customization identifier","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}},{"name":"panel-id","in":"path","description":"Panel object identifier","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}}],"requestBody":{"description":"Enrollment Customization Panel to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollmentCustomizationPanelSsoAuth"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEnrollmentCustomizationPanelSsoAuth"}}}},"404":{"description":"Enrollment Customization or Panel does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Enrollment Customizations"]},"delete":{"tags":["enrollment-customization-preview"],"summary":"Delete a single SSO Panel from an Enrollment Customization\n","description":"Delete a single SSO panel from an Enrollment Customization\n\n> 📋 **Required privilege:** Update Enrollment Customizations","parameters":[{"name":"id","in":"path","description":"Enrollment Customization identifier","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}},{"name":"panel-id","in":"path","description":"Panel object identifier","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Success"}},"x-required-privileges":["Update Enrollment Customizations"]}},"/v1/enrollment-customization/{id}/text":{"post":{"tags":["enrollment-customization-preview"],"summary":"Create a Text Panel for a single Enrollment Customization\n","description":"Create a Text panel for a single enrollment customization\n\n> 📋 **Required privilege:** Update Enrollment Customizations","parameters":[{"name":"id","in":"path","description":"Enrollment Customization identifier","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}}],"requestBody":{"description":"Enrollment Customization Panel to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollmentCustomizationPanelText"}}},"required":true},"responses":{"201":{"description":"Text panel was created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEnrollmentCustomizationPanelText"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Enrollment Customizations"]}},"/v1/enrollment-customization/{id}/text/{panel-id}":{"get":{"tags":["enrollment-customization-preview"],"summary":"Get a single Text Panel for a single Enrollment Customization\n","description":"Get a single Text panel for a single enrollment customization\n\n> 📋 **Required privilege:** Read Enrollment Customizations","parameters":[{"name":"id","in":"path","description":"Enrollment Customization identifier","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}},{"name":"panel-id","in":"path","description":"Panel object identifier","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEnrollmentCustomizationPanelText"}}}},"404":{"description":"Enrollment Customization with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Enrollment Customizations"]},"put":{"tags":["enrollment-customization-preview"],"summary":"Update a single Text Panel for a single Enrollment Customization\n","description":"Update a single Text panel for a single enrollment customization\n\n> 📋 **Required privilege:** Update Enrollment Customizations","parameters":[{"name":"id","in":"path","description":"Enrollment Customization identifier","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}},{"name":"panel-id","in":"path","description":"Panel object identifier","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}}],"requestBody":{"description":"Enrollment Customization Panel to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollmentCustomizationPanelText"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEnrollmentCustomizationPanelText"}}}},"404":{"description":"Enrollment Customization or Panel does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Enrollment Customizations"]},"delete":{"tags":["enrollment-customization-preview"],"summary":"Delete a Text single Panel from an Enrollment Customization\n","description":"Delete a Text single panel from an Enrollment Customization\n\n> 📋 **Required privilege:** Update Enrollment Customizations","parameters":[{"name":"id","in":"path","description":"Enrollment Customization identifier","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}},{"name":"panel-id","in":"path","description":"Panel object identifier","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Success"}},"x-required-privileges":["Update Enrollment Customizations"]}},"/v1/enrollment-customization/{id}/text/{panel-id}/markdown":{"get":{"tags":["enrollment-customization-preview"],"summary":"Get the markdown output of a single Text Panel for a single Enrollment\n","description":"Get the markdown output of a single Text panel for a single enrollment customization\n\n> 📋 **Required privilege:** Read Enrollment Customizations","parameters":[{"name":"id","in":"path","description":"Enrollment Customization identifier","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}},{"name":"panel-id","in":"path","description":"Panel object identifier","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Markdown"}}}},"404":{"description":"Enrollment Customization with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Enrollment Customizations"]}},"/v1/groups":{"get":{"tags":["groups"],"summary":"Returns group information for all Mobile Device and Computer groups","description":"Returns group information for all Mobile Device and Computer groups. The type of groups returned will be dependent upon the corresponding group type READ privileges. Results can be sorted by name, description, group type, or isSmart. Default sorting is by group name in ascending order.","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is groupName:asc. Multiple sort criteria are supported and must be separated with a comma. Fields allowed in sorting: groupName, groupDescription, groupType, isSmart. Example: sort=groupName:asc,groupType:desc","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["groupName:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter group collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: groupPlatformId, groupName, groupDescription, groupType, isSmart. This param can be combined with paging and sorting. When using groupPlatformId in the filter, the supported operators are: =in= (match any in list), =out= (exclude all in list). When using groupType in the filter, the value must be either \"MOBILE\" or \"COMPUTER\" but not both. When using groupType in the filter, the value is case sensitive. When using groupType in the filter, it will exclude groups of the other type regardless of or/and conditionals. Example: filter=groupPlatformId=in=('uuid1','uuid2','uuid3') Example: filter=groupName==\"*Managed*\" and isSmart==\"true\" Example: filter=groupType==\"COMPUTER\" and groupDescription==\"*Admin*\"","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupSearchResult"}}}}},"deprecated":true,"x-deprecation-date":"2026-05-28","x-authentication-required":true}},"/v1/groups/{id}":{"get":{"tags":["groups"],"summary":"Returns group information for the given platform UUID","description":"Returns group information for the given platform UUID. Dependent upon the returned group type the corresponding READ privilege for that group type will be needed.","parameters":[{"name":"id","in":"path","description":"The platform UUID of a group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupWithCriteriaDtoV1"},"examples":{"smartGroup":{"summary":"Smart Group Response","description":"Example response for a smart group with criteria","value":{"groupPlatformId":"20b66625-39c0-41d9-9b2c-98e57a3554c8","groupJamfProId":"18","groupName":"Smart Mobile Device Group","groupDescription":"Devices with iOS 15 or higher","groupType":"MOBILE","smart":true,"membershipCount":12,"criteria":[{"name":"Operating System Version","priority":0,"andOr":"and","searchType":"greater than or equal","value":"15.0","openingParen":false,"closingParen":false},{"name":"Device Name","priority":1,"andOr":"and","searchType":"like","value":"iPhone","openingParen":false,"closingParen":false}]}},"staticGroup":{"summary":"Static Group Response","description":"Example response for a static group without criteria","value":{"groupPlatformId":"f8e3c123-4567-89ab-cdef-123456789abc","groupJamfProId":"25","groupName":"Marketing Computers","groupDescription":"All computers in the marketing department","groupType":"COMPUTER","smart":false,"membershipCount":8,"criteria":null}}}}}},"404":{"description":"A group with that platform UUID does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2026-05-28","x-authentication-required":true},"delete":{"tags":["groups"],"summary":"Delete a group by platform UUID","description":"Deletes a group by its platform UUID. Returns a 400 error if the group is being used as a dependency. Requires appropriate DELETE privileges.","parameters":[{"name":"id","in":"path","description":"The platform UUID of a group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Group deleted successfully"},"400":{"description":"Group cannot be deleted due to dependencies or validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Insufficient privileges to delete this group","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"A group with that platform UUID does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2026-05-28","x-authentication-required":true},"patch":{"tags":["groups"],"summary":"Update a group by platform UUID","description":"Updates a group by its platform UUID. For both smart and static groups, groupName and groupDescription can be updated. For smart groups, criteria can also be updated. For static groups, assignments can also be updated. Requires appropriate UPDATE privileges.","parameters":[{"name":"id","in":"path","description":"The platform UUID of a group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupUpdateDtoV1"},"examples":{"smartGroup":{"summary":"Update Smart Group","description":"Example of updating a smart group with criteria","value":{"groupName":"Updated Smart Group","groupDescription":"Updated smart group description","criteria":[{"name":"Computer Name","priority":0,"andOr":"and","searchType":"is","value":"Test","openingParen":false,"closingParen":false}]}},"staticGroup":{"summary":"Update Static Group","description":"Example of updating a static group with device assignments","value":{"groupName":"Updated Static Group","groupDescription":"Updated static group description","assignments":[{"deviceId":"56585788-8937-4bdf-b986-458048b1c36c","selected":true},{"deviceId":"12345678-1234-1234-1234-123456789012","selected":false}]}}}}},"required":true},"responses":{"204":{"description":"Group updated successfully"},"400":{"description":"Invalid request data or validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Insufficient privileges to update this group","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"A group with that platform UUID does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"Duplicate group name","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2026-05-28","x-authentication-required":true}},"/v2/groups":{"get":{"tags":["groups"],"summary":"Returns group information for all Mobile Device and Computer groups","description":"Returns group information for all Mobile Device and Computer groups. The type of groups returned will be dependent upon the corresponding group type READ privileges. Results can be sorted by name, description, group type, or isSmart. Default sorting is by group name in ascending order.","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is groupName:asc. Multiple sort criteria are supported and must be separated with a comma. Fields allowed in sorting: groupName, groupDescription, groupType, isSmart. Example: sort=groupName:asc,groupType:desc","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["groupName:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter group collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: groupName, groupDescription, groupType, isSmart. This param can be combined with paging and sorting. When using groupType in the filter, the value must be either \"MOBILE\" or \"COMPUTER\" but not both. When using groupType in the filter, the value is case sensitive. When using groupType in the filter, it will exclude groups of the other type regardless of or/and conditionals. Example: filter=groupName==\"*Managed*\" and isSmart==\"true\" Example: filter=groupType==\"COMPUTER\" and groupDescription==\"*Admin*\"","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupSearchResult"}}}}},"x-authentication-required":true}},"/v2/groups/{id}":{"get":{"tags":["groups"],"summary":"Returns group information for the given platform UUID","description":"Returns group information for the given platform UUID. Dependent upon the returned group type the corresponding READ privilege for that group type will be needed.","parameters":[{"name":"id","in":"path","description":"The platform UUID of a group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupWithCriteriaDtoV1"},"examples":{"smartGroup":{"summary":"Smart Group Response","description":"Example response for a smart group with criteria","value":{"groupPlatformId":"20b66625-39c0-41d9-9b2c-98e57a3554c8","groupJamfProId":"18","groupName":"Smart Mobile Device Group","groupDescription":"Devices with iOS 15 or higher","groupType":"MOBILE","smart":true,"membershipCount":12,"criteria":[{"name":"Operating System Version","priority":0,"andOr":"and","searchType":"greater than or equal","value":"15.0","openingParen":false,"closingParen":false}]}},"staticGroup":{"summary":"Static Group Response","description":"Example response for a static group without criteria","value":{"groupPlatformId":"f8e3c123-4567-89ab-cdef-123456789abc","groupJamfProId":"25","groupName":"Marketing Computers","groupDescription":"All computers in the marketing department","groupType":"COMPUTER","smart":false,"membershipCount":8,"criteria":null}}}}}},"404":{"description":"The requested resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-authentication-required":true},"delete":{"tags":["groups"],"summary":"Delete a group by platform UUID","description":"Deletes a group by its platform UUID. Returns a 422 error if the group is being used as a dependency. Requires appropriate DELETE privileges.\n","parameters":[{"name":"id","in":"path","description":"The platform UUID of a group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Group deleted successfully"},"403":{"description":"Insufficient privileges to delete this group","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"The requested resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"Group cannot be deleted due to dependencies","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-authentication-required":true},"patch":{"tags":["groups"],"summary":"Update a group by platform UUID","description":"Updates a group by its platform UUID. For both smart and static groups, groupName and groupDescription can be updated. For smart groups, criteria can also be updated. For static groups, assignments can also be updated. Requires appropriate UPDATE privileges.\n","parameters":[{"name":"id","in":"path","description":"The platform UUID of a group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupUpdateDtoV2"},"examples":{"smartGroup":{"summary":"Update Smart Group","description":"Example of updating a smart group with criteria","value":{"groupName":"Updated Smart Group","groupDescription":"Updated smart group description","criteria":[{"name":"Computer Name","priority":0,"andOr":"and","searchType":"is","value":"Test","openingParen":false,"closingParen":false}]}},"staticGroup":{"summary":"Update Static Group","description":"Example of updating a static group with device assignments","value":{"groupName":"Updated Static Group","groupDescription":"Updated static group description","assignments":[{"deviceId":"56585788-8937-4bdf-b986-458048b1c36c","selected":true},{"deviceId":"12345678-1234-1234-1234-123456789012","selected":false}]}}}}},"required":true},"responses":{"204":{"description":"Group updated successfully"},"400":{"description":"Invalid request data or validation error. Common causes include:\n- Invalid andOr value (must be \"and\" or \"or\")\n- Invalid priority order in criteria\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Insufficient privileges to update this group","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"The requested resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"Duplicate group name","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-authentication-required":true}},"/v1/gsx-connection":{"get":{"tags":["gsx-connection"],"summary":"Finds the Jamf Pro GSX Connection information\n","description":"Finds the Jamf Pro GSX Connection information\n\n\n> 📋 **Required privileges:**\n> - Read GSX Connection\n> - Read Push Certificates","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GsxConnection"}}}}},"x-required-privileges":["Read GSX Connection","Read Push Certificates"]},"put":{"tags":["gsx-connection"],"summary":"Updates Jamf Pro GSX Connection information\n","description":"Updates Jamf Pro GSX Connection information\n\n\n> 📋 **Required privileges:**\n> - Update GSX Connection\n> - Update Push Certificates","requestBody":{"description":"GSX Connection to update","content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/GsxConnection"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GsxConnection"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"There was an error applying the put","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update GSX Connection","Update Push Certificates"]},"patch":{"tags":["gsx-connection"],"summary":"Updates Jamf Pro GSX Connection information\n","description":"Updates Jamf Pro GSX Connection information\n\n\n> 📋 **Required privileges:**\n> - Update GSX Connection\n> - Update Push Certificates","requestBody":{"description":"GSX Connection to update","content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/GsxConnectionUpdate"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GsxConnection"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"There was an error applying the put","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update GSX Connection","Update Push Certificates"]}},"/v1/gsx-connection/history":{"get":{"tags":["gsx-connection"],"summary":"Get specified GSX Connection History object\n","description":"Gets specified GSX Connection history object\n\n\n> 📋 **Required privilege:** Read GSX Connection","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["date:desc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Details of GSX Connection history were found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistorySearchResultsV1"}}}},"404":{"description":"Specified GSX Connection object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read GSX Connection"]},"post":{"tags":["gsx-connection"],"summary":"Add specified GSX Connection history object notes\n","description":"Adds specified GSX Connection history object notes\n\n\n> 📋 **Required privilege:** Update GSX Connection","requestBody":{"description":"history notes to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistoryNote"}}},"required":true},"responses":{"201":{"description":"Notes of GSX Connection history were added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"503":{"description":"GSX Connection history can not be saved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update GSX Connection"]}},"/v1/gsx-connection/test":{"post":{"tags":["gsx-connection"],"summary":"Test functionality of an GSX Connection","description":"Test functionality of an GSX Connection\n\n> 📋 **Required privilege:** Read GSX Connection","responses":{"202":{"description":"Success"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GsxTestResponse"}}}}},"x-required-privileges":["Read GSX Connection"],"x-action":true}},"/v1/health-check":{"get":{"tags":["health-check"],"summary":"Get Jamf Pro API status","description":"Get Jamf Pro API status. Which response codes might be returned in error states will depend on the specific state encountered.","responses":{"204":{"description":"The Jamf Pro API is working properly."}},"x-authentication-required":false}},"/v1/health-status":{"get":{"tags":["health-check"],"summary":"Retrieve request acceptance ratios for this Jamf Pro node","description":"Returns metrics representing the request acceptance ratio for each concurrency group and time window on this Jamf Pro node. The acceptance ratio is a decimal value between 0 and 1, where 1 means all requests were accepted and 0 means all were denied. Health status metrics are only available in Jamf Cloud. This API will return a 404 if the Jamf Pro node does not support health status metrics.\n","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthStatus"}}}},"404":{"description":"This Jamf Pro node does not support health status metrics."}},"x-authentication-required":true}},"/v1/icon":{"post":{"tags":["icon"],"summary":"Upload an icon\n","description":"Uploads an icon","requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"The file to upload","format":"binary"}}}}},"required":true},"responses":{"201":{"description":"Icon successfully uploaded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IconResponse"}}}},"400":{"description":"Failure, field required: \"file\".","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Upload Failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-authentication-required":true}},"/v1/icon/download/{id}":{"get":{"tags":["icon"],"summary":"Download a self service icon\n","description":"Download a self service icon","parameters":[{"name":"id","in":"path","description":"id of the self service icon","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"res","in":"query","description":"request a specific resolution of original, 300, or 512; invalid options will result in original resolution","required":false,"style":"form","explode":true,"schema":{"type":"string","example":"300","default":"original"}},{"name":"scale","in":"query","description":"request a scale; 0 results in original image, non-0 results in scaled to 300","required":false,"style":"form","explode":true,"schema":{"type":"string","example":"1","default":"0"}}],"responses":{"200":{"description":"Successful response","content":{"image/*":{"schema":{"type":"string","format":"binary"}}}}},"x-authentication-required":true}},"/v1/icon/{id}":{"get":{"tags":["icon"],"summary":"Get an icon\n","description":"Get an icon","parameters":[{"name":"id","in":"path","description":"id of the icon","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IconResponse"}}}}},"x-authentication-required":true}},"/v1/impact-alert-notification-settings":{"get":{"tags":["impact-alert-notification-settings"],"summary":"Get Impact Alert Notification Settings","description":"Get Impact Alert Notification Settings\n\n> 📋 **Required privilege:** Read Impact Alert Notification Settings","responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImpactAlertNotificationSettingsV1"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Impact Alert Notification Settings"]},"put":{"tags":["impact-alert-notification-settings"],"summary":"Update Impact Alert Notification Settings","description":"Update Impact Alert Notification Settings\n\n> 📋 **Required privilege:** Update Impact Alert Notification Settings","requestBody":{"description":"Configure Access Management settings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImpactAlertNotificationSettingsV1"}}},"required":true},"responses":{"204":{"description":"Update Successful"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Impact Alert Notification Settings"]}},"/v1/inventory-information":{"get":{"tags":["inventory-information"],"summary":"Get statistics about managed/unmanaged devices and computers in the inventory\n","description":"Gets statistics about managed/unmanaged devices and computers in the inventory.\n","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryInformation"}}}}},"x-authentication-required":true}},"/v2/inventory-preload/csv":{"get":{"tags":["inventory-preload"],"summary":"Download all Inventory Preload records","description":"Returns all Inventory Preload records as a CSV file.\n\n> 📋 **Required privilege:** Read Inventory Preload Records","responses":{"200":{"description":"OK","headers":{"Content-Disposition":{"description":"A header field named `Content-Disposition` is returned with the file name contained in its value, which is always `inventory-preload-all.csv`.\n","style":"simple","explode":false,"schema":{"type":"string"}}},"content":{"text/csv":{"schema":{"type":"string","example":"Serial Number,Device Type,Full Name\nserial123,Computer,Test Name\n"}}}}},"x-required-privileges":["Read Inventory Preload Records"]},"post":{"tags":["inventory-preload"],"summary":"Create one or more new Inventory Preload records using CSV\n","description":"Create one or more new Inventory Preload records using CSV.\nA CSV template can be downloaded from /v2/inventory-preload/csv-template.\nSerial number and device type are required. All other fields are optional.\nWhen a matching serial number exists in the Inventory Preload data, the record will be overwritten with the CSV data.\nIf the CSV file contains a new username and an email address is provided, the new user is created in Jamf Pro.\nIf the CSV file contains an existing username, the following user-related fields are updated in Jamf Pro.\nFull Name,\nEmail Address,\nPhone Number,\nPosition.\nThis endpoint does not do full validation of each record in the CSV data.\nTo do full validation, use the `/v2/inventory-preload/csv-validate` endpoint first.\n\n\n> 📋 **Required privileges:**\n> - Create Inventory Preload Records\n> - Update Inventory Preload Records\n> - Create User\n> - Update User","requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"properties":{"file":{"type":"string","description":"The CSV file to upload","example":"serial number,device type,full name\nserial123,Computer,Test Name\n"}}}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HrefResponse"}}}}},"400":{"description":"Validation Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryPreloadCsvValidationError"}}}}},"x-required-privileges":["Create Inventory Preload Records","Update Inventory Preload Records","Create User","Update User"]}},"/v2/inventory-preload/csv-template":{"get":{"tags":["inventory-preload"],"summary":"Download the Inventory Preload CSV template","description":"Retrieves the Inventory Preload CSV file template.\n\n> 📋 **Required privilege:** Read Inventory Preload Records","responses":{"200":{"description":"OK","headers":{"Content-Disposition":{"description":"A header field named `Content-Disposition` is returned with the file name contained in its value, which is always `inventory-preload-template.csv`.\n","style":"simple","explode":false,"schema":{"type":"string"}}},"content":{"text/csv":{"schema":{"type":"string","example":"Serial Number,Device Type,Username,Full Name,Email Address"}}}}},"x-required-privileges":["Read Inventory Preload Records"]}},"/v2/inventory-preload/csv-validate":{"post":{"tags":["inventory-preload"],"summary":"Validate a given CSV file\n","description":"Validate a given CSV file.\nSerial number and device type are required. All other fields are optional.\nA CSV template can be downloaded from `/v2/inventory-preload/csv-template`.\n\n\n> 📋 **Required privilege:** Create Inventory Preload Records","requestBody":{"description":"Inventory Preload records to be validated. A CSV template can\nbe downloaded from `/v2/inventory-preload/csv-template`.\n","content":{"multipart/form-data":{"schema":{"required":["file"],"properties":{"file":{"type":"string","description":"The CSV file to upload","example":"serial number,device type,full name\nserial123,Computer,Test Name\n"}}}}},"required":true},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryPreloadCsvValidationSuccess"}}}},"400":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryPreloadCsvValidationError"}}}}},"x-required-privileges":["Create Inventory Preload Records"],"x-action":true}},"/v2/inventory-preload/ea-columns":{"get":{"tags":["inventory-preload"],"summary":"Retrieve a list of extension attribute columns\n","description":"Retrieve a list of extension attribute columns currently associated\nwith inventory preload records\n\n\n> 📋 **Required privilege:** Read Inventory Preload Records","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryPreloadExtensionAttributeColumnResult"}}}}},"x-required-privileges":["Read Inventory Preload Records"]}},"/v2/inventory-preload/export":{"post":{"tags":["inventory-preload"],"summary":"Export a collection of inventory preload records\n","description":"Export a collection of inventory preload records\n\n\n> 📋 **Required privilege:** Read Inventory Preload Records","parameters":[{"$ref":"#/components/parameters/export-fields"},{"$ref":"#/components/parameters/export-labels"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: `property:asc/desc`. Default sort\nis `id:asc`. Multiple sort criteria are supported and must be separated with\na comma. All inventory preload fields are supported, however fields added by\nextension attributes are not supported. If sorting by deviceType, use `0` for\nComputer and `1` for Mobile Device.\n\nExample: `sort=date:desc,name:asc`.\n","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}},{"name":"filter","in":"query","description":"Allowing to filter inventory preload records.\nDefault search is empty query - returning all results for the requested page.\nAll inventory preload fields are supported, however fields added by extension\nattributes are not supported. If filtering by deviceType, use `0` for Computer\nand `1` for Mobile Device.\n\nQuery in the RSQL format, allowing `==`, `!=`, `>`, `<`, and `=in=`.\n\nExample: `filter=categoryName==\"Category\"`\n","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"requestBody":{"description":"Optional. Override query parameters since they can make URI exceed 2,000 character limit.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportParameters"}}},"required":false},"responses":{"200":{"description":"Export successful","content":{"text/csv":{"schema":{"format":"binary","example":"Column 1,Column 2,Column 3\nserial123,data,user\nserial1234,additional data,user last\n"}}}},"503":{"description":"Unable to perform export operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Inventory Preload Records"],"x-action":true}},"/v2/inventory-preload/history":{"get":{"tags":["inventory-preload"],"summary":"Get Inventory Preload history entries\n","description":"Gets Inventory Preload history entries.\n\n> 📋 **Required privilege:** Read Inventory Preload Records","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: `property:asc/desc`. Default sort\nis `date:desc`. Multiple sort criteria are supported and must be separated\nwith a comma.\n\nExample: `sort=date:desc,name:asc`.\n","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["date:desc"]}},{"name":"filter","in":"query","description":"Allows filtering inventory preload history records.\nDefault search is empty query - returning all results for the requested page.\nAll inventory preload history fields are supported.\n\nQuery in the RSQL format, allowing `==`, `!=`, `>`, `<`, and `=in=`.\n\nExample: `filter=username==\"admin\"`\n","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistorySearchResults"}}}}},"x-required-privileges":["Read Inventory Preload Records"]},"post":{"tags":["inventory-preload"],"summary":"Add Inventory Preload history object notes","description":"Adds Inventory Preload history object notes.\n\n> 📋 **Required privilege:** Update Inventory Preload Records","requestBody":{"description":"History notes to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistoryNote"}}},"required":true},"responses":{"201":{"description":"Notes of Inventory Preload history were added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"503":{"description":"Inventory Preload history can not be saved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Inventory Preload Records"]}},"/v2/inventory-preload/records":{"get":{"tags":["inventory-preload"],"summary":"Return all Inventory Preload records","description":"Returns all Inventory Preload records.\n\n> 📋 **Required privilege:** Read Inventory Preload Records","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: `property:asc/desc`. Default sort\nis `id:asc`. Multiple sort criteria are supported and must be separated with\na comma. All inventory preload fields are supported, however fields added by\nextension attributes are not supported. If sorting by deviceType, use `0` for\nComputer and `1` for Mobile Device.\n\nExample: `sort=date:desc,name:asc`.\n","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}},{"name":"filter","in":"query","description":"Allowing to filter inventory preload records.\nDefault search is empty query - returning all results for the requested page.\nAll inventory preload fields are supported, however fields added by extension\nattributes are not supported. If filtering by deviceType, use `0` for Computer\nand `1` for Mobile Device.\n\nQuery in the RSQL format, allowing `==`, `!=`, `>`, `<`, and `=in=`.\n\nExample: `filter=categoryName==\"Category\"`\n","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryPreloadRecordSearchResultsV2"}}}}},"x-required-privileges":["Read Inventory Preload Records"]},"post":{"tags":["inventory-preload"],"summary":"Create a new Inventory Preload record using JSON","description":"Create a new Inventory Preload record using JSON.\n\n> 📋 **Required privilege:** Create Inventory Preload Records","requestBody":{"description":"Inventory Preload record to be created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryPreloadRecordV2"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Create Inventory Preload Records"]}},"/v2/inventory-preload/records/delete-all":{"post":{"tags":["inventory-preload"],"summary":"Delete all Inventory Preload records\n","description":"Deletes all Inventory Preload records.\n\n> 📋 **Required privilege:** Delete Inventory Preload Records","responses":{"204":{"description":"OK"}},"x-required-privileges":["Delete Inventory Preload Records"],"x-action":true}},"/v2/inventory-preload/records/{id}":{"get":{"tags":["inventory-preload"],"summary":"Get an Inventory Preload record","description":"Retrieves an Inventory Preload record.\n\n> 📋 **Required privilege:** Read Inventory Preload Records","parameters":[{"name":"id","in":"path","description":"Inventory Preload identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryPreloadRecordV2"}}}},"404":{"description":"Inventory Preload record with specified id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Inventory Preload Records"]},"put":{"tags":["inventory-preload"],"summary":"Update an Inventory Preload record","description":"Updates an Inventory Preload record.\n\n> 📋 **Required privilege:** Update Inventory Preload Records","parameters":[{"name":"id","in":"path","description":"Inventory Preload identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Inventory Preload record to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryPreloadRecordV2"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryPreloadRecordV2"}}}},"404":{"description":"Inventory Preload record with specified id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Inventory Preload Records"]},"delete":{"tags":["inventory-preload"],"summary":"Delete an Inventory Preload record\n","description":"Deletes an Inventory Preload record.\n\n> 📋 **Required privilege:** Delete Inventory Preload Records","parameters":[{"name":"id","in":"path","description":"Inventory Preload identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"OK"},"404":{"description":"Inventory Preload record with specified id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Delete Inventory Preload Records"]}},"/v1/jcds/files":{"get":{"tags":["jamf-cloud-distribution-service"],"summary":"Retrieve a list of files and file metadata from the Jamf Cloud Distribution Service","description":"Retrieve a list of files and file metadata from the Jamf Cloud Distribution Service.\n\n> 📋 **Required privilege:** Read Jamf Cloud Distribution Service Files","responses":{"200":{"description":"Retrieved the list of files and file metadata from the Jamf Cloud Distribution Service.","content":{"application/json":{"schema":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/FileData"}}}}}},"deprecated":true,"x-deprecation-date":"2025-08-28","x-authentication-required":true,"x-required-privileges":["Read Jamf Cloud Distribution Service Files"]},"post":{"tags":["jamf-cloud-distribution-service"],"summary":"Initiate an upload to the Jamf Cloud Distribution Service","description":"Creates a temporary record and returns the credentials and information needed for uploading the file to the Jamf Cloud Distribution Service.\n\n> 📋 **Required privilege:** Create Jamf Cloud Distribution Service Files","responses":{"201":{"description":"File upload was initiated to the Jamf Cloud Distribution Service.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credentials"}}}}},"deprecated":true,"x-deprecation-date":"2025-08-28","x-authentication-required":true,"x-required-privileges":["Create Jamf Cloud Distribution Service Files"],"x-action":true}},"/v1/jcds/files/{fileName}":{"get":{"tags":["jamf-cloud-distribution-service"],"summary":"Retrieve a download URL for a specific file from the Jamf Cloud Distribution Service","description":"Retrieve a download URL for a specific file from the Jamf Cloud Distribution Service.\n\n> 📋 **Required privilege:** Read Jamf Cloud Distribution Service Files","parameters":[{"name":"fileName","in":"path","description":"Name of the file stored in the Jamf Cloud Distribution Service.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The URL to download the file from was retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DownloadUrl"}}}}},"deprecated":true,"x-deprecation-date":"2025-08-28","x-authentication-required":true,"x-required-privileges":["Read Jamf Cloud Distribution Service Files"]},"delete":{"tags":["jamf-cloud-distribution-service"],"summary":"Delete a file from the Jamf Cloud Distribution Service","description":"Delete a file by filename from the Jamf Cloud Distribution Service.\n\n> 📋 **Required privilege:** Delete Jamf Cloud Distribution Service Files","parameters":[{"name":"fileName","in":"path","description":"Name of the file that will be deleted from the Jamf Cloud Distribution Service.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"File was deleted"}},"deprecated":true,"x-deprecation-date":"2025-08-28","x-authentication-required":true,"x-required-privileges":["Delete Jamf Cloud Distribution Service Files"]}},"/v1/jcds/refresh-inventory":{"post":{"tags":["jamf-cloud-distribution-service"],"summary":"Refreshes the inventory and status of uploads in Jamf Pro. This will update the \nstatus of uploads in the Jamf Pro database and allow the uploads to be deployed.\n","description":"Refreshes the inventory and status of uploads in Jamf Pro. This will update the \nstatus of uploads in the Jamf Pro database and allow the uploads to be deployed.\nUsing the filename as a query parameter will query JCDS for the availability of\nthe file using an exponential back-off during the allocated time period. If the\nfilename is not supplied, all inventory will be refreshed, and this action is\nlimited to once every 15 seconds.\n\n\n> 📋 **Required privilege:** Read Jamf Cloud Distribution Service Files","parameters":[{"name":"file-name","in":"query","description":"Name of the file to check the availability of in JCDS. If available, the inventory and status will be updated in Jamf Pro. If no file is specified, it will force an immediate inventory refresh at a rate-limit of once every 15 seconds.","required":false,"style":"form","explode":true,"schema":{"maxLength":255,"type":"string","example":"filename.pkg","default":""}}],"responses":{"204":{"description":"Inventory refresh completed."},"500":{"description":"Failure, unable to complete inventory refresh.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2025-08-28","x-authentication-required":true,"x-action":true,"x-required-privileges":["Read Jamf Cloud Distribution Service Files"]}},"/v1/jcds/renew-credentials":{"post":{"tags":["jamf-cloud-distribution-service"],"summary":"Renew credentials for an upload to the Jamf Cloud Distribution Service","description":"Renews the credentials needed for uploading the file to the Jamf Cloud Distribution Service.\n\n> 📋 **Required privilege:** Create Jamf Cloud Distribution Service Files","responses":{"200":{"description":"Credentials were renewed for an upload to the Jamf Cloud Distribution Service.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credentials"}}}}},"deprecated":true,"x-deprecation-date":"2025-08-28","x-authentication-required":true,"x-required-privileges":["Create Jamf Cloud Distribution Service Files"],"x-action":true}},"/v1/jamf-connect":{"get":{"tags":["jamf-connect"],"summary":"Get the Jamf Connect settings that you have access to see\n","description":"Get the Jamf Connect settings that you have access to see.\n\n> 📋 **Required privileges:**\n> - Read Jamf Connect Settings\n> - Read Jamf Connect Deployments","responses":{"204":{"description":"Success, no content."},"403":{"description":"Cloud Services Connection has not been established.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Jamf Connect Settings","Read Jamf Connect Deployments"]}},"/v1/jamf-connect/config-profiles":{"get":{"tags":["jamf-connect"],"summary":"Search for config profiles linked to Jamf Connect\n","description":"Search for config profiles linked to Jamf Connect\n\n> 📋 **Required privilege:** Read Jamf Connect Deployments","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"$ref":"#/components/parameters/sort"},{"$ref":"#/components/parameters/filter"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkedConnectProfileSearchResults"}}}}},"x-required-privileges":["Read Jamf Connect Deployments"]}},"/v1/jamf-connect/config-profiles/{id}":{"put":{"tags":["jamf-connect"],"summary":"Update the way the Jamf Connect app gets updated on computers within scope of the associated configuration profile.\n","description":"Update the way the Jamf Connect app gets updated on computers within scope of the associated configuration profile.\n\n> 📋 **Required privilege:** Update Jamf Connect Deployments","parameters":[{"name":"id","in":"path","description":"the UUID of the profile to update","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"24a7bb2a-9871-4895-9009-d1be07ed31b1"}],"requestBody":{"description":"Updatable Jamf Connect Settings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkedConnectProfile"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkedConnectProfile"}}}}},"x-required-privileges":["Update Jamf Connect Deployments"]}},"/v1/jamf-connect/deployments/{id}/tasks":{"get":{"tags":["jamf-connect"],"summary":"Search for deployment tasks for a config profile linked to Jamf Connect\n","description":"Search for config profiles linked to Jamf Connect\n\n> 📋 **Required privilege:** Read Jamf Connect Deployments","parameters":[{"name":"id","in":"path","description":"the UUID of the Jamf Connect deployment","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"24a7bb2a-9871-4895-9009-d1be07ed31b1"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"$ref":"#/components/parameters/sort"},{"$ref":"#/components/parameters/filter"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentTaskSearchResults"}}}}},"x-required-privileges":["Read Jamf Connect Deployments"]}},"/v1/jamf-connect/deployments/{id}/tasks/retry":{"post":{"tags":["jamf-connect"],"summary":"Request a retry of Connect install tasks\n","description":"Request a retry of Connect install tasks\n\n\n> 📋 **Required privilege:** Jamf Connect Deployment Retry","parameters":[{"name":"id","in":"path","description":"the UUID of the deployment associated with the retry","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"24a7bb2a-9871-4895-9009-d1be07ed31b1"}],"requestBody":{"description":"task IDs to retry","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ids"}}},"required":true},"responses":{"204":{"description":"Success, no content."},"400":{"description":"Cloud Services Connection has not been established.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Jamf Connect tasks to retry failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Jamf Connect Deployment Retry"]}},"/v1/jamf-connect/history":{"get":{"tags":["jamf-connect"],"summary":"Get Jamf Connect history\n","description":"Get Jamf Connect history\n\n\n> 📋 **Required privilege:** Read Jamf Connect Settings","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"$ref":"#/components/parameters/sort"},{"$ref":"#/components/parameters/filter"}],"responses":{"200":{"description":"Details of Jamf Connect history were found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistorySearchResults"}}}}},"x-required-privileges":["Read Jamf Connect Settings"]},"post":{"tags":["jamf-connect"],"summary":"Add Jamf Connect history notes\n","description":"Add Jamf Connect history notes\n\n\n> 📋 **Required privilege:** Update Jamf Connect Settings","requestBody":{"description":"history notes to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistoryNote"}}},"required":true},"responses":{"201":{"description":"Notes to Jamf Connect history were added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"503":{"description":"Jamf Connect history can not be saved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Jamf Connect Settings"]}},"/v1/jamf-management-framework/redeploy/{id}":{"post":{"tags":["jamf-management-framework"],"summary":"Redeploy Jamf Management Framework\n","description":"Redeploys the Jamf Management Framework for enrolled device\n\n\n> 📋 **Required privileges:**\n> - Send Computer Remote Command to Install Package\n> - Read Computer Check-In","parameters":[{"name":"id","in":"path","description":"instance id of computer","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"202":{"description":"Command successfully queued to redeploy the Jamf Managment Framework","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RedeployJamfManagementFrameworkResponse"}}}},"404":{"description":"Computer with given id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Send Computer Remote Command to Install Package","Read Computer Check-In"],"x-action":true}},"/v1/jamf-package":{"get":{"tags":["jamf-package"],"summary":"Get the packages for a given Jamf application\n","description":"Get the packages for a given Jamf application.\n\n> 📋 **Required privilege:** Jamf Packages Action","parameters":[{"name":"application","in":"query","description":"The Jamf Application key. The only supported values are protect and connect.","required":true,"style":"form","explode":true,"schema":{"type":"string"},"example":"protect"}],"responses":{"200":{"description":"List of packages for the given application.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/JamfPackageResponse"}}}}},"400":{"description":"Invalid Content. It is possible that there is no application with the given application id. Or Cloud Services Connection has not been established.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Jamf Packages Action"]}},"/v2/jamf-package":{"get":{"tags":["jamf-package"],"summary":"Get the packages for a given Jamf application\n","description":"Get the packages for a given Jamf application.\n\n> 📋 **Required privilege:** Jamf Packages Action","parameters":[{"name":"application","in":"query","description":"The Jamf Application key. The only supported values are protect and connect.","required":true,"style":"form","explode":true,"schema":{"type":"string"},"example":"protect"}],"responses":{"200":{"description":"Properties for the given application.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JamfApplicationResponse"}}}},"400":{"description":"Invalid Content. It is possible that there is no application with the given application id. Or Cloud Services Connection has not been established.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Jamf Packages Action"]}},"/v2/account-preferences":{"get":{"tags":["jamf-pro-account-preferences"],"summary":"Get Jamf Pro account preferences\n","description":"Get Jamf Pro account preferences\n","parameters":[{"name":"Accept-Language","in":"header","description":"Locale to be used.","required":false,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response - Jamf Pro Account Preferences retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountPreferencesV5"}}}}},"deprecated":true,"x-deprecation-date":"2025-06-30","x-authentication-required":true},"patch":{"tags":["jamf-pro-account-preferences"],"summary":"Update Jamf Pro account preferences\n","description":"Update Jamf Pro account preferences\n","parameters":[{"name":"Accept-Language","in":"header","description":"Locale to be used, when user has not defined preferred language.","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"JSESSIONID","in":"cookie","description":"Session cookie, that's used to determine user session where account preferences should be refreshed","required":false,"style":"form","explode":true,"schema":{"type":"string","default":"null"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountPreferencesV5"}}}},"responses":{"200":{"description":"Successful response - Jamf Pro Account Preferences updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountPreferencesV5"}}}},"400":{"description":"Jamf Pro account preferences not valid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2025-06-30","x-authentication-required":true}},"/v3/account-preferences":{"get":{"tags":["jamf-pro-account-preferences"],"summary":"Get Jamf Pro account preferences\n","description":"Get Jamf Pro account preferences\n","parameters":[{"name":"Accept-Language","in":"header","description":"Locale to be used.","required":false,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response - Jamf Pro Account Preferences retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountPreferencesV6"}}}}},"x-authentication-required":true},"patch":{"tags":["jamf-pro-account-preferences"],"summary":"Update Jamf Pro account preferences\n","description":"Update Jamf Pro account preferences\n","parameters":[{"name":"Accept-Language","in":"header","description":"Locale to be used, when user has not defined preferred language.","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"JSESSIONID","in":"cookie","description":"Session cookie, that's used to determine user session where account preferences should be refreshed","required":false,"style":"form","explode":true,"schema":{"type":"string","default":"null"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountPreferencesV6"}}}},"responses":{"204":{"description":"Successful response - Jamf Pro Account Preferences updated"},"400":{"description":"Jamf Pro account preferences not valid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-authentication-required":true}},"/v2/jamf-pro-information":{"get":{"tags":["jamf-pro-information"],"summary":"Get basic information about the Jamf Pro Server\n","description":"Get basic information about the Jamf Pro Server\n","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JamfProInformationV2"}}}}},"x-authentication-required":true}},"/v1/system/fedramp-initialize":{"post":{"tags":["jamf-pro-initialization"],"summary":"Set up a fresh installed Jamf Pro Server for FedRAMP\n","description":"Performs the fresh-install initialization of a FedRAMP instance: creates the initial federated\naccount, records the activation code and Jamf Pro URL, acknowledges the EULA, persists the tenant's\nOIDC broker (Keycloak) configuration UUID, and enables FedRAMP SSO.\nRun-once operation: allowed only on a FedRAMP instance, while no JSS users exist, the broker is\nenabled, and no broker UUID is already stored. Gated by the activation code, matching the sibling\ninit endpoints. Non-FedRAMP instances are rejected with INVALID_STATE.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FedRampBrokerInitializeV1"}}},"required":true},"responses":{"202":{"description":"Broker configuration UUID has been stored"},"400":{"description":"The following are codes returned by this call:\nINVALID_ACTIVATION_CODE - activation code provided is not valid or is expired\nINVALID_STATE - The system is in an invalid state to initialize the broker configuration.\nINVALID_FIELD - A field failed validation. The field name will be provided on the response.\nFIELD_REQUIRED - A required field was not provided. The field name will be provided on the response.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-authentication-required":false,"x-action":true}},"/v1/system/initialize":{"post":{"tags":["jamf-pro-initialization"],"summary":"Set up fresh installed Jamf Pro Server\n","description":"Set up fresh installed Jamf Pro Server\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitializeV1"}}},"required":true},"responses":{"202":{"description":"Jamf Pro Server has been initialized"},"400":{"description":"The following are codes returned by this call:\nINVALID_ACTIVATION_CODE - activation code provided is not valid or is expired\nINVALID_STATE - The system is in an invalid state to be initialized.\nFIELD_REQUIRED - A required field was not provided.  The field name will be provided on the response.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-authentication-required":false,"x-action":true}},"/v1/system/initialize-database-connection":{"post":{"tags":["jamf-pro-initialization"],"summary":"Provide Database Password during startup\n","description":"Provide database password during startup. Endpoint is accessible when database password was not configured and Jamf Pro server has not been initialized yet.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabasePassword"}}},"required":true},"responses":{"202":{"description":"OK"},"400":{"description":"Incorrect database password.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Limit of requests per second was exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-authentication-required":false,"x-action":true}},"/v1/system/platform-initialize":{"post":{"tags":["jamf-pro-initialization"],"summary":"Set up fresh installed Jamf Pro Server for Platform\n","description":"Set up fresh installed Jamf Pro Server with OIDC SSO enabled and single federated user\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformInitializeV1"}}},"required":true},"responses":{"202":{"description":"Jamf Pro Server has been initialized"},"400":{"description":"The following are codes returned by this call:\nINVALID_ACTIVATION_CODE - activation code provided is not valid or is expired\nINVALID_STATE - The system is in an invalid state to be initialized.\nFIELD_REQUIRED - A required field was not provided.  The field name will be provided on the response.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-authentication-required":false,"x-action":true}},"/v1/notifications":{"get":{"tags":["jamf-pro-notifications"],"summary":"Get Notifications for user and site\n","description":"Gets notifications for user and site\n","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NotificationV1"}}}}}},"x-authentication-required":true},"delete":{"tags":["jamf-pro-notifications"],"summary":"Dismiss all notifications\n","description":"Dismisses all dismissible notifications for the user and site.\n\n\n> 📋 **Required privilege:** Dismiss Notifications","responses":{"204":{"description":"Successful deletion"}},"x-required-privileges":["Dismiss Notifications"],"x-authentication-required":true}},"/v1/notifications/{type}/{id}":{"delete":{"tags":["jamf-pro-notifications"],"summary":"Delete Notifications\n","description":"Deletes notifications with given type and id.\n\n\n> 📋 **Required privilege:** Dismiss Notifications","parameters":[{"name":"id","in":"path","description":"instance ID of the notification","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"type","in":"path","description":"type of the notification","required":true,"style":"simple","explode":false,"schema":{"$ref":"#/components/schemas/NotificationType"}}],"responses":{"204":{"description":"Successful deletion"}},"x-required-privileges":["Dismiss Notifications"]}},"/v1/jamf-pro-server-url":{"get":{"tags":["jamf-pro-server-url-preview"],"summary":"Get Jamf Pro Server URL settings\n","description":"Get Jamf Pro Server URL settings\n\n> 📋 **Required privilege:** Read JSS URL","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JamfProServerUrl"}}}}},"x-required-privileges":["Read JSS URL"]},"put":{"tags":["jamf-pro-server-url-preview"],"summary":"Update Jamf Pro Server URL settings\n","description":"Update Jamf Pro Server URL settings\n\n> 📋 **Required privilege:** Update JSS URL","requestBody":{"description":"Jamf Pro Server URL settings object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JamfProServerUrl"}}},"required":true},"responses":{"200":{"description":"Jamf Pro Server URL settings updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JamfProServerUrl"}}}},"403":{"description":"Jamf Pro Server URL is managed by Jamf Cloud","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update JSS URL"]}},"/v1/jamf-pro-server-url/history":{"get":{"tags":["jamf-pro-server-url-preview"],"summary":"Get Jamf Pro Server URL settings history\n","description":"Gets Jamf Pro Server URL settings history\n\n> 📋 **Required privilege:** Read JSS URL","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/size"},{"$ref":"#/components/parameters/pagesize"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc ","required":false,"style":"form","explode":true,"schema":{"type":"string","default":"date:desc"}}],"responses":{"200":{"description":"Details of Jamf Pro Server URL settings history were found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistorySearchResults"}}}}},"x-required-privileges":["Read JSS URL"]},"post":{"tags":["jamf-pro-server-url-preview"],"summary":"Add Jamf Pro Server URL settings history notes\n","description":"Adds Jamf Pro Server URL settings history notes\n\n> 📋 **Required privilege:** Update JSS URL","requestBody":{"description":"History notes to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistoryNote"}}},"required":true},"responses":{"201":{"description":"Notes to Jamf Pro Server URL settings history were added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistory"}}}},"403":{"description":"Jamf Pro Server URL is managed by Jamf Cloud","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"Jamf Pro Server URL history does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update JSS URL"]}},"/v1/user/preferences/settings/{keyId}":{"get":{"tags":["jamf-pro-user-account-settings"],"summary":"Get the user preferences for the authenticated user and key.\n","description":"Gets the user preferences for the authenticated user and key.\n","parameters":[{"name":"keyId","in":"path","description":"user setting to be retrieved","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserPreferencesSettings"}}}}},"x-authentication-required":true}},"/v1/user/preferences/{keyId}":{"get":{"tags":["jamf-pro-user-account-settings"],"summary":"Get the user setting for the authenticated user and key\n","description":"Gets the user setting for the authenticated user and key.\n","parameters":[{"name":"keyId","in":"path","description":"user setting to be retrieved","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserPreferencesJson"}}}}},"x-authentication-required":true},"put":{"tags":["jamf-pro-user-account-settings"],"summary":"Persist the user setting\n","description":"Persists the user setting\n","parameters":[{"name":"keyId","in":"path","description":"unique key of user setting to be persisted","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"user setting value to be persisted","content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"description":"setting successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserPreferencesJson"}}}}},"x-authentication-required":true},"delete":{"tags":["jamf-pro-user-account-settings"],"summary":"Remove specified setting for authenticated user\n","description":"Remove specified setting for authenticated user\n","parameters":[{"name":"keyId","in":"path","description":"unique key of user setting to be persisted","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"setting was deleted"}},"x-authentication-required":true}},"/v1/jamf-pro-version":{"get":{"tags":["jamf-pro-version"],"summary":"Return information about the Jamf Pro including the current version\n","description":"Returns information about the Jamf Pro including the current version.\n","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JamfProVersion"}}}}},"x-authentication-required":true}},"/v1/jamf-protect":{"get":{"tags":["jamf-protect"],"summary":"Jamf Protect integration settings","description":"Jamf Protect integration settings\n\n> 📋 **Required privileges:**\n> - Read Jamf Protect Settings\n> - Read Jamf Protect Deployments","responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProtectSettingsResponse"}}}},"403":{"description":"Cloud Services Connection has not been established.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Protect Integration has not been configured.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Jamf Pro is not able to establish contact with the Protect API via the SOUP CSA client.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Jamf Protect Settings","Read Jamf Protect Deployments"]},"put":{"tags":["jamf-protect"],"summary":"Jamf Protect integration settings","description":"Jamf Protect integration settings\n\n> 📋 **Required privilege:** Update Jamf Protect Settings","requestBody":{"description":"Updatable Jamf Protect Settings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProtectUpdatableSettingsRequest"}}},"required":true},"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProtectSettingsResponse"}}}}},"x-required-privileges":["Update Jamf Protect Settings"]},"delete":{"tags":["jamf-protect"],"summary":"Delete Jamf Protect API registration.","description":"Deletes an existing Jamf Protect API registration if present. Jamf Protect API integration will be disabled.\n\n> 📋 **Required privilege:** Update Jamf Protect Settings","responses":{"204":{"description":"Success, No Content"},"400":{"description":"Cloud Services Connection has not been established.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Error Deleting registration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Jamf Protect Settings"]}},"/v1/jamf-protect/deployments/{id}/tasks":{"get":{"tags":["jamf-protect"],"summary":"Search for deployment tasks for a config profile linked to Jamf Protect\n","description":"Search for config profiles linked to Jamf Protect\n\n> 📋 **Required privilege:** Read Jamf Protect Deployments","parameters":[{"name":"id","in":"path","description":"the UUID of the Jamf Protect deployment","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"24a7bb2a-9871-4895-9009-d1be07ed31b1"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"$ref":"#/components/parameters/sort"},{"$ref":"#/components/parameters/filter"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentTaskSearchResults"}}}}},"x-required-privileges":["Read Jamf Protect Deployments"]}},"/v1/jamf-protect/deployments/{id}/tasks/retry":{"post":{"tags":["jamf-protect"],"summary":"Request a retry of Protect install tasks\n","description":"Request a retry of Protect install tasks\n\n\n> 📋 **Required privilege:** Jamf Protect Deployment Retry","parameters":[{"name":"id","in":"path","description":"the UUID of the deployment associated with the retry","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"24a7bb2a-9871-4895-9009-d1be07ed31b1"}],"requestBody":{"description":"task IDs to retry","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ids"}}},"required":true},"responses":{"204":{"description":"Success, no content."},"400":{"description":"Cloud Services Connection has not been established.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Jamf Protect tasks to retry failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Jamf Protect Deployment Retry"],"x-action":true}},"/v1/jamf-protect/history":{"get":{"tags":["jamf-protect"],"summary":"Get Jamf Protect history\n","description":"Get Jamf Protect history\n\n\n> 📋 **Required privilege:** Read Jamf Protect Settings","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"$ref":"#/components/parameters/sort"},{"$ref":"#/components/parameters/filter"}],"responses":{"200":{"description":"Details of Jamf Protect history were found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistorySearchResults"}}}}},"x-required-privileges":["Read Jamf Protect Settings"]},"post":{"tags":["jamf-protect"],"summary":"Add Jamf Protect history notes\n","description":"Add Jamf Protect history notes\n\n\n> 📋 **Required privilege:** Update Jamf Protect Settings","requestBody":{"description":"history notes to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistoryNote"}}},"required":true},"responses":{"201":{"description":"Notes to Jamf Protect history were added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"503":{"description":"Jamf Protect history can not be saved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Jamf Protect Settings"]}},"/v1/jamf-protect/plans":{"get":{"tags":["jamf-protect"],"summary":"Get all of the previously synced Jamf Protect Plans with information about their associated configuration profile","description":"Get all of the previously synced Jamf Protect Plans with information about their associated configuration profile\n\n> 📋 **Required privilege:** Read Jamf Protect Deployments","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"$ref":"#/components/parameters/sort"},{"$ref":"#/components/parameters/filter"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanSearchResults"}}}}},"x-required-privileges":["Read Jamf Protect Deployments"]}},"/v1/jamf-protect/plans/sync":{"post":{"tags":["jamf-protect"],"summary":"Sync Plans with Jamf Protect","description":"Sync Plans with Jamf Protect. Configuration profiles associated with new plans will be imported to Jamf Pro.\n\n> 📋 **Required privilege:** Read Jamf Protect Settings","responses":{"204":{"description":"Success."},"400":{"description":"Cloud Services Connection has not been established.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Protect API credentials have not been configured.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Jamf Protect Settings"],"x-action":true}},"/v1/jamf-protect/register":{"post":{"tags":["jamf-protect"],"summary":"Register a Jamf Protect API configuration with Jamf Pro","description":"Register a Jamf Protect API configuration with Jamf Pro\n\n> 📋 **Required privilege:** Update Jamf Protect Settings","requestBody":{"description":"Jamf Protect API connection information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProtectRegistrationRequest"}}},"required":true},"responses":{"201":{"description":"Successful registration.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProtectSettingsResponse"}}}},"400":{"description":"Cloud Services Connection has not been established.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Jamf Protect Settings"]}},"/v1/jamf-remote-assist/session":{"get":{"tags":["jamf-remote-assist"],"summary":"Gets session history items.\n","description":"Returns tenants sessions history.\n\n\n> 📋 **Required privilege:** Read Remote Assist","responses":{"200":{"description":"Up to 100 latest session history items","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SessionHistoryItem"}}}}},"403":{"description":"Jamf Remote Assist is not available on this instance.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Remote Assist"]}},"/v1/jamf-remote-assist/session/{id}":{"get":{"tags":["jamf-remote-assist"],"summary":"Gets single session history item.\n","description":"Returns tenants session history for specific session.\n\n\n> 📋 **Required privilege:** Read Remote Assist","parameters":[{"name":"id","in":"path","description":"instance id of session","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Single session history item","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionHistoryItemWithDetails"}}}},"403":{"description":"Jamf Remote Assist is not available on this instance.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Session history item not found. This may occur when the session with the given id does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Remote Assist"]}},"/v2/jamf-remote-assist/session":{"get":{"tags":["jamf-remote-assist"],"summary":"Gets session history items.\n","description":"Returns tenants sessions history.\n\n\n> 📋 **Required privilege:** Read Remote Assist","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is sessionId:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=sessionId:desc,deviceId:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["sessionId:desc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter session history items collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: sessionId, deviceId, sessionAdminId. This param can be combined with paging and sorting. Example: sessionAdminId==\"*Andrzej*\"","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Up to 100 latest session history items","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionHistorySearchResults"}}}},"403":{"description":"Jamf Remote Assist is not available on this instance.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Remote Assist"]}},"/v2/jamf-remote-assist/session/export":{"post":{"tags":["jamf-remote-assist"],"summary":"Export Jamf Remote Assist sessions history\n","description":"Export Jamf Remote Assist sessions history\n\n\n> 📋 **Required privilege:** Read Remote Assist","requestBody":{"description":"Optional. Override query parameters since they can make URI exceed 2,000 character limit.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportParameters"}}},"required":false},"responses":{"200":{"description":"Export successful","content":{"text/csv":{"schema":{"format":"binary","example":"sessionId,deviceId\nc4087bc8-cb48-4452-9bec-a3c50088a485,aeafd2ff95c7e0b937a8dbf3121a8dcab7a70161cd4493af038fa9c784b61866\nc4087bc8-cb48-4452-9bec-a3c50088a486,aeafd2ff95c7e0b937a8dbf3121a8dcab7a70161cd4493af038fa9c784b61867\nc4087bc8-cb48-4452-9bec-a3c50088a487,aeafd2ff95c7e0b937a8dbf3121a8dcab7a70161cd4493af038fa9c784b61868\n"}}}},"400":{"description":"Export fields specified incorrectly - non-existing column or duplicate on the list.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Jamf Remote Assist is not available on this instance.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"Export currently unavailable, all export-related resources are in use. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Remote Assist"],"x-action":true}},"/v2/jamf-remote-assist/session/{id}":{"get":{"tags":["jamf-remote-assist"],"summary":"Gets single session history item.\n","description":"Returns tenants session history for specific session.\n\n\n> 📋 **Required privilege:** Read Remote Assist","parameters":[{"name":"id","in":"path","description":"instance id of session","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Single session history item","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionHistoryItemWithDetails"}}}},"403":{"description":"Jamf Remote Assist is not available on this instance.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Session history item not found. This may occur when the session with the given id does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Remote Assist"]}},"/v1/last-login":{"get":{"tags":["last-login"],"summary":"Get the date of the last login event","description":"Returns the date of the last login event.\n\n> 📋 **Required privilege:** Read Last Login","responses":{"200":{"description":"Last login date returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LastLoginResponse"}}}},"204":{"description":"No last login information available."}},"x-required-privileges":["Read Last Login"],"x-authentication-required":true}},"/ldap/groups":{"get":{"tags":["ldap"],"summary":"Retrieve the configured access groups that contain the text in the search param\n","description":"Retrieves the configured access groups that contain the text in the searchParam.\n\n> 📋 **Required privilege:** Read LDAP Servers","parameters":[{"name":"q","in":"query","description":"Will perform a \"contains\" search on the names of access groups","required":false,"style":"form","explode":true,"schema":{"type":"string","default":"null"}}],"responses":{"200":{"description":"Successful search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LdapGroupSearchResults"}}}}},"x-required-privileges":["Read LDAP Servers"]}},"/ldap/servers":{"get":{"tags":["ldap"],"summary":"Retrieve all Servers including LDAP and Cloud Identity Providers.\n","description":"Retrieve all Servers including LDAP and Cloud Identity Providers.\n\n> 📋 **Required privilege:** Read LDAP Servers","responses":{"200":{"description":"Successfully completed.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LdapServer"}}}}}},"x-required-privileges":["Read LDAP Servers"]}},"/v1/ldap/groups":{"get":{"tags":["ldap"],"summary":"Retrieve the configured access groups that contain the text in the search param\n","description":"Retrieves the configured access groups that contain the text in the searchParam.\n\n> 📋 **Required privilege:** Read LDAP Servers","parameters":[{"name":"q","in":"query","description":"Will perform a \"contains\" search on the names of access groups","required":false,"style":"form","explode":true,"schema":{"type":"string","default":"null"}}],"responses":{"200":{"description":"Successful search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LdapGroupSearchResults"}}}}},"x-required-privileges":["Read LDAP Servers"]}},"/v1/ldap/ldap-servers":{"get":{"tags":["ldap"],"summary":"Retrieve all LDAP Servers.\n","description":"Retrieves all not migrated, LDAP Servers.\n\n> 📋 **Required privilege:** Read LDAP Servers","responses":{"200":{"description":"Successfully completed.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LdapServer"}}}}}},"x-required-privileges":["Read LDAP Servers"]}},"/v1/ldap/servers":{"get":{"tags":["ldap"],"summary":"Retrieve all Servers including LDAP and Cloud Identity Providers.\n","description":"Retrieve all active Servers including LDAP and Cloud Identity Providers.\n\n> 📋 **Required privilege:** Read LDAP Servers","responses":{"200":{"description":"Successfully completed.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LdapServer"}}}}}},"x-required-privileges":["Read LDAP Servers"]}},"/v2/local-admin-password/pending-rotations":{"get":{"tags":["local-admin-password"],"summary":"Get a list of the current devices and usernames with pending LAPS rotations","description":"Return information about all devices and usernames currently in the state of a pending LAPS rotation\n\n> 📋 **Required privilege:** View Local Admin Password","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LapsPendingRotationResponse"}}}},"500":{"description":"Failure, unable to complete lookup.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["View Local Admin Password"]}},"/v2/local-admin-password/settings":{"get":{"tags":["local-admin-password"],"summary":"Get the current LAPS settings.","description":"Return information about the current LAPS settings.\n\n> 📋 **Required privileges:**\n> - Read User-Initiated Enrollment\n> - Update Local Admin Password Settings","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LapsSettingsResponseV2"}}}},"500":{"description":"Failure, unable to complete lookup.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read User-Initiated Enrollment","Update Local Admin Password Settings"]},"put":{"tags":["local-admin-password"],"summary":"Update settings for LAPS.","description":"Update settings for LAPS.\n\n> 📋 **Required privilege:** Update Local Admin Password Settings","requestBody":{"description":"LAPS settings to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LapsSettingsRequestV2"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LapsSettingsResponseV2"}}}},"500":{"description":"Failure, unable to complete lookup.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Local Admin Password Settings"]}},"/v2/local-admin-password/{clientManagementId}/account/{username}/audit":{"get":{"tags":["local-admin-password"],"summary":"Get LAPS password viewed history.","description":"Get the full history of all local admin passwords for a specific username on a target device. History will include password, who viewed the password and when it was viewed. Get audit history by using the client management id and username as the path parameters. If multiple accounts with the same username exist, the MDM source will be selected by default.\n\n> 📋 **Required privilege:** View Local Admin Password Audit History","parameters":[{"name":"clientManagementId","in":"path","description":"client management id of target device.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"username","in":"path","description":"user name to view audit information for","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LapsPasswordAuditsResultsV2"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Failure, unable to complete lookup.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["View Local Admin Password Audit History"]}},"/v2/local-admin-password/{clientManagementId}/account/{username}/history":{"get":{"tags":["local-admin-password"],"summary":"Get LAPS historical records for target device and username.","description":"Get the full history of all for a specific username on a target device. History will include date created, date last seen, expiration time, and rotational status. Get audit history by using the client management id and username as the path parameters.\n\n> 📋 **Required privilege:** View Local Admin Password Audit History","parameters":[{"name":"clientManagementId","in":"path","description":"client management id of target device.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"username","in":"path","description":"user name to view history for","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LapsHistoryResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Failure, unable to complete lookup.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["View Local Admin Password Audit History"]}},"/v2/local-admin-password/{clientManagementId}/account/{username}/password":{"get":{"tags":["local-admin-password"],"summary":"Get current LAPS password for specified username on a client.","description":"Get current LAPS password for specified client by using the client management id and username as the path parameters. Once the password is viewed it will be rotated out with a new password based on the rotation time settings. If multiple accounts with the same username exist, the MDM source will be selected by default.\n\n> 📋 **Required privilege:** View Local Admin Password","parameters":[{"name":"clientManagementId","in":"path","description":"client management id of target device.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"username","in":"path","description":"user name for the account","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LapsPasswordResponseV2"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Failure, unable to complete lookup.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["View Local Admin Password"]}},"/v2/local-admin-password/{clientManagementId}/account/{username}/{guid}/audit":{"get":{"tags":["local-admin-password"],"summary":"Get LAPS password viewed history.","description":"Get the full history of all local admin passwords for a specific user guid on a target device. History will include password, who viewed the password and when it was viewed. Get audit history by using the client management id, username, and user guid as the path parameters.\n\n> 📋 **Required privilege:** View Local Admin Password Audit History","parameters":[{"name":"clientManagementId","in":"path","description":"client management id of target device.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"username","in":"path","description":"user name to view audit information for","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"guid","in":"path","description":"user guid to view audit information for","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LapsPasswordAuditsResultsV2"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Failure, unable to complete lookup.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["View Local Admin Password Audit History"]}},"/v2/local-admin-password/{clientManagementId}/account/{username}/{guid}/history":{"get":{"tags":["local-admin-password"],"summary":"Get LAPS historical records for target device and user guid.","description":"Get the full history of all for a specific user guid on a target device. History will include date created, date last seen, expiration time, and rotational status. Get audit history by using the client management id, username, and user guid as the path parameters.\n\n> 📋 **Required privilege:** View Local Admin Password Audit History","parameters":[{"name":"clientManagementId","in":"path","description":"client management id of target device.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"username","in":"path","description":"user name to view history for","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"guid","in":"path","description":"user guid to view history for","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LapsHistoryResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Failure, unable to complete lookup.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["View Local Admin Password Audit History"]}},"/v2/local-admin-password/{clientManagementId}/account/{username}/{guid}/password":{"get":{"tags":["local-admin-password"],"summary":"Get current LAPS password for specified user guid on a client.","description":"Get current LAPS password for specified client by using the client management id, username, and user guid as the path parameters. Once the password is viewed it will be rotated out with a new password based on the rotation time settings.\n\n> 📋 **Required privilege:** View Local Admin Password","parameters":[{"name":"clientManagementId","in":"path","description":"client management id of target device.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"username","in":"path","description":"user name for the account","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"guid","in":"path","description":"user guid for the account","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LapsPasswordResponseV2"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Failure, unable to complete lookup.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["View Local Admin Password"]}},"/v2/local-admin-password/{clientManagementId}/accounts":{"get":{"tags":["local-admin-password"],"summary":"Get the LAPS capable admin accounts for a device.","description":"Get a full list of admin accounts that are LAPS capable. Capable accounts are returned in the AutoSetupAdminAccounts from QueryResponses.\n\n> 📋 **Required privilege:** View Local Admin Password","parameters":[{"name":"clientManagementId","in":"path","description":"client management id of target device.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LapsUserResultsV2"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Failure, unable to complete lookup.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["View Local Admin Password"]}},"/v2/local-admin-password/{clientManagementId}/history":{"get":{"tags":["local-admin-password"],"summary":"Get LAPS password viewed history, and rotation history.","description":"Get the full history of all local admin passwords for all accounts for a specific management ID. History will include password, who viewed the password and when it was viewed. This will include rotation history as well.\n\n> 📋 **Required privilege:** View Local Admin Password Audit History","parameters":[{"name":"clientManagementId","in":"path","description":"client management id of target device.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LapsAccountManagementHistoryResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Failure, unable to complete lookup.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["View Local Admin Password Audit History"]}},"/v2/local-admin-password/{clientManagementId}/set-password":{"put":{"tags":["local-admin-password"],"summary":"Set the LAPS password for a device.","description":"Set the LAPS password for a device. This will set the password for all LAPS capable accounts.\n\n> 📋 **Required privilege:** Send Local Admin Password Command","parameters":[{"name":"clientManagementId","in":"path","description":"client management id of target device.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"LAPS password to set","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LapsUserPasswordRequestV2"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LapsUserPasswordResponseV2"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Failure, unable to update passwords","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Send Local Admin Password Command"]}},"/v1/locales":{"get":{"tags":["locales-preview"],"summary":"Return locales that can be used in other features\n","description":"Returns locales that can be used in other features.\n","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Locale"}}}}}},"x-authentication-required":false}},"/v1/log-flushing":{"get":{"tags":["log-flushing"],"summary":"Get log flushing settings","description":"Get all log flushing and retention policy settings\n\n> 📋 **Required privilege:** Read Retention Policy","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogFlushingV1"}}}}},"x-required-privileges":["Read Retention Policy"]}},"/v1/log-flushing/task":{"get":{"tags":["log-flushing"],"summary":"Get log flushing tasks","description":"Get a list of all log flushing tasks and their statuses\n\n> 📋 **Required privilege:** Read Retention Policy","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LogFlushingTaskV1"}}}}}},"x-required-privileges":["Read Retention Policy"]},"post":{"tags":["log-flushing"],"summary":"Queue a log flushing task","description":"Queue a log flushing task\n\n> 📋 **Required privilege:** Update Retention Policy","requestBody":{"description":"The manual log flushing settings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogFlushingTaskV1"}}}},"responses":{"202":{"description":"The log flushing request was queued","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"The request was rejected, typically because the service is stopping or stopped","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Retention Policy"],"x-action":true}},"/v1/log-flushing/task/{id}":{"get":{"tags":["log-flushing"],"summary":"Get log flushing task","description":"Get the log flushing task by the specified ID\n\n> 📋 **Required privilege:** Read Retention Policy","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogFlushingTaskV1"}}}}},"x-required-privileges":["Read Retention Policy"]},"delete":{"tags":["log-flushing"],"summary":"Cancels a log flushing task","description":"Cancels a log flushing task by ID\n\n> 📋 **Required privilege:** Update Retention Policy","responses":{"204":{"description":"Log flushing task successfully canceled"},"404":{"description":"Log flushing task not found"},"410":{"description":"Log flushing task already completed and is pending removal"}},"x-required-privileges":["Update Retention Policy"]},"parameters":[{"name":"id","in":"path","description":"The identifier of the log flushing task","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}]},"/v1/login-customization":{"get":{"tags":["login-customization"],"summary":"Get current login disclaimer settings","description":"Returns knob whether disclaimer is enabled and if saved, its contents.","responses":{"200":{"description":"Get Login Customization disclaimer settings.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginContent"}}}}},"x-authentication-required":true},"put":{"tags":["login-customization"],"summary":"Update current login disclaimer settings.","description":"Update current login disclaimer settings.\n\n> 📋 **Required privilege:** Update Login Disclaimer","requestBody":{"description":"Login disclaimer settings to save.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginContentPut"}}},"required":true},"responses":{"200":{"description":"Update login customization disclaimer settings.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginContentPut"}}}}},"x-authentication-required":true,"x-required-privileges":["Update Login Disclaimer"]}},"/v1/m2m/tenant-id":{"get":{"tags":["m2m"],"summary":"Returns the M2M-sourced tenant ID.","description":"Returns the M2M-sourced tenant ID.","responses":{"200":{"description":"M2M-sourced tenant ID is returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/M2mTenantIdInfo"}}}}},"x-authentication-required":true}},"/v1/macos-managed-software-updates/available-updates":{"get":{"tags":["macos-managed-software-updates"],"summary":"Retrieve available MacOs Managed Software Updates","description":"Retrieves available MacOs Managed Software Updates","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AvailableUpdates"}}}}},"deprecated":true,"x-deprecation-date":"2022-12-14","x-authentication-required":true}},"/v1/macos-managed-software-updates/send-updates":{"post":{"tags":["macos-managed-software-updates"],"summary":"Send MacOs Managed Software Updates","description":"Sends MacOs Managed Software Updates\n\n> 📋 **Required privilege:** Send Computer Remote Command to Download and Install OS X Update","requestBody":{"description":"MacOs Managed Software Update to send","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MacOsManagedSoftwareUpdate"},"examples":{"MacOsManagedSoftwareUpdateDeviceIds":{"value":{"deviceIds":["1","2","3","4"],"maxDeferrals":7,"version":"12.0.1","skipVersionVerification":false,"applyMajorUpdate":false,"updateAction":"DOWNLOAD_AND_INSTALL","forceRestart":false,"priority":"HIGH"}},"MacOsManagedSoftwareUpdateGroupId":{"value":{"groupId":1,"maxDeferrals":7,"version":"12.0.1","skipVersionVerification":false,"applyMajorUpdate":false,"updateAction":"DOWNLOAD_AND_INSTALL","forceRestart":false,"priority":"HIGH"}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MacOsManagedSoftwareUpdateResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2022-10-17","x-required-privileges":["Send Computer Remote Command to Download and Install OS X Update"],"x-action":true}},"/v1/managed-software-updates/available-updates":{"get":{"tags":["managed-software-updates"],"summary":"Retrieve available macOS and iOS Managed Software Updates","description":"Retrieves available macOS and iOS Managed Software Updates\n","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AvailableOsUpdates"}}}}},"x-authentication-required":true}},"/v1/managed-software-updates/plans":{"get":{"tags":["managed-software-updates"],"summary":"Retrieve Managed Software Update Plans","description":"Retrieve Managed Software Update Plans\n\n\n> 📋 **Required privileges:**\n> - Read Managed Software Updates\n> - Read Computers\n> - Read Mobile Devices","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is planUuid:asc. Multiple sort criteria are supported and must be separated with a comma.","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["planUuid:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter Managed Software Updates collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: planUuid, device.deviceId, device.objectType, updateAction, versionType, specificVersion, maxDeferrals, recipeId, forceInstallLocalDateTime, state.","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedSoftwareUpdatePlans"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Managed Software Updates","Read Computers","Read Mobile Devices"]},"post":{"tags":["managed-software-updates"],"summary":"Create a Managed Software Update Plan","description":"Creates a Managed Software Update Plan.\n\n\n> 📋 **Required privileges:**\n> - Create Managed Software Updates\n> - Read Computers\n> - Read Mobile Devices\n> - Send Computer Remote Command to Download and Install OS X Update\n> - Send Mobile Device Remote Command to Download and Install iOS Update","requestBody":{"description":"Managed Software Update Plan to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedSoftwareUpdatePlanPost"}}},"required":true},"responses":{"201":{"description":"Managed Software Update Plan was created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedSoftwareUpdatePlanPostResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Create Managed Software Updates","Read Computers","Read Mobile Devices","Send Computer Remote Command to Download and Install OS X Update","Send Mobile Device Remote Command to Download and Install iOS Update"],"x-rate-limit":true}},"/v1/managed-software-updates/plans/feature-toggle":{"get":{"tags":["managed-software-updates"],"summary":"Retrieve current value of the Feature Toggle","description":"Retrieves current value of the Feature Toggle\n\n\n> 📋 **Required privilege:** Read Managed Software Updates","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedSoftwareUpdatePlanToggle"}}}}},"x-required-privileges":["Read Managed Software Updates"]},"put":{"tags":["managed-software-updates"],"summary":"Updates Feature Toggle Value","description":"Updates the value of the Feature Toggle - This endpoint is asynchronous, the provided value will not be immediately updated. Please use the following endpoint to track the status of your toggle request. /v1/managed-software-updates/plans/feature-toggle/status:\n\n\n> 📋 **Required privileges:**\n> - Read Managed Software Updates\n> - Create Managed Software Updates\n> - Update Managed Software Updates","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedSoftwareUpdatePlanToggle"}}},"required":true},"responses":{"200":{"description":"Managed Software Update Plan Feature Toggle was updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedSoftwareUpdatePlanToggle"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Managed Software Updates","Create Managed Software Updates","Update Managed Software Updates"]}},"/v1/managed-software-updates/plans/feature-toggle/abandon":{"post":{"tags":["managed-software-updates"],"summary":"Force stops any ongoing or stalled feature-toggle processes","description":"\"Break Glass\" endpoint, not for nominal usage.\nUse this endpoint to forcefully abandon the feature-toggle background process if the status of the feature-toggle is 'stuck' or has reached an non-restartable failed state.\nUsage of this endpoint under nominal conditions is undefined and unsupported.\n\n\n> 📋 **Required privileges:**\n> - Read Managed Software Updates\n> - Create Managed Software Updates\n> - Update Managed Software Updates","responses":{"204":{"description":"Managed Software Update Plan Feature Toggle abandon request was received"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-action":true,"x-required-privileges":["Read Managed Software Updates","Create Managed Software Updates","Update Managed Software Updates"]}},"/v1/managed-software-updates/plans/feature-toggle/status":{"get":{"tags":["managed-software-updates"],"summary":"Retrieves background status of the Feature Toggle","description":"Retrieves background status of the Feature Toggle\n\n\n> 📋 **Required privilege:** Read Managed Software Updates","responses":{"200":{"description":"Managed Software Update Plan Feature Toggle Status was retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedSoftwareUpdatePlanToggleStatusWrapper"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Managed Software Updates"]}},"/v1/managed-software-updates/plans/group":{"post":{"tags":["managed-software-updates"],"summary":"Create Managed Software Update Plans for a Group","description":"Creates Managed Software Update Plans for a Group\n\n\n> 📋 **Required privileges:**\n> - Create Managed Software Updates\n> - Read Computers\n> - Read Mobile Devices\n> - Read Smart Computer Groups\n> - Read Static Computer Groups\n> - Read Smart Mobile Device Groups\n> - Read Static Mobile Device Groups\n> - Send Computer Remote Command to Download and Install OS X Update\n> - Send Mobile Device Remote Command to Download and Install iOS Update","requestBody":{"description":"Managed Software Update Plan to create for Group","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedSoftwareUpdatePlanGroupPost"}}},"required":true},"responses":{"201":{"description":"Managed Software Update Plan was created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedSoftwareUpdatePlanPostResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"A group with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Create Managed Software Updates","Read Computers","Read Mobile Devices","Read Smart Computer Groups","Read Static Computer Groups","Read Smart Mobile Device Groups","Read Static Mobile Device Groups","Send Computer Remote Command to Download and Install OS X Update","Send Mobile Device Remote Command to Download and Install iOS Update"],"x-rate-limit":true}},"/v1/managed-software-updates/plans/group/{id}":{"get":{"tags":["managed-software-updates"],"summary":"Retrieve Managed Software Update Plans for a Group","description":"Retrieves Managed Software Update Plans for a Group\n\n\n> 📋 **Required privileges:**\n> - Read Managed Software Updates\n> - Read Computers\n> - Read Smart Computer Groups\n> - Read Static Computer Groups\n> - Read Mobile Devices\n> - Read Smart Mobile Device Groups\n> - Read Static Mobile Device Groups","parameters":[{"name":"id","in":"path","description":"Managed Software Update Group Id","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"group-type","in":"query","description":"Managed Software Update Group Type, Available options are \"COMPUTER_GROUP\" or \"MOBILE_DEVICE_GROUP\"","required":true,"style":"form","explode":true,"schema":{"type":"string","enum":["COMPUTER_GROUP","MOBILE_DEVICE_GROUP"]},"example":"COMPUTER_GROUP"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedSoftwareUpdatePlans"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Group with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Managed Software Updates","Read Computers","Read Smart Computer Groups","Read Static Computer Groups","Read Mobile Devices","Read Smart Mobile Device Groups","Read Static Mobile Device Groups"]}},"/v1/managed-software-updates/plans/{id}":{"get":{"tags":["managed-software-updates"],"summary":"Retrieve a Managed Software Update Plan","description":"Retrieves a Managed Software Update Plan\n\n\n> 📋 **Required privileges:**\n> - Read Managed Software Updates\n> - Read Computers\n> - Read Mobile Devices","parameters":[{"name":"id","in":"path","description":"Managed Software Update Plan Uuid","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedSoftwareUpdatePlan"}}}},"404":{"description":"Managed Software Update Plan with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Managed Software Updates","Read Computers","Read Mobile Devices"]}},"/v1/managed-software-updates/plans/{id}/declarations":{"get":{"tags":["managed-software-updates"],"summary":"Retrieve all Declarations associated with a Managed Software Update Plan","description":"Retrieves all Declarations associated with a Managed Software Update Plan\n\n\n> 📋 **Required privileges:**\n> - Read Managed Software Updates\n> - Read Computers\n> - Read Mobile Devices","parameters":[{"name":"id","in":"path","description":"Managed Software Update Plan Uuid","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DssDeclarations"}}}},"404":{"description":"Managed Software Update Plan with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Managed Software Updates","Read Computers","Read Mobile Devices"]}},"/v1/managed-software-updates/plans/{id}/events":{"get":{"tags":["managed-software-updates"],"summary":"Retrieve a Managed Software Update Plan Event Store","description":"Retrieves a Managed Software Update Plan Event Store\n\n\n> 📋 **Required privileges:**\n> - Read Managed Software Updates\n> - Read Computers\n> - Read Mobile Devices","parameters":[{"name":"id","in":"path","description":"Managed Software Update Plan Uuid","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedSoftwareUpdatePlanEventStore"}}}},"404":{"description":"Managed Software Update Plan with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Managed Software Updates","Read Computers","Read Mobile Devices"]}},"/v1/managed-software-updates/update-statuses":{"get":{"tags":["managed-software-updates"],"summary":"Retrieve Managed Software Update Statuses","description":"Retrieve Managed Software Update Statuses\n\n\n> 📋 **Required privileges:**\n> - Read Computers\n> - Read Mobile Devices","parameters":[{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter Managed Software Updates collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: osUpdatesStatusId, device.deviceId, device.objectType, downloaded, downloadPercentComplete, productKey, status, deferralsRemaining, maxDeferrals, nextScheduledInstall, created and updated.","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedSoftwareUpdateStatuses"},"examples":{"ComputerManagedSoftwareUpdateStatus":{"value":{"results":[{"osUpdatesStatusId":"1","device":{"deviceId":1,"objectType":"COMPUTER","href":"/v1/computers-inventory/1"},"downloadPercentComplete":0.8,"downloaded":true,"productKey":"macOSUpdate19F77","status":"DOWNLOADING","deferralsRemaining":5,"maxDeferrals":5,"nextScheduledInstall":"2022-12-25T21:09:31.661Z","pastNotifications":["2022-12-22T21:09:31.661Z","2022-12-23T21:09:31.661Z","2022-12-24T21:09:31.661Z"],"created":"2022-12-22T21:09:00.661Z","updated":"2022-12-24T21:09:31.661Z"}],"totalCount":1}},"MobileDeviceManagedSoftwareUpdateStatus":{"value":{"results":[{"osUpdatesStatusId":"1","device":{"deviceId":1,"objectType":"MOBILE_DEVICE","href":"/v2/mobile-devices/1"},"downloadPercentComplete":0.8,"downloaded":true,"productKey":"iOSUpdate19F77","status":"DOWNLOADING","created":"2022-12-22T21:09:00.661Z","updated":"2022-12-22T21:09:00.661Z"}],"totalCount":1}}}}}}},"x-required-privileges":["Read Computers","Read Mobile Devices"]}},"/v1/managed-software-updates/update-statuses/computer-groups/{id}":{"get":{"tags":["managed-software-updates"],"summary":"Retrieve Managed Software Update Statuses for Computer Groups","description":"Retrieve Managed Software Update Statuses for Computer Groups\n\n\n> 📋 **Required privileges:**\n> - Read Computers\n> - Read Smart Computer Groups\n> - Read Static Computer Groups","parameters":[{"name":"id","in":"path","description":"Computer Group identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedSoftwareUpdateStatuses"},"examples":{"ComputerManagedSoftwareUpdateStatus":{"value":{"results":[{"osUpdatesStatusId":"1","device":{"deviceId":1,"objectType":"COMPUTER","href":"/v1/computers-inventory/1"},"downloadPercentComplete":0.8,"downloaded":true,"productKey":"macOSUpdate19F77","status":"DOWNLOADING","deferralsRemaining":5,"maxDeferrals":5,"nextScheduledInstall":"2022-12-25T21:09:31.661Z","pastNotifications":["2022-12-22T21:09:31.661Z","2022-12-23T21:09:31.661Z","2022-12-24T21:09:31.661Z"],"created":"2022-12-22T21:09:00.661Z","updated":"2022-12-24T21:09:31.661Z"}],"totalCount":1}}}}}}},"x-required-privileges":["Read Computers","Read Smart Computer Groups","Read Static Computer Groups"]}},"/v1/managed-software-updates/update-statuses/computers/{id}":{"get":{"tags":["managed-software-updates"],"summary":"Retrieve Managed Software Update Statuses for Computers","description":"Retrieve Managed Software Update Statuses for Computers\n\n\n> 📋 **Required privilege:** Read Computers","parameters":[{"name":"id","in":"path","description":"Computer identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedSoftwareUpdateStatuses"},"examples":{"ComputerManagedSoftwareUpdateStatus":{"value":{"results":[{"osUpdatesStatusId":"1","device":{"deviceId":1,"objectType":"COMPUTER","href":"/v1/computers-inventory/1"},"downloadPercentComplete":0.8,"downloaded":true,"productKey":"macOSUpdate19F77","status":"DOWNLOADING","deferralsRemaining":5,"maxDeferrals":5,"nextScheduledInstall":"2022-12-25T21:09:31.661Z","pastNotifications":["2022-12-22T21:09:31.661Z","2022-12-23T21:09:31.661Z","2022-12-24T21:09:31.661Z"],"created":"2022-12-22T21:09:00.661Z","updated":"2022-12-24T21:09:31.661Z"}],"totalCount":1}}}}}}},"x-required-privileges":["Read Computers"]}},"/v1/managed-software-updates/update-statuses/mobile-device-groups/{id}":{"get":{"tags":["managed-software-updates"],"summary":"Retrieve Managed Software Update Statuses for Mobile Device Groups","description":"Retrieve Managed Software Update Statuses for Mobile Device Groups\n\n\n> 📋 **Required privileges:**\n> - Read Mobile Devices\n> - Read Smart Mobile Device Groups\n> - Read Static Mobile Device Groups","parameters":[{"name":"id","in":"path","description":"Mobile Device Group identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedSoftwareUpdateStatuses"},"examples":{"MobileDeviceManagedSoftwareUpdateStatus":{"value":{"results":[{"osUpdatesStatusId":"1","device":{"deviceId":1,"objectType":"MOBILE_DEVICE","href":"/v2/mobile-devices/1"},"downloadPercentComplete":0.8,"downloaded":true,"productKey":"iOSUpdate19F77","status":"DOWNLOADING","created":"2022-12-22T21:09:00.661Z","updated":"2022-12-22T21:09:00.661Z"}],"totalCount":1}}}}}}},"x-required-privileges":["Read Mobile Devices","Read Smart Mobile Device Groups","Read Static Mobile Device Groups"]}},"/v1/managed-software-updates/update-statuses/mobile-devices/{id}":{"get":{"tags":["managed-software-updates"],"summary":"Retrieve Managed Software Update Statuses for Mobile Devices","description":"Retrieve Managed Software Update Statuses for Mobile Devices\n\n\n> 📋 **Required privilege:** Read Mobile Devices","parameters":[{"name":"id","in":"path","description":"Mobile Device identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedSoftwareUpdateStatuses"},"examples":{"MobileDeviceManagedSoftwareUpdateStatus":{"value":{"results":[{"osUpdatesStatusId":"1","device":{"deviceId":1,"objectType":"MOBILE_DEVICE","href":"/v2/mobile-devices/1"},"downloadPercentComplete":0.8,"downloaded":true,"productKey":"iOSUpdate19F77","status":"DOWNLOADING","created":"2022-12-22T21:09:00.661Z","updated":"2022-12-22T21:09:00.661Z"}],"totalCount":1}}}}}}},"x-required-privileges":["Read Mobile Devices"]}},"/v1/deploy-package":{"post":{"tags":["mdm"],"summary":"Deploy packages using MDM","description":"Deploys packages to macOS devices using the InstallEnterpriseApplication MDM command.\n\n> 📋 **Required privilege:** Send Computer Remote Command to Install Package","parameters":[{"name":"verbose","in":"query","description":"Enables the 'verbose' response, which includes information about the commands queued as well as information about commands that failed to queue.","required":false,"style":"form","explode":true,"schema":{"type":"boolean","default":false},"example":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstallPackage"}}},"required":true},"responses":{"200":{"description":"Package deployment was successfully processed. See response body for further information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerbosePackageDeploymentResponse"}}}},"202":{"description":"Package deployment was queued up"},"403":{"description":"Insufficient privileges to perform this action or Package Deployment is not enabled."}},"x-required-privileges":["Send Computer Remote Command to Install Package"],"x-action":true}},"/v1/mdm/commands":{"get":{"tags":["mdm"],"summary":"Get information about mdm commands made by Jamf Pro.","description":"Get information about mdm commands made by Jamf Pro.\n\n> 📋 **Required privilege:** View MDM command information in Jamf Pro API","parameters":[{"name":"uuids","in":"query","description":"A list of the UUIDs of the commands being searched for.  Limited to 40 UUIDs in length. Choose one of two parameters, but not both.","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"client-management-id","in":"query","description":"The client management id used to search for a list of commands. Choose one of two parameters, but not both.","required":false,"style":"form","explode":true,"schema":{"type":"string","example":"fd68c371-5921-436e-b16b-8a3c1bf90ee5"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MdmCommand"}}}}},"414":{"description":"Too many UUIDs were provided in the path. The limit is set at a strict 40 UUIDs.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Failure, unable to complete lookup.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-required-privileges":["View MDM command information in Jamf Pro API"],"x-deprecation-date":"2023-10-16"}},"/v1/mdm/renew-profile":{"post":{"tags":["mdm"],"summary":"Renew MDM Profile\n","description":"Renews the device's MDM Profile, including the device identity certificate within the MDM Profile.\n\n\n> 📋 **Required privilege:** Send Command to Renew MDM Profile","requestBody":{"description":"List of devices' UDIDs to perform MDM profile renewal","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Udids"}}},"required":true},"responses":{"202":{"description":"The Renew MDM Profile action was queued with APNs for submitted devices. Any device udids returned were unknown and not submitted.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenewMdmProfileResponse"}}}},"403":{"description":"Insufficient privileges to perform this action or Renew MDM Profile is not enabled."}},"x-required-privileges":["Send Command to Renew MDM Profile"],"x-action":true}},"/v2/mdm/blank-push":{"post":{"tags":["mdm"],"summary":"Send blank push notifications to a list of client management IDs.","description":"Accepts a list of client management IDs and sends a blank push notification to each. Returns a list of UUIDs that encountered errors.\n\n> 📋 **Required privilege:** View MDM command information in Jamf Pro API","requestBody":{"description":"A list of client management IDs to send push notifications to.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlankPushRequest"}}},"required":true},"responses":{"200":{"description":"Push notifications sent successfully, with a list of UUIDs that encountered errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlankPushResponse"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["View MDM command information in Jamf Pro API"],"x-action":true}},"/v2/mdm/commands":{"get":{"tags":["mdm"],"summary":"Get information about mdm commands made by Jamf Pro.\n","description":"Get information about mdm commands made by Jamf Pro.\n\n> 📋 **Required privilege:** View MDM command information in Jamf Pro API","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Default sort is dateSent:asc. Multiple sort criteria are supported and must be separated with a comma.","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["dateSent:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter, for a list of commands. All url must contain minimum one filter field. Fields allowed in the query: uuid, clientManagementId, command, status, clientType, dateSent, validAfter, dateCompleted, profileId, profileIdentifier, and active. This param can be combined with paging. Please note that any date filters must be used with gt, lt, ge, le Example: clientManagementId==fb511aae-c557-474f-a9c1-5dc845b90d0f;status==Pending;command==INSTALL_PROFILE;uuid==9e18f849-e689-4f2d-b616-a99d3da7db42;clientType==COMPUTER_USER;profileId==1;profileIdentifier==18cc61c2-01fc-11ed-b939-0242ac120002;dateCompleted=ge=2021-08-04T14:25:18.26Z;dateCompleted=le=2021-08-04T14:25:18.26Z;validAfter=ge=2021-08-05T14:25:18.26Z;active==true","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MdmCommandResults"}}}},"500":{"description":"Failure, unable to complete lookup.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["View MDM command information in Jamf Pro API"]},"post":{"tags":["mdm"],"summary":"Post a command for creation and queuing\n","description":"Provided an MDM command type and appropriate information, will create and then queue said command. A separate privilege is required for each device type and MDM command you want to view or send.\n\n> 📋 **Required privilege:** View MDM command information in Jamf Pro API","requestBody":{"description":"The mdm command object to create and queue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MdmCommandRequest"}}}},"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HrefResponse"}}}}},"500":{"description":"Failure, unable to queue command.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["View MDM command information in Jamf Pro API"],"x-action":true}},"/v1/mdm-renewal/device-common-details":{"patch":{"tags":["mdm-renewal"],"summary":"Update device common details (partial update)\n","description":"Partially updates existing device common details. The clientManagementId must be provided in the request body to identify which record to update. Only updates fields that are explicitly provided in the request - missing fields preserve their existing values. Only updates existing records; does not create new ones.\n\n\n> 📋 **Required privilege:** Send Command to Renew MDM Profile","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceCommonDetailsRequest"}}},"required":true},"responses":{"204":{"description":"Successfully updated device common details"},"400":{"description":"Invalid request data (missing or invalid clientManagementId, etc.)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"No existing device common details found for the specified clientManagementId","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Send Command to Renew MDM Profile"]}},"/v1/mdm-renewal/device-common-details/{clientManagementId}":{"get":{"tags":["mdm-renewal"],"summary":"Get device common details for a client management ID\n","description":"Retrieves device common details associated with a specific client management ID\n\n\n> 📋 **Required privilege:** Send Command to Renew MDM Profile","parameters":[{"name":"clientManagementId","in":"path","description":"The client management ID to retrieve device common details for","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"550e8400-e29b-41d4-a716-446655440000"}}],"responses":{"200":{"description":"Successfully retrieved device common details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceCommonDetails"}}}},"400":{"description":"Invalid client management ID format","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"No device common details found for the specified client management ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Send Command to Renew MDM Profile"]}},"/v1/mdm-renewal/renewal-strategies/{clientManagementId}":{"get":{"tags":["mdm-renewal"],"summary":"Get MDM renewal errors and strategies for a client management ID\n","description":"Retrieves all MDM renewal errors and their associated renewal strategies for a specific client management ID\n\n\n> 📋 **Required privilege:** Send Command to Renew MDM Profile","parameters":[{"name":"clientManagementId","in":"path","description":"The client management ID to retrieve renewal strategies for","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"550e8400-e29b-41d4-a716-446655440000"}}],"responses":{"200":{"description":"Successfully retrieved MDM renewal errors and strategies","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MdmRenewalErrorStrategiesResponse"}}}}},"400":{"description":"Invalid client management ID format","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"No MDM renewal errors found for the specified client management ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Send Command to Renew MDM Profile"]},"delete":{"tags":["mdm-renewal"],"summary":"Delete MDM renewal strategies for a client management ID\n","description":"Deletes all MDM renewal strategies and errors associated with the specified client management ID\n\n\n> 📋 **Required privilege:** Send Command to Renew MDM Profile","parameters":[{"name":"clientManagementId","in":"path","description":"The client management ID to delete renewal strategies for","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"550e8400-e29b-41d4-a716-446655440000"}}],"responses":{"204":{"description":"Successfully deleted MDM renewal strategies and errors"},"400":{"description":"Invalid client management ID format","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Send Command to Renew MDM Profile"]}},"/v1/mobile-device-apps/reinstall-app-config":{"post":{"tags":["mobile-device-apps"],"summary":"Reinstall App Config for Managed iOS Apps\n","description":"Redeploys the managed app configuration for a specific app on a specific device using the $APP_CONFIG_REINSTALL_CODE generated during deployment. \nThis endpoint does not require authorization, only the re-install code. The code does not contain any user authentication information. \nFor example usage, see the following Teacher app documentation: [Teacher App Manged App Configuration](https://learn.jamf.com/bundle/jamf-teacher-configuration-guide/page/Jamf_Teacher_Integration_with_Jamf_Pro.html)\n","requestBody":{"description":"The $APP_CONFIG_REINSTALL_CODE variable for the specific device and app supplied by the managed iOS app's current App Config.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppConfigReinstallCode"}}},"required":true},"responses":{"204":{"description":"Install App Config command successfully issued"},"400":{"description":"Supplied re-install code was either invalid or not supplied"}},"x-authentication-required":false,"x-action":true}},"/v1/mobile-device-enrollment-profile/{id}/download-profile":{"get":{"tags":["mobile-device-enrollment-profile"],"summary":"Retrieve the MDM Enrollment Profile\n","description":"Retrieve the MDM Enrollment Profile\n\n> 📋 **Required privilege:** Read Enrollment Profiles","parameters":[{"name":"id","in":"path","description":"MDM Enrollment Profile identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/x-apple-aspen-config":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"Not Found"}},"x-required-privileges":["Read Enrollment Profiles"]}},"/v1/mobile-device-extension-attributes":{"get":{"tags":["mobile-device-extension-attributes"],"summary":"Retrieve Mobile Device Extension Attributes.","description":"Retrieves all mobile device extension attributes configuration.\n\n> 📋 **Required privilege:** Read Mobile Device Extension Attributes","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorts results by one or more criteria, following the format property:asc/desc.<br/> Default sort is name:asc.<br/> If using multiple criteria, separate with commas. Allows sort for id and name.","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["name.asc"]}},{"name":"filter","in":"query","description":"Filters results. Use RSQL format for query. Allows for many fields, including ID, name, etc.<br/> Can be combined with paging and sorting.<br/> Fields allowed in the query: id, name <br/> Default filter is an empty query and returns all results from the requested page.","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Mobile Device Extension Attribute objects has been fetched successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MobileDeviceExtensionAttributeSearchResults"}}}},"404":{"description":"Mobile Device Extension Attribute objects could not be found. The server either did not find a current representation for the requested resource or is trying to hide its existence from an unauthorized client.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Mobile Device Extension Attributes"]},"post":{"tags":["mobile-device-extension-attributes"],"summary":"Create Mobile Device Extension Attribute.","description":"Create Mobile Device Extension Attribute to collect extra inventory information.\n\n> 📋 **Required privilege:** Create Mobile Device Extension Attributes","requestBody":{"description":"Mobile Device Extension Attribute to be created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MobileDeviceExtensionAttributes"}}},"required":true},"responses":{"201":{"description":"Mobile Device Extension Attribute was successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"400":{"description":"Bad Request. The server could not understand the request because of invalid syntax. Possible reasons are:</br> 1) Required fields are not provided in request body.</br> 2) Fields which are not associated with provided inputType has some value.</br> 3) Any values outside of the allowed range are included in the request body.</br> 4) LDAP is not configured.</br> 5) Error occurred during database create operation.</br> 6) Duplicate name is provided.</br>","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Create Mobile Device Extension Attributes"],"x-action":true}},"/v1/mobile-device-extension-attributes/{id}":{"get":{"tags":["mobile-device-extension-attributes"],"summary":"Get specified Mobile Device Extension Attribute object.","description":"Gets specified Mobile Device Extension Attribute object.\n\n> 📋 **Required privilege:** Read Mobile Device Extension Attributes","parameters":[{"name":"id","in":"path","description":"Unique ID of Mobile Device Extension Attribute.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Mobile Device Extension Attribute object has been fetched successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MobileDeviceExtensionAttributes"}}}},"400":{"description":"Bad Request. The server could not understand the request because of invalid syntax. Possible reason can be 'The specified extension attribute id does not include a valid number.'"},"404":{"description":"Specified Mobile Device Extension Attribute object could not be found. The server either did not find a current representation for the requested resource or is trying to hide its existence from an unauthorized client.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Mobile Device Extension Attributes"]},"put":{"tags":["mobile-device-extension-attributes"],"summary":"Update specified Mobile Device Extension Attribute object.","description":"Update specified Mobile Device Extension Attribute object.\n\n> 📋 **Required privilege:** Update Mobile Device Extension Attributes","parameters":[{"name":"id","in":"path","description":"Unique ID of Mobile Device Extension Attribute.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Mobile Device Extension Attribute object to be updated. IDs defined in this body will be ignored.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MobileDeviceExtensionAttributes"}}},"required":true},"responses":{"202":{"description":"Mobile Device Extension Attribute updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MobileDeviceExtensionAttributes"}}}},"400":{"description":"Bad Request. Specified Mobile Device Extension Attribute could not be updated due to bad request. Possible reasons are:</br> 1) The specified extension attribute id does not include a valid number.</br> 2) Duplicate name is provided.</br> 3) Required fields are not provided in request body.</br> 4) Fields which are not associated with provided inputType has some value.</br> 5) Any values outside of the allowed range are included in the request body.</br> 6) LDAP is not configured.</br> 7) Error occurred during database update operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Specified Mobile Device Extension Attribute object does not exist. The server either did not find a current representation for the requested resource or is trying to hide its existence from an unauthorized client.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Mobile Device Extension Attributes"]},"delete":{"tags":["mobile-device-extension-attributes"],"summary":"Delete a Mobile Device Extension Attribute by ID.","description":"Deletes the Mobile Device Extension Attribute identified by the provided ID.<\\br>\nIn addition to removing the attribute itself, this operation will also delete any related dependent data, including:<\\br>\n  - Associated popup menu choices.<\\br>\n  - Fields used in saved search displays.<\\br>\n  - User preferences that reference the attribute.\n\n\n> 📋 **Required privilege:** Delete Mobile Device Extension Attributes","parameters":[{"name":"id","in":"path","description":"Unique ID of Mobile Device Extension Attribute.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"The Mobile Device Extension was successfully deleted."},"400":{"description":"Bad Request. The server could not process the request due to invalid input. Possible reasons are:</br> - The specified extension attribute ID is not a valid number. - The ID is missing or improperly formatted."},"404":{"description":"Not Found. The specified Mobile Device Extension Attribute does not exist. This may indicate that the resource is missing, or the client is not authorized to access it."}},"x-required-privileges":["Delete Mobile Device Extension Attributes"]}},"/v1/mobile-device-extension-attributes/{id}/data-dependency":{"get":{"tags":["mobile-device-extension-attributes"],"summary":"Get smart group dependent object for a specified mobile device extension attribute","description":"Get smart group dependent object for a specified mobile device extension attribute\n\n> 📋 **Required privilege:** Read Mobile Device Extension Attributes","parameters":[{"name":"id","in":"path","description":"Unique ID of mobile device extension attribute.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Fetches list of dependent objects for a specified mobile device extension attribute.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DependencyObjectResults"}}}},"400":{"description":"Bad Request. The server could not understand the request because of invalid syntax.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Specified mobile device extension attribute id were not found in database.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Mobile Device Extension Attributes"]}},"/v1/mobile-device-extension-attributes/{id}/history":{"get":{"tags":["mobile-device-extension-attributes"],"summary":"Get specified Mobile Device Extension Attribute History object","description":"Get specified Mobile Device Extension Attribute history object\n\n> 📋 **Required privilege:** Read Mobile Device Extension Attributes","parameters":[{"name":"id","in":"path","description":"Instance ID of Mobile Device Extension Attribute","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorts results by one or more criteria, following the format property:asc/desc. Default sort is ID:asc. If using multiple criteria, separate with commas.","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}},{"name":"filter","in":"query","description":"Filters results. Use RSQL format for query. Allows for many fields, including ID, name, etc. Can be combined with paging and sorting. Default filter is an empty query and returns all results from the requested page.","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Details of Mobile Device Extension Attribute history were found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistorySearchResults"}}}},"400":{"description":"Bad Request. Specified Mobile Device Extension Attribute history object could not be found. Possible reason can be 'Provided id field is not string of positive numeric value or -1'.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Mobile Device Extension Attributes"]},"post":{"tags":["mobile-device-extension-attributes"],"summary":"Add specified Mobile Device Extension Attribute history object notes","description":"Add specified Mobile Device Extension Attribute history object notes\n\n> 📋 **Required privilege:** Update Mobile Device Extension Attributes","parameters":[{"name":"id","in":"path","description":"Instance ID of Mobile Device Extension Attribute","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"History note to be created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistoryNote"}}},"required":true},"responses":{"201":{"description":"Mobile Device Extension Attribute history note created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistory"}}}},"400":{"description":"Bad Request. Error creating history note. Possible reason can be 'Provided id field is not string of positive numeric value or -1'.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Mobile Device Extension Attributes"]}},"/devices/extensionAttributes":{"get":{"tags":["mobile-device-extension-attributes-preview"],"summary":"Get Mobile Device Extension Attribute values placed in select paramter\n","description":"Gets Mobile Device Extension Attribute values placed in select parameter.\n\n> 📋 **Required privilege:** Read Mobile Device Extension Attributes","parameters":[{"name":"select","in":"query","description":"Acceptable values currently include:\n* name\n","required":false,"style":"form","explode":true,"schema":{"type":"string","default":"name"}}],"responses":{"200":{"description":"Successful response - Extension Attributes retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MobileDeviceExtensionAttributeResults"}}}}},"x-required-privileges":["Read Mobile Device Extension Attributes"]}},"/v1/mobile-device-groups":{"get":{"tags":["mobile-device-groups"],"summary":"Return the list of all Mobile Device Groups\n","description":"Returns the list of all mobile device groups.\n\n\n> 📋 **Required privileges:**\n> - Read Smart Mobile Device Groups\n> - Read Static Mobile Device Groups","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceGroup"}}}}}},"deprecated":true,"x-deprecation-date":"2026-05-28","x-required-privileges":["Read Smart Mobile Device Groups","Read Static Mobile Device Groups"]}},"/v1/mobile-device-groups/smart-group-membership/{id}":{"get":{"tags":["mobile-device-groups"],"summary":"Get Smart Group Membership by Id\n","description":"Get Smart Group Membership by Id\n\n\n> 📋 **Required privileges:**\n> - Read Smart Mobile Device Groups\n> - Read Mobile Devices","parameters":[{"name":"id","in":"path","description":"instance id of smart-group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort\nis mobileDeviceId:asc. Multiple sort criteria are supported and must be separated with\na comma. \n\nFields allowed in the sort: `airPlayPassword`, `appAnalyticsEnabled`, `assetTag`, `availableSpaceMb`, \n`batteryLevel`, `batteryHealth`, `bluetoothLowEnergyCapable`, `bluetoothMacAddress`, `capacityMb`, \n`lostModeEnabledDate`, `declarativeDeviceManagementEnabled`, `deviceId`, `deviceLocatorServiceEnabled`,\n`devicePhoneNumber`, `diagnosticAndUsageReportingEnabled`, `displayName`, `doNotDisturbEnabled`, \n`enrollmentSessionTokenValid`, `exchangeDeviceId`, `cloudBackupEnabled`, `osBuild`,\n`osRapidSecurityResponse`, `osSupplementalBuildVersion`, `osVersion`, `ipAddress`, `itunesStoreAccountActive`,\n`mobileDeviceId`, `managementId`, `languages`, `lastBackupDate`, `lastEnrolledDate`, `lastCloudBackupDate`,\n`lastInventoryUpdateDate`, `locales`, `locationServicesForSelfServiceMobileEnabled`, `lostModeEnabled`,\n`managed`, `mdmProfileExpirationDate`, `model`, `modelIdentifier`,\n`modelNumber`, `modemFirmwareVersion`, `preferredVoiceNumber`, `quotaSize`, `residentUsers`,\n`serialNumber`, `sharedIpad`, `supervised`, `tethered`,\n`timeZone`, `udid`, `usedSpacePercentage`, `wifiMacAddress`,\n`deviceOwnershipType`, `building`, `department`, `emailAddress`,\n`fullName`, `userPhoneNumber`, `position`, `room`,\n`username`, `appleCareId`, `leaseExpirationDate`,`lifeExpectancyYears`,\n`poDate`, `poNumber`, `purchasePrice`, `purchasedOrLeased`,\n`purchasingAccount`, `purchasingContact`, `vendor`, `warrantyExpirationDate`,\n`activationLockEnabled`, `blockEncryptionCapable`, `dataProtection`, `fileEncryptionCapable`,\n`hardwareEncryptionSupported`, `jailbreakStatus`, `passcodeCompliant`, `passcodeCompliantWithProfile`,\n`passcodeLockGracePeriodEnforcedSeconds`, `passcodePresent`, `carrierSettingsVersion`,\n`cellularTechnology`, `currentCarrierNetwork`, `currentMobileCountryCode`, `currentMobileNetworkCode`, \n`dataRoamingEnabled`, `eid`, `network`, `homeMobileCountryCode`, \n`homeMobileNetworkCode`, `iccid`, `imei`, `imei2`,\n`meid`, `personalHotspotEnabled`, `voiceRoamingEnabled`, `roaming`, `lastLoggedInUsernameSelfService`, `lastLoggedInUsernameSelfServiceTimestamp`,\n`lastLoggedInUsernameMdm`, `lastLoggedInUsernameMdmTimestamp`\n\nExtension attributes can be sorted by using the format `EA+ID` where ID is the ID of the extension attribute, for example `EA+1!=null`\n\nExample: `sort=displayName:desc,username:asc`\n","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["displayName:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter mobile device collection.\nDefault filter is empty query - returning all results for the requested page.\n\nFields allowed in the query: `airPlayPassword`, `appAnalyticsEnabled`, `assetTag`, `availableSpaceMb`, \n`batteryLevel`, `bluetoothLowEnergyCapable`, `bluetoothMacAddress`, `capacityMb`, \n`declarativeDeviceManagementEnabled`, `deviceId`, `deviceLocatorServiceEnabled`, `devicePhoneNumber`,\n`diagnosticAndUsageReportingEnabled`, `displayName`, `doNotDisturbEnabled`, `exchangeDeviceId`, \n`cloudBackupEnabled`, `osBuild`, `osSupplementalBuildVersion`, `osVersion`, `osRapidSecurityResponse`, `ipAddress`, \n`itunesStoreAccountActive`, `mobileDeviceId`, `managementId`, `languages`, `lastInventoryUpdateDate`, `locales`,\n`locationServicesForSelfServiceMobileEnabled`, `lostModeEnabled`, `managed`, `model`, \n`modelIdentifier`, `modelNumber`, `modemFirmwareVersion`, `preferredVoiceNumber`, `quotaSize`, \n`residentUsers`, `serialNumber`, `sharedIpad`, `supervised`,\n`tethered`, `timeZone`, `udid`, `usedSpacePercentage`, \n`wifiMacAddress`, `building`, `department`, `emailAddress`,\n`fullName`, `userPhoneNumber`, `position`, `room`,\n`username`, `appleCareId`, `lifeExpectancyYears`, `poNumber`, \n`purchasePrice`, `purchasedOrLeased`, `purchasingAccount`, `purchasingContact`,\n`vendor`, `activationLockEnabled`, `blockEncryptionCapable`, `dataProtection`, \n`fileEncryptionCapable`, `passcodeCompliant`, `passcodeCompliantWithProfile`, `passcodeLockGracePeriodEnforcedSeconds`,\n`passcodePresent`, `carrierSettingsVersion`, `currentCarrierNetwork`,\n`currentMobileCountryCode`, `currentMobileNetworkCode`, `dataRoamingEnabled`, `eid`,\n`network`, `homeMobileCountryCode`, `homeMobileNetworkCode`, `iccid`,\n`imei`, `imei2`, `meid`, `personalHotspotEnabled`, \n`roaming`, `lastLoggedInUsernameSelfService`, `lastLoggedInUsernameSelfServiceTimestamp`,\n`lastLoggedInUsernameMdm`, `lastLoggedInUsernameMdmTimestamp`\n\nExtension attributes can be filtered by using the format `EA+ID` where ID is the ID of the extension attribute, for example `EA+1!=null`\n\nThis param can be combined with paging and sorting.\nExample: `filter=displayName==\"iPad\"`\n","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryListMobileDeviceSearchResults"}}}},"404":{"description":"No smart group found with the given id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2026-05-28","x-required-privileges":["Read Smart Mobile Device Groups","Read Mobile Devices"]}},"/v1/mobile-device-groups/smart-groups":{"get":{"tags":["mobile-device-groups"],"summary":"Get Smart Groups\n","description":"Get Smart Groups\n\n\n> 📋 **Required privilege:** Read Smart Mobile Device Groups","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Available criteria to sort on: groupId, groupName, siteId.","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["groupId:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter smart group collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: groupId, groupName, siteId. The siteId field can only be filtered by admins with full access. Any sited admin will have siteId filtered automatically. This param can be combined with paging and sorting. Example: groupName==\"smartGroup1\"","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartGroupSearchResults"}}}}},"deprecated":true,"x-deprecation-date":"2026-05-28","x-required-privileges":["Read Smart Mobile Device Groups"]},"post":{"tags":["mobile-device-groups"],"summary":"Create a smart group\n","description":"Create a smart group\n\n\n> 📋 **Required privilege:** Create Smart Mobile Device Groups","parameters":[{"name":"platform","in":"query","description":"Optional. Return platform identifiers instead of internal identifiers when set to true.","required":false,"style":"form","explode":true,"schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartGroupAssignment"}}},"required":true},"responses":{"201":{"description":"Smart mobile device group created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"400":{"description":"Could not save smart group","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2026-05-28","x-required-privileges":["Create Smart Mobile Device Groups"]}},"/v1/mobile-device-groups/smart-groups/{id}":{"get":{"tags":["mobile-device-groups"],"summary":"Get Smart Group by Id\n","description":"Get Smart Group by Id\n\n\n> 📋 **Required privilege:** Read Smart Mobile Device Groups","parameters":[{"name":"id","in":"path","description":"instance id of smart-group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartGroupDetail"}}}},"404":{"description":"No smart group found with the given id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2026-05-28","x-required-privileges":["Read Smart Mobile Device Groups"]},"put":{"tags":["mobile-device-groups"],"summary":"Update a smart group\n","description":"Update a smart group\n\n\n> 📋 **Required privilege:** Update Smart Mobile Device Groups","parameters":[{"name":"id","in":"path","description":"instance id of a smart group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartGroupAssignment"}}},"required":true},"responses":{"202":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartGroupAssignment"}}}},"404":{"description":"No smart group found with the given id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2026-05-28","x-required-privileges":["Update Smart Mobile Device Groups"]},"delete":{"tags":["mobile-device-groups"],"summary":"Remove Smart Group by Id\n","description":"Remove Smart Group by Id\n\n\n> 📋 **Required privilege:** Delete Smart Mobile Device Groups","parameters":[{"name":"id","in":"path","description":"instance id of smart-group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Smart Group successfully removed"}},"deprecated":true,"x-deprecation-date":"2026-05-28","x-required-privileges":["Delete Smart Mobile Device Groups"]}},"/v1/mobile-device-groups/static-group-membership/{id}":{"get":{"tags":["mobile-device-groups"],"summary":"Get Static Group Membership by Id\n","description":"Get Static Group Membership by Id\n\n\n> 📋 **Required privileges:**\n> - Read Static Mobile Device Groups\n> - Read Mobile Devices","parameters":[{"name":"id","in":"path","description":"instance id of static-group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort\nis mobileDeviceId:asc. Multiple sort criteria are supported and must be separated with\na comma. \n\nFields allowed in the sort: `airPlayPassword`, `appAnalyticsEnabled`, `assetTag`, `availableSpaceMb`, \n`batteryLevel`, `batteryHealth`, `bluetoothLowEnergyCapable`, `bluetoothMacAddress`, `capacityMb`, \n`lostModeEnabledDate`, `declarativeDeviceManagementEnabled`, `deviceId`, `deviceLocatorServiceEnabled`,\n`devicePhoneNumber`, `diagnosticAndUsageReportingEnabled`, `displayName`, `doNotDisturbEnabled`, \n`enrollmentSessionTokenValid`, `exchangeDeviceId`, `cloudBackupEnabled`, `osBuild`,\n`osRapidSecurityResponse`, `osSupplementalBuildVersion`, `osVersion`, `ipAddress`, `itunesStoreAccountActive`,\n`mobileDeviceId`, `managementId`, `languages`, `lastBackupDate`, `lastEnrolledDate`, `lastCloudBackupDate`,\n`lastInventoryUpdateDate`, `locales`, `locationServicesForSelfServiceMobileEnabled`, `lostModeEnabled`,\n`managed`, `mdmProfileExpirationDate`, `model`, `modelIdentifier`,\n`modelNumber`, `modemFirmwareVersion`, `preferredVoiceNumber`, `quotaSize`, `residentUsers`,\n`serialNumber`, `sharedIpad`, `supervised`, `tethered`,\n`timeZone`, `udid`, `usedSpacePercentage`, `wifiMacAddress`,\n`deviceOwnershipType`, `building`, `department`, `emailAddress`,\n`fullName`, `userPhoneNumber`, `position`, `room`,\n`username`, `appleCareId`, `leaseExpirationDate`,`lifeExpectancyYears`,\n`poDate`, `poNumber`, `purchasePrice`, `purchasedOrLeased`,\n`purchasingAccount`, `purchasingContact`, `vendor`, `warrantyExpirationDate`,\n`activationLockEnabled`, `blockEncryptionCapable`, `dataProtection`, `fileEncryptionCapable`,\n`hardwareEncryptionSupported`, `jailbreakStatus`, `passcodeCompliant`, `passcodeCompliantWithProfile`,\n`passcodeLockGracePeriodEnforcedSeconds`, `passcodePresent`, `carrierSettingsVersion`,\n`cellularTechnology`, `currentCarrierNetwork`, `currentMobileCountryCode`, `currentMobileNetworkCode`, \n`dataRoamingEnabled`, `eid`, `network`, `homeMobileCountryCode`, \n`homeMobileNetworkCode`, `iccid`, `imei`, `imei2`,\n`meid`, `personalHotspotEnabled`, `voiceRoamingEnabled`, `roaming`, `lastLoggedInUsernameSelfService`, `lastLoggedInUsernameSelfServiceTimestamp`,\n`lastLoggedInUsernameMdm`, `lastLoggedInUsernameMdmTimestamp`\n\nExtension attributes can be sorted by using the format `EA+ID` where ID is the ID of the extension attribute, for example `EA+1!=null`\n\nExample: `sort=displayName:desc,username:asc`\n","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["displayName:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter mobile device collection.\nDefault filter is empty query - returning all results for the requested page.\n\nFields allowed in the query: `airPlayPassword`, `appAnalyticsEnabled`, `assetTag`, `availableSpaceMb`, \n`batteryLevel`, `bluetoothLowEnergyCapable`, `bluetoothMacAddress`, `capacityMb`, \n`declarativeDeviceManagementEnabled`, `deviceId`, `deviceLocatorServiceEnabled`, `devicePhoneNumber`,\n`diagnosticAndUsageReportingEnabled`, `displayName`, `doNotDisturbEnabled`, `exchangeDeviceId`, \n`cloudBackupEnabled`, `osBuild`, `osSupplementalBuildVersion`, `osVersion`, `osRapidSecurityResponse`, `ipAddress`, \n`itunesStoreAccountActive`, `mobileDeviceId`, `managementId`, `languages`, `lastInventoryUpdateDate`, `locales`,\n`locationServicesForSelfServiceMobileEnabled`, `lostModeEnabled`, `managed`, `model`, \n`modelIdentifier`, `modelNumber`, `modemFirmwareVersion`, `preferredVoiceNumber`, `quotaSize`, \n`residentUsers`, `serialNumber`, `sharedIpad`, `supervised`,\n`tethered`, `timeZone`, `udid`, `usedSpacePercentage`, \n`wifiMacAddress`, `building`, `department`, `emailAddress`,\n`fullName`, `userPhoneNumber`, `position`, `room`,\n`username`, `appleCareId`, `lifeExpectancyYears`, `poNumber`, \n`purchasePrice`, `purchasedOrLeased`, `purchasingAccount`, `purchasingContact`,\n`vendor`, `activationLockEnabled`, `blockEncryptionCapable`, `dataProtection`, \n`fileEncryptionCapable`, `passcodeCompliant`, `passcodeCompliantWithProfile`, `passcodeLockGracePeriodEnforcedSeconds`,\n`passcodePresent`, `carrierSettingsVersion`, `currentCarrierNetwork`,\n`currentMobileCountryCode`, `currentMobileNetworkCode`, `dataRoamingEnabled`, `eid`,\n`network`, `homeMobileCountryCode`, `homeMobileNetworkCode`, `iccid`,\n`imei`, `imei2`, `meid`, `personalHotspotEnabled`, \n`roaming`, `lastLoggedInUsernameSelfService`, `lastLoggedInUsernameSelfServiceTimestamp`,\n`lastLoggedInUsernameMdm`, `lastLoggedInUsernameMdmTimestamp`\n\nExtension attributes can be filtered by using the format `EA+ID` where ID is the ID of the extension attribute, for example `EA+1!=null`\n\nThis param can be combined with paging and sorting.\nExample: `filter=displayName==\"iPad\"`\n","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryListMobileDeviceSearchResults"}}}},"404":{"description":"No static group found with the given id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2026-05-28","x-required-privileges":["Read Static Mobile Device Groups","Read Mobile Devices"]}},"/v1/mobile-device-groups/static-groups":{"get":{"tags":["mobile-device-groups"],"summary":"Get Static Groups\n","description":"Get Static Groups\n\n\n> 📋 **Required privilege:** Read Static Mobile Device Groups","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Available criteria to sort on: groupId, groupName, siteId.","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["groupId:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter department collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: groupId, groupName, siteId. The siteId field can only be filtered by admins with full access. Any sited admin will have siteId filtered automatically. This param can be combined with paging and sorting. Example: groupName==\"staticGroup1\"","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StaticGroupSearchResults"}}}}},"deprecated":true,"x-deprecation-date":"2026-05-28","x-required-privileges":["Read Static Mobile Device Groups"]},"post":{"tags":["mobile-device-groups"],"summary":"Create membership of a static group\n","description":"Create membership of a static group\n\n\n> 📋 **Required privilege:** Create Static Mobile Device Groups","parameters":[{"name":"platform","in":"query","description":"Optional. Return platform identifiers instead of internal identifiers when set to true.","required":false,"style":"form","explode":true,"schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StaticGroupAssignment"}}},"required":true},"responses":{"201":{"description":"Static mobile device group created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"400":{"description":"Could not save mobile device group","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2026-05-28","x-required-privileges":["Create Static Mobile Device Groups"]}},"/v1/mobile-device-groups/static-groups/{id}":{"get":{"tags":["mobile-device-groups"],"summary":"Get Static Group by Id\n","description":"Get Static Group by Id\n\n\n> 📋 **Required privilege:** Read Static Mobile Device Groups","parameters":[{"name":"id","in":"path","description":"instance id of static-group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StaticGroup"}}}},"404":{"description":"No static group found with the given id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2026-05-28","x-required-privileges":["Read Static Mobile Device Groups"]},"delete":{"tags":["mobile-device-groups"],"summary":"Remove Static Group by Id\n","description":"Remove Static Group by Id\n\n\n> 📋 **Required privilege:** Delete Static Mobile Device Groups","parameters":[{"name":"id","in":"path","description":"instance id of static-group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Static Group successfully removed"}},"deprecated":true,"x-deprecation-date":"2026-05-28","x-required-privileges":["Delete Static Mobile Device Groups"]},"patch":{"tags":["mobile-device-groups"],"summary":"Update membership of a static group\n","description":"Update membership of a static group\n\n\n> 📋 **Required privilege:** Update Static Mobile Device Groups","parameters":[{"name":"id","in":"path","description":"instance id of a static group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StaticGroupAssignment"}}},"required":true},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StaticGroupAssignment"}}}},"404":{"description":"No static group found with the given id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2026-05-28","x-required-privileges":["Update Static Mobile Device Groups"]}},"/v1/mobile-device-groups/{id}/erase":{"post":{"tags":["mobile-device-groups"],"summary":"Erase all devices in the group\n","description":"Erase all devices in the group\n\n\n> 📋 **Required privilege:** Send MDM command information in Jamf Pro API","parameters":[{"name":"id","in":"path","description":"instance id of mobile-device-group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupResetRequest"}}},"required":true},"responses":{"204":{"description":"Erase all devices in the group"}},"deprecated":true,"x-deprecation-date":"2026-05-28","x-required-privileges":["Send MDM command information in Jamf Pro API"],"x-action":true}},"/v2/mobile-device-groups":{"get":{"tags":["mobile-device-groups"],"summary":"Return the list of all Mobile Device Groups\n","description":"Returns the list of all mobile device groups filtered by site and permissions.\n\n\n> 📋 **Required privileges:**\n> - Read Smart Mobile Device Groups\n> - Read Static Mobile Device Groups","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceGroup"}}}}}},"x-required-privileges":["Read Smart Mobile Device Groups","Read Static Mobile Device Groups"]}},"/v2/mobile-device-groups/smart-group-membership/{id}":{"get":{"tags":["mobile-device-groups"],"summary":"Get Smart Group Membership by Id\n","description":"Get Smart Group Membership by Id\n\n\n> 📋 **Required privileges:**\n> - Read Smart Mobile Device Groups\n> - Read Mobile Devices","parameters":[{"name":"id","in":"path","description":"instance id of smart-group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort\nis mobileDeviceId:asc. Multiple sort criteria are supported and must be separated with\na comma.\n\nFields allowed in the sort: `airPlayPassword`, `appAnalyticsEnabled`, `assetTag`, `availableSpaceMb`,\n`batteryLevel`, `batteryHealth`, `bluetoothLowEnergyCapable`, `bluetoothMacAddress`, `capacityMb`,\n`lostModeEnabledDate`, `declarativeDeviceManagementEnabled`, `deviceId`, `deviceLocatorServiceEnabled`,\n`devicePhoneNumber`, `diagnosticAndUsageReportingEnabled`, `displayName`, `doNotDisturbEnabled`,\n`enrollmentSessionTokenValid`, `exchangeDeviceId`, `cloudBackupEnabled`, `osBuild`,\n`osRapidSecurityResponse`, `osSupplementalBuildVersion`, `osVersion`, `ipAddress`, `itunesStoreAccountActive`,\n`mobileDeviceId`, `managementId`, `languages`, `lastBackupDate`, `lastEnrolledDate`, `lastCloudBackupDate`,\n`lastInventoryUpdateDate`, `locales`, `locationServicesForSelfServiceMobileEnabled`, `lostModeEnabled`,\n`managed`, `mdmProfileExpirationDate`, `model`, `modelIdentifier`,\n`modelNumber`, `modemFirmwareVersion`, `preferredVoiceNumber`, `quotaSize`, `residentUsers`,\n`serialNumber`, `sharedIpad`, `supervised`, `tethered`,\n`timeZone`, `udid`, `usedSpacePercentage`, `wifiMacAddress`,\n`deviceOwnershipType`, `building`, `department`, `emailAddress`,\n`fullName`, `userPhoneNumber`, `position`, `room`,\n`username`, `appleCareId`, `leaseExpirationDate`,`lifeExpectancyYears`,\n`poDate`, `poNumber`, `purchasePrice`, `purchasedOrLeased`,\n`purchasingAccount`, `purchasingContact`, `vendor`, `warrantyExpirationDate`,\n`activationLockEnabled`, `blockEncryptionCapable`, `dataProtection`, `fileEncryptionCapable`,\n`hardwareEncryptionSupported`, `jailbreakStatus`, `passcodeCompliant`, `passcodeCompliantWithProfile`,\n`passcodeLockGracePeriodEnforcedSeconds`, `passcodePresent`, `carrierSettingsVersion`,\n`cellularTechnology`, `currentCarrierNetwork`, `currentMobileCountryCode`, `currentMobileNetworkCode`,\n`dataRoamingEnabled`, `eid`, `network`, `homeMobileCountryCode`,\n`homeMobileNetworkCode`, `iccid`, `imei`, `imei2`,\n`meid`, `personalHotspotEnabled`, `voiceRoamingEnabled`, `roaming`, `lastLoggedInUsernameSelfService`, `lastLoggedInUsernameSelfServiceTimestamp`,\n`lastLoggedInUsernameMdm`, `lastLoggedInUsernameMdmTimestamp`\n\nExtension attributes can be sorted by using the format `EA+ID` where ID is the ID of the extension attribute, for example `EA+1!=null`\n\nExample: `sort=displayName:desc,username:asc`\n","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["displayName:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter mobile device collection.\nDefault filter is empty query - returning all results for the requested page.\n\nFields allowed in the query: `airPlayPassword`, `appAnalyticsEnabled`, `assetTag`, `availableSpaceMb`,\n`batteryLevel`, `bluetoothLowEnergyCapable`, `bluetoothMacAddress`, `capacityMb`,\n`declarativeDeviceManagementEnabled`, `deviceId`, `deviceLocatorServiceEnabled`, `devicePhoneNumber`,\n`diagnosticAndUsageReportingEnabled`, `displayName`, `doNotDisturbEnabled`, `exchangeDeviceId`,\n`cloudBackupEnabled`, `osBuild`, `osSupplementalBuildVersion`, `osVersion`, `osRapidSecurityResponse`, `ipAddress`,\n`itunesStoreAccountActive`, `mobileDeviceId`, `managementId`, `languages`, `lastInventoryUpdateDate`, `locales`,\n`locationServicesForSelfServiceMobileEnabled`, `lostModeEnabled`, `managed`, `model`,\n`modelIdentifier`, `modelNumber`, `modemFirmwareVersion`, `preferredVoiceNumber`, `quotaSize`,\n`residentUsers`, `serialNumber`, `sharedIpad`, `supervised`,\n`tethered`, `timeZone`, `udid`, `usedSpacePercentage`,\n`wifiMacAddress`, `building`, `department`, `emailAddress`,\n`fullName`, `userPhoneNumber`, `position`, `room`,\n`username`, `appleCareId`, `lifeExpectancyYears`, `poNumber`,\n`purchasePrice`, `purchasedOrLeased`, `purchasingAccount`, `purchasingContact`,\n`vendor`, `activationLockEnabled`, `blockEncryptionCapable`, `dataProtection`,\n`fileEncryptionCapable`, `passcodeCompliant`, `passcodeCompliantWithProfile`, `passcodeLockGracePeriodEnforcedSeconds`,\n`passcodePresent`, `carrierSettingsVersion`, `currentCarrierNetwork`,\n`currentMobileCountryCode`, `currentMobileNetworkCode`, `dataRoamingEnabled`, `eid`,\n`network`, `homeMobileCountryCode`, `homeMobileNetworkCode`, `iccid`,\n`imei`, `imei2`, `meid`, `personalHotspotEnabled`,\n`roaming`, `lastLoggedInUsernameSelfService`, `lastLoggedInUsernameSelfServiceTimestamp`,\n`lastLoggedInUsernameMdm`, `lastLoggedInUsernameMdmTimestamp`\n\nExtension attributes can be filtered by using the format `EA+ID` where ID is the ID of the extension attribute, for example `EA+1!=null`\n\nThis param can be combined with paging and sorting.\nExample: `filter=displayName==\"iPad\"`\n","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryListMobileDeviceSearchResults"}}}},"404":{"description":"The requested resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Smart Mobile Device Groups","Read Mobile Devices"]}},"/v2/mobile-device-groups/smart-groups":{"get":{"tags":["mobile-device-groups"],"summary":"Get Smart Groups\n","description":"Get Smart Groups with pagination, sorting, and filtering support.\n\n\n> 📋 **Required privilege:** Read Smart Mobile Device Groups","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is groupId:asc. Available criteria to sort on: groupId, groupName, siteId.","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["groupId:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter smart group collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: groupId, groupName, siteId. The siteId field can only be filtered by admins with full access. Any sited admin will have siteId filtered automatically. This param can be combined with paging and sorting. Example: groupName==\"smartGroup1\"","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartGroupSearchResults"}}}}},"x-required-privileges":["Read Smart Mobile Device Groups"]},"post":{"tags":["mobile-device-groups"],"summary":"Create a smart group\n","description":"Create a smart group with strict andOr enum validation.\n\n\n> 📋 **Required privilege:** Create Smart Mobile Device Groups","parameters":[{"name":"platform","in":"query","description":"Optional. Return platform identifiers instead of internal identifiers when set to true.","required":false,"style":"form","explode":true,"schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartGroupAssignmentV2"}}},"required":true},"responses":{"201":{"description":"Smart mobile device group created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"400":{"description":"Could not save smart group due to validation errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"Duplicate group name","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Create Smart Mobile Device Groups"]}},"/v2/mobile-device-groups/smart-groups/{id}":{"get":{"tags":["mobile-device-groups"],"summary":"Get Smart Group by Id\n","description":"Get Smart Group by Id\n\n\n> 📋 **Required privilege:** Read Smart Mobile Device Groups","parameters":[{"name":"id","in":"path","description":"instance id of smart-group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartGroupDetailV2"}}}},"404":{"description":"The requested resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Smart Mobile Device Groups"]},"put":{"tags":["mobile-device-groups"],"summary":"Update a smart group\n","description":"Update a smart group with strict andOr enum validation.\n\n\n> 📋 **Required privilege:** Update Smart Mobile Device Groups","parameters":[{"name":"id","in":"path","description":"instance id of a smart group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartGroupAssignmentV2"}}},"required":true},"responses":{"202":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartGroupAssignmentV2"}}}},"400":{"description":"Could not update smart group due to validation errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"The requested resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"Duplicate group name","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Smart Mobile Device Groups"]},"delete":{"tags":["mobile-device-groups"],"summary":"Remove Smart Group by Id\n","description":"Remove Smart Group by Id. Returns 422 if the group has dependencies.\n\n\n> 📋 **Required privilege:** Delete Smart Mobile Device Groups","parameters":[{"name":"id","in":"path","description":"instance id of smart-group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Smart Group successfully removed"},"404":{"description":"The requested resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"Cannot delete smart group due to dependencies","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Delete Smart Mobile Device Groups"]}},"/v2/mobile-device-groups/static-group-membership/{id}":{"get":{"tags":["mobile-device-groups"],"summary":"Get Static Group Membership by Id\n","description":"Get Static Group Membership by Id\n\n\n> 📋 **Required privileges:**\n> - Read Static Mobile Device Groups\n> - Read Mobile Devices","parameters":[{"name":"id","in":"path","description":"instance id of static-group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort\nis mobileDeviceId:asc. Multiple sort criteria are supported and must be separated with\na comma.\n\nFields allowed in the sort: `airPlayPassword`, `appAnalyticsEnabled`, `assetTag`, `availableSpaceMb`,\n`batteryLevel`, `batteryHealth`, `bluetoothLowEnergyCapable`, `bluetoothMacAddress`, `capacityMb`,\n`lostModeEnabledDate`, `declarativeDeviceManagementEnabled`, `deviceId`, `deviceLocatorServiceEnabled`,\n`devicePhoneNumber`, `diagnosticAndUsageReportingEnabled`, `displayName`, `doNotDisturbEnabled`,\n`enrollmentSessionTokenValid`, `exchangeDeviceId`, `cloudBackupEnabled`, `osBuild`,\n`osRapidSecurityResponse`, `osSupplementalBuildVersion`, `osVersion`, `ipAddress`, `itunesStoreAccountActive`,\n`mobileDeviceId`, `managementId`, `languages`, `lastBackupDate`, `lastEnrolledDate`, `lastCloudBackupDate`,\n`lastInventoryUpdateDate`, `locales`, `locationServicesForSelfServiceMobileEnabled`, `lostModeEnabled`,\n`managed`, `mdmProfileExpirationDate`, `model`, `modelIdentifier`,\n`modelNumber`, `modemFirmwareVersion`, `preferredVoiceNumber`, `quotaSize`, `residentUsers`,\n`serialNumber`, `sharedIpad`, `supervised`, `tethered`,\n`timeZone`, `udid`, `usedSpacePercentage`, `wifiMacAddress`,\n`deviceOwnershipType`, `building`, `department`, `emailAddress`,\n`fullName`, `userPhoneNumber`, `position`, `room`,\n`username`, `appleCareId`, `leaseExpirationDate`,`lifeExpectancyYears`,\n`poDate`, `poNumber`, `purchasePrice`, `purchasedOrLeased`,\n`purchasingAccount`, `purchasingContact`, `vendor`, `warrantyExpirationDate`,\n`activationLockEnabled`, `blockEncryptionCapable`, `dataProtection`, `fileEncryptionCapable`,\n`hardwareEncryptionSupported`, `jailbreakStatus`, `passcodeCompliant`, `passcodeCompliantWithProfile`,\n`passcodeLockGracePeriodEnforcedSeconds`, `passcodePresent`, `carrierSettingsVersion`,\n`cellularTechnology`, `currentCarrierNetwork`, `currentMobileCountryCode`, `currentMobileNetworkCode`,\n`dataRoamingEnabled`, `eid`, `network`, `homeMobileCountryCode`,\n`homeMobileNetworkCode`, `iccid`, `imei`, `imei2`,\n`meid`, `personalHotspotEnabled`, `voiceRoamingEnabled`, `roaming`, `lastLoggedInUsernameSelfService`, `lastLoggedInUsernameSelfServiceTimestamp`,\n`lastLoggedInUsernameMdm`, `lastLoggedInUsernameMdmTimestamp`\n\nExtension attributes can be sorted by using the format `EA+ID` where ID is the ID of the extension attribute, for example `EA+1!=null`\n\nExample: `sort=displayName:desc,username:asc`\n","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["displayName:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter mobile device collection.\nDefault filter is empty query - returning all results for the requested page.\n\nFields allowed in the query: `airPlayPassword`, `appAnalyticsEnabled`, `assetTag`, `availableSpaceMb`,\n`batteryLevel`, `bluetoothLowEnergyCapable`, `bluetoothMacAddress`, `capacityMb`,\n`declarativeDeviceManagementEnabled`, `deviceId`, `deviceLocatorServiceEnabled`, `devicePhoneNumber`,\n`diagnosticAndUsageReportingEnabled`, `displayName`, `doNotDisturbEnabled`, `exchangeDeviceId`,\n`cloudBackupEnabled`, `osBuild`, `osSupplementalBuildVersion`, `osVersion`, `osRapidSecurityResponse`, `ipAddress`,\n`itunesStoreAccountActive`, `mobileDeviceId`, `managementId`, `languages`, `lastInventoryUpdateDate`, `locales`,\n`locationServicesForSelfServiceMobileEnabled`, `lostModeEnabled`, `managed`, `model`,\n`modelIdentifier`, `modelNumber`, `modemFirmwareVersion`, `preferredVoiceNumber`, `quotaSize`,\n`residentUsers`, `serialNumber`, `sharedIpad`, `supervised`,\n`tethered`, `timeZone`, `udid`, `usedSpacePercentage`,\n`wifiMacAddress`, `building`, `department`, `emailAddress`,\n`fullName`, `userPhoneNumber`, `position`, `room`,\n`username`, `appleCareId`, `lifeExpectancyYears`, `poNumber`,\n`purchasePrice`, `purchasedOrLeased`, `purchasingAccount`, `purchasingContact`,\n`vendor`, `activationLockEnabled`, `blockEncryptionCapable`, `dataProtection`,\n`fileEncryptionCapable`, `passcodeCompliant`, `passcodeCompliantWithProfile`, `passcodeLockGracePeriodEnforcedSeconds`,\n`passcodePresent`, `carrierSettingsVersion`, `currentCarrierNetwork`,\n`currentMobileCountryCode`, `currentMobileNetworkCode`, `dataRoamingEnabled`, `eid`,\n`network`, `homeMobileCountryCode`, `homeMobileNetworkCode`, `iccid`,\n`imei`, `imei2`, `meid`, `personalHotspotEnabled`,\n`roaming`, `lastLoggedInUsernameSelfService`, `lastLoggedInUsernameSelfServiceTimestamp`,\n`lastLoggedInUsernameMdm`, `lastLoggedInUsernameMdmTimestamp`\n\nExtension attributes can be filtered by using the format `EA+ID` where ID is the ID of the extension attribute, for example `EA+1!=null`\n\nThis param can be combined with paging and sorting.\nExample: `filter=displayName==\"iPad\"`\n","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryListMobileDeviceSearchResults"}}}},"404":{"description":"The requested resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Static Mobile Device Groups","Read Mobile Devices"]}},"/v2/mobile-device-groups/static-groups":{"get":{"tags":["mobile-device-groups"],"summary":"Get Static Groups\n","description":"Get Static Groups with pagination, sorting, and filtering support.\n\n\n> 📋 **Required privilege:** Read Static Mobile Device Groups","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is groupId:asc. Available criteria to sort on: groupId, groupName, siteId.","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["groupId:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter static group collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: groupId, groupName, siteId. The siteId field can only be filtered by admins with full access. Any sited admin will have siteId filtered automatically. This param can be combined with paging and sorting. Example: groupName==\"staticGroup1\"","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StaticGroupSearchResults"}}}}},"x-required-privileges":["Read Static Mobile Device Groups"]},"post":{"tags":["mobile-device-groups"],"summary":"Create a static group\n","description":"Create a static group\n\n\n> 📋 **Required privilege:** Create Static Mobile Device Groups","parameters":[{"name":"platform","in":"query","description":"Optional. Return platform identifiers instead of internal identifiers when set to true.","required":false,"style":"form","explode":true,"schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StaticGroupAssignment"}}},"required":true},"responses":{"201":{"description":"Static mobile device group created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"400":{"description":"Could not save static group due to validation errors or invalid device IDs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"Duplicate group name","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Create Static Mobile Device Groups"]}},"/v2/mobile-device-groups/static-groups/{id}":{"get":{"tags":["mobile-device-groups"],"summary":"Get Static Group by Id\n","description":"Get Static Group by Id\n\n\n> 📋 **Required privilege:** Read Static Mobile Device Groups","parameters":[{"name":"id","in":"path","description":"instance id of static-group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StaticGroup"}}}},"404":{"description":"The requested resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Static Mobile Device Groups"]},"delete":{"tags":["mobile-device-groups"],"summary":"Remove Static Group by Id\n","description":"Remove Static Group by Id. Returns 422 if the group has dependencies.\n\n\n> 📋 **Required privilege:** Delete Static Mobile Device Groups","parameters":[{"name":"id","in":"path","description":"instance id of static-group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Static Group successfully removed"},"404":{"description":"The requested resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"Cannot delete static group due to dependencies","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Delete Static Mobile Device Groups"]},"patch":{"tags":["mobile-device-groups"],"summary":"Update a static group\n","description":"Partially update a static group. Only provided fields will be updated.\n\n\n> 📋 **Required privilege:** Update Static Mobile Device Groups","parameters":[{"name":"id","in":"path","description":"instance id of static-group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StaticGroupAssignment"}}},"required":true},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StaticGroupAssignment"}}}},"400":{"description":"Could not update static group due to validation errors (e.g., invalid device IDs, name too long)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"The requested resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"Duplicate group name","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Static Mobile Device Groups"]}},"/v2/mobile-device-groups/{id}/erase":{"post":{"tags":["mobile-device-groups"],"summary":"Erase all devices in the group\n","description":"Erase all devices in the group (both smart and static groups)\n\n\n> 📋 **Required privilege:** Send MDM command information in Jamf Pro API","parameters":[{"name":"id","in":"path","description":"instance id of mobile-device-group","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupResetRequest"}}},"required":true},"responses":{"202":{"description":"Erase command accepted for all devices in the group"},"400":{"description":"Invalid site for current user privileges","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"No mobile device group with the given id found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Send MDM command information in Jamf Pro API"],"x-action":true}},"/v2/mobile-device-prestages":{"get":{"tags":["mobile-device-prestages"],"summary":"Get sorted and paged Mobile Device Prestages\n","description":"Gets sorted and paged mobile device prestages\n\n> 📋 **Required privilege:** Read Mobile Device PreStage Enrollments","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:desc"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MobileDevicePrestageSearchResultsV2"}}}}},"deprecated":true,"x-deprecation-date":"2025-06-30","x-required-privileges":["Read Mobile Device PreStage Enrollments"]},"post":{"tags":["mobile-device-prestages"],"summary":"Create a Mobile Device Prestage\n","description":"Create a mobile device prestage\n\n> 📋 **Required privilege:** Create Mobile Device PreStage Enrollments","requestBody":{"description":"Mobile Device Prestage to create. ids defined in this body will be ignored","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MobileDevicePrestageV2"}}},"required":true},"responses":{"201":{"description":"Mobile Device Prestage was created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}}},"deprecated":true,"x-deprecation-date":"2025-06-30","x-required-privileges":["Create Mobile Device PreStage Enrollments"]}},"/v2/mobile-device-prestages/scope":{"get":{"tags":["mobile-device-prestages"],"summary":"Get all Device Scope for all Mobile Device Prestages\n","description":"Get all device scope for all mobile device prestages\n\n> 📋 **Required privilege:** Read Mobile Device PreStage Enrollments","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrestageScopeV2"}}}}},"x-required-privileges":["Read Mobile Device PreStage Enrollments"]}},"/v2/mobile-device-prestages/syncs":{"get":{"tags":["mobile-device-prestages"],"summary":"Get all Prestage sync States for all prestages\n","description":"Get all prestage sync states for all prestages\n\n> 📋 **Required privilege:** Read Mobile Device PreStage Enrollments","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PrestageSyncStatusV2"}}}}}},"x-required-privileges":["Read Mobile Device PreStage Enrollments"]}},"/v2/mobile-device-prestages/{id}":{"get":{"tags":["mobile-device-prestages"],"summary":"Retrieve a Mobile Device Prestage with the supplied id\n","description":"Retrieves a Mobile Device Prestage with the supplied id\n\n> 📋 **Required privilege:** Read Mobile Device PreStage Enrollments","parameters":[{"name":"id","in":"path","description":"Mobile Device Prestage identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMobileDevicePrestageV2"}}}},"404":{"description":"Mobile Device Prestage with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2025-06-30","x-required-privileges":["Read Mobile Device PreStage Enrollments"]},"put":{"tags":["mobile-device-prestages"],"summary":"Update a Mobile Device Prestage\n","description":"Updates a Mobile Device Prestage\n\n> 📋 **Required privilege:** Update Mobile Device PreStage Enrollments","parameters":[{"name":"id","in":"path","description":"Mobile Device Prestage identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Mobile Device Prestage to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PutMobileDevicePrestageV2"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMobileDevicePrestageV2"}}}},"404":{"description":"Mobile Device Prestage with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"The Mobile Device Prestage was modified by another process. Read the Mobile Device Prestage again for updated changes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2025-06-30","x-required-privileges":["Update Mobile Device PreStage Enrollments"]},"delete":{"tags":["mobile-device-prestages"],"summary":"Delete a Mobile Device Prestage with the supplied id\n","description":"Deletes a Mobile Device Prestage with the supplied id\n\n> 📋 **Required privilege:** Delete Mobile Device PreStage Enrollments","parameters":[{"name":"id","in":"path","description":"Mobile Device Prestage identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Success"}},"deprecated":true,"x-deprecation-date":"2025-06-30","x-required-privileges":["Delete Mobile Device PreStage Enrollments"]}},"/v2/mobile-device-prestages/{id}/attachments":{"get":{"tags":["mobile-device-prestages"],"summary":"Get attachments for a Mobile Device Prestage\n","description":"Get attachments for a Mobile Device Prestage\n\n> 📋 **Required privilege:** Read Mobile Device PreStage Enrollments","parameters":[{"name":"id","in":"path","description":"Mobile Device Prestage identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FileAttachmentV2"}}}}},"404":{"description":"Mobile Device Prestage with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2025-06-30","x-required-privileges":["Read Mobile Device PreStage Enrollments"]},"post":{"tags":["mobile-device-prestages"],"summary":"Add an attachment to a Mobile Device Prestage\n","description":"Add an attachment to a Mobile Device prestage\n\n> 📋 **Required privilege:** Create Mobile Device PreStage Enrollments","parameters":[{"name":"id","in":"path","description":"Identifier of the Mobile Device Prestage the attachment should be assigned to","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"properties":{"file":{"type":"string","description":"The file to upload","format":"binary"}}}}},"required":true},"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrestageFileAttachmentV2"}}}},"404":{"description":"Mobile Device Prestage with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"413":{"description":"Payload Too Large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2025-06-30","x-required-privileges":["Create Mobile Device PreStage Enrollments"]}},"/v2/mobile-device-prestages/{id}/attachments/delete-multiple":{"post":{"tags":["mobile-device-prestages"],"summary":"Remove an attachment for a Mobile Device Prestage\n","description":"Remove an attachment for a Mobile Device Prestage\n\n> 📋 **Required privilege:** Delete Mobile Device PreStage Enrollments","parameters":[{"name":"id","in":"path","description":"Mobile Device Prestage identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ids"}}},"required":true},"responses":{"204":{"description":"Success"}},"deprecated":true,"x-deprecation-date":"2025-06-30","x-required-privileges":["Delete Mobile Device PreStage Enrollments"],"x-action":true}},"/v2/mobile-device-prestages/{id}/history":{"get":{"tags":["mobile-device-prestages"],"summary":"Get sorted and paged Mobile Device Prestage history objects\n","description":"Gets sorted and paged mobile device prestage history objects\n\n> 📋 **Required privilege:** Read Mobile Device PreStage Enrollments","parameters":[{"name":"id","in":"path","description":"Mobile Device Prestage identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property,asc/desc. Default sort order is descending. Multiple sort criteria are supported and must be entered on separate lines in Swagger UI. In the URI the 'sort' query param is duplicated for each sort criterion, e.g., ...&sort=name%2Casc&sort=date%2Cdesc","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["date:desc"]}}],"responses":{"200":{"description":"Details of mobile device prestage history were found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistorySearchResults"}}}}},"deprecated":true,"x-deprecation-date":"2025-06-30","x-required-privileges":["Read Mobile Device PreStage Enrollments"]},"post":{"tags":["mobile-device-prestages"],"summary":"Add Mobile Device Prestage history object notes\n","description":"Adds mobile device prestage history object notes\n\n> 📋 **Required privilege:** Update Mobile Device PreStage Enrollments","parameters":[{"name":"id","in":"path","description":"Mobile Device Prestage identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"History notes to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistoryNote"}}},"required":true},"responses":{"201":{"description":"Notes of mobile deivce prestage history were added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"503":{"description":"Mobile device prestage history can not be saved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2025-06-30","x-required-privileges":["Update Mobile Device PreStage Enrollments"]}},"/v2/mobile-device-prestages/{id}/scope":{"get":{"tags":["mobile-device-prestages"],"summary":"Get Device Scope for a specific Mobile Device Prestage\n","description":"Get device scope for a specific mobile device prestage\n\n> 📋 **Required privilege:** Read Mobile Device PreStage Enrollments","parameters":[{"name":"id","in":"path","description":"Mobile Device Prestage identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrestageScopeResponseV2"}}}},"404":{"description":"Mobile Device Prestage with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Mobile Device PreStage Enrollments"]},"put":{"tags":["mobile-device-prestages"],"summary":"Replace Device Scope for a specific Mobile Device Prestage\n","description":"Replace device scope for a specific mobile device prestage\n\n> 📋 **Required privilege:** Update Mobile Device PreStage Enrollments","parameters":[{"name":"id","in":"path","description":"Mobile Device Prestage identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Serial Numbers to scope","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrestageScopeUpdate"}}},"required":true},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrestageScopeResponseV2"}}}},"400":{"description":"One or more serial numbers are not valid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Mobile Device Prestage with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"Optimistic Lock Error - The prestage you are trying to update has been updated by another process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Mobile Device PreStage Enrollments"]},"post":{"tags":["mobile-device-prestages"],"summary":"Add Device Scope for a specific Mobile Device Prestage\n","description":"Add device scope for a specific mobile device prestage\n\n> 📋 **Required privilege:** Update Mobile Device PreStage Enrollments","parameters":[{"name":"id","in":"path","description":"Mobile Device Prestage identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Serial Numbers to scope","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrestageScopeUpdate"}}},"required":true},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrestageScopeResponseV2"}}}},"400":{"description":"One or more serial numbers are not valid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Mobile Device Prestage with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"Optimistic Lock Error - The prestage you are trying to update has been updated by another process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Mobile Device PreStage Enrollments"],"x-action":true}},"/v2/mobile-device-prestages/{id}/scope/delete-multiple":{"post":{"tags":["mobile-device-prestages"],"summary":"Remove Device Scope for a specific Mobile Device Prestage\n","description":"Remove device scope for a specific mobile device prestage\n\n> 📋 **Required privilege:** Update Mobile Device PreStage Enrollments","parameters":[{"name":"id","in":"path","description":"Mobile Device Prestage identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Serial Numbers to remove from scope","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrestageScopeUpdate"}}},"required":true},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrestageScopeResponseV2"}}}},"400":{"description":"One or more serial numbers are not valid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Mobile Device Prestage with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"Optimistic Lock Error - The prestage you are trying to update has been updated by another process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Mobile Device PreStage Enrollments"],"x-action":true}},"/v2/mobile-device-prestages/{id}/syncs":{"get":{"tags":["mobile-device-prestages"],"summary":"Get all prestage sync states for a single prestage\n","description":"Get all prestage sync states for a single prestage\n\n> 📋 **Required privilege:** Read Mobile Device PreStage Enrollments","parameters":[{"name":"id","in":"path","description":"Mobile Device Prestage identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PrestageSyncStatusV2"}}}}}},"x-required-privileges":["Read Mobile Device PreStage Enrollments"]}},"/v2/mobile-device-prestages/{id}/syncs/latest":{"get":{"tags":["mobile-device-prestages"],"summary":"Get the latest Sync State for a single Prestage\n","description":"Get the latest sync state for a single prestage\n\n> 📋 **Required privilege:** Read Mobile Device PreStage Enrollments","parameters":[{"name":"id","in":"path","description":"Mobile Device Prestage identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrestageSyncStatusV2"}}}}},"x-required-privileges":["Read Mobile Device PreStage Enrollments"]}},"/v3/mobile-device-prestages":{"get":{"tags":["mobile-device-prestages"],"summary":"Get sorted and paged Mobile Device Prestages\n","description":"Gets sorted and paged mobile device prestages\n\n> 📋 **Required privilege:** Read Mobile Device PreStage Enrollments","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:desc"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MobileDevicePrestageSearchResultsV3"}}}}},"x-required-privileges":["Read Mobile Device PreStage Enrollments"]},"post":{"tags":["mobile-device-prestages"],"summary":"Create a Mobile Device Prestage\n","description":"Create a mobile device prestage\n\n> 📋 **Required privilege:** Create Mobile Device PreStage Enrollments","requestBody":{"description":"Mobile Device Prestage to create. ids defined in this body will be ignored","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MobileDevicePrestageV3"}}},"required":true},"responses":{"201":{"description":"Mobile Device Prestage was created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}}},"x-required-privileges":["Create Mobile Device PreStage Enrollments"]}},"/v3/mobile-device-prestages/{id}":{"get":{"tags":["mobile-device-prestages"],"summary":"Retrieve a Mobile Device Prestage with the supplied id\n","description":"Retrieves a Mobile Device Prestage with the supplied id\n\n> 📋 **Required privilege:** Read Mobile Device PreStage Enrollments","parameters":[{"name":"id","in":"path","description":"Mobile Device Prestage identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMobileDevicePrestageV3"}}}},"404":{"description":"Mobile Device Prestage with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Mobile Device PreStage Enrollments"]},"put":{"tags":["mobile-device-prestages"],"summary":"Update a Mobile Device Prestage\n","description":"Updates a Mobile Device Prestage\n\n> 📋 **Required privilege:** Update Mobile Device PreStage Enrollments","parameters":[{"name":"id","in":"path","description":"Mobile Device Prestage identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Mobile Device Prestage to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PutMobileDevicePrestageV3"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMobileDevicePrestageV3"}}}},"404":{"description":"Mobile Device Prestage with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"The Mobile Device Prestage was modified by another process. Read the Mobile Device Prestage again for updated changes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Mobile Device PreStage Enrollments"]},"delete":{"tags":["mobile-device-prestages"],"summary":"Delete a Mobile Device Prestage with the supplied id\n","description":"Deletes a Mobile Device Prestage with the supplied id\n\n> 📋 **Required privilege:** Delete Mobile Device PreStage Enrollments","parameters":[{"name":"id","in":"path","description":"Mobile Device Prestage identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Success"}},"x-required-privileges":["Delete Mobile Device PreStage Enrollments"]}},"/v3/mobile-device-prestages/{id}/attachments":{"get":{"tags":["mobile-device-prestages"],"summary":"Get attachments for a Mobile Device Prestage\n","description":"Get attachments for a Mobile Device Prestage\n\n> 📋 **Required privilege:** Read Mobile Device PreStage Enrollments","parameters":[{"name":"id","in":"path","description":"Mobile Device Prestage identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FileAttachmentV3"}}}}},"404":{"description":"Mobile Device Prestage with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Mobile Device PreStage Enrollments"]},"post":{"tags":["mobile-device-prestages"],"summary":"Add an attachment to a Mobile Device Prestage\n","description":"Add an attachment to a Mobile Device prestage\n\n> 📋 **Required privilege:** Create Mobile Device PreStage Enrollments","parameters":[{"name":"id","in":"path","description":"Identifier of the Mobile Device Prestage the attachment should be assigned to","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"properties":{"file":{"type":"string","description":"The file to upload","format":"binary"}}}}},"required":true},"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrestageFileAttachmentV3"}}}},"404":{"description":"Mobile Device Prestage with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"413":{"description":"Payload Too Large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Create Mobile Device PreStage Enrollments"]}},"/v3/mobile-device-prestages/{id}/attachments/delete-multiple":{"post":{"tags":["mobile-device-prestages"],"summary":"Remove an attachment for a Mobile Device Prestage\n","description":"Remove an attachment for a Mobile Device Prestage\n\n> 📋 **Required privilege:** Delete Mobile Device PreStage Enrollments","parameters":[{"name":"id","in":"path","description":"Mobile Device Prestage identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ids"}}},"required":true},"responses":{"204":{"description":"Success"}},"x-required-privileges":["Delete Mobile Device PreStage Enrollments"],"x-action":true}},"/v3/mobile-device-prestages/{id}/history":{"get":{"tags":["mobile-device-prestages"],"summary":"Get sorted and paged Mobile Device Prestage history objects\n","description":"Gets sorted and paged mobile device prestage history objects\n\n> 📋 **Required privilege:** Read Mobile Device PreStage Enrollments","parameters":[{"name":"id","in":"path","description":"Mobile Device Prestage identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property,asc/desc. Default sort order is descending. Multiple sort criteria are supported and must be entered on separate lines in Swagger UI. In the URI the 'sort' query param is duplicated for each sort criterion, e.g., ...&sort=name%2Casc&sort=date%2Cdesc","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["date:desc"]}}],"responses":{"200":{"description":"Details of mobile device prestage history were found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistorySearchResults"}}}}},"x-required-privileges":["Read Mobile Device PreStage Enrollments"]},"post":{"tags":["mobile-device-prestages"],"summary":"Add Mobile Device Prestage history object notes\n","description":"Adds mobile device prestage history object notes\n\n> 📋 **Required privilege:** Update Mobile Device PreStage Enrollments","parameters":[{"name":"id","in":"path","description":"Mobile Device Prestage identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"History notes to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistoryNote"}}},"required":true},"responses":{"201":{"description":"Notes of mobile deivce prestage history were added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"503":{"description":"Mobile device prestage history can not be saved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Mobile Device PreStage Enrollments"]}},"/v2/mobile-devices":{"get":{"tags":["mobile-devices"],"summary":"Get Mobile Device objects\n","description":"Gets Mobile Device objects.\n\n\n> 📋 **Required privilege:** Read Mobile Devices","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MobileDeviceSearchResultsV2"}}}}},"x-required-privileges":["Read Mobile Devices"]}},"/v2/mobile-devices/detail":{"get":{"tags":["mobile-devices"],"summary":"Return paginated Mobile Device Inventory records","description":"Return paginated Mobile Device Inventory records\n\n> 📋 **Required privilege:** Read Mobile Devices","parameters":[{"name":"section","in":"query","description":"section of mobile device details, if not specified, General section data is returned. Multiple section parameters are supported, e.g. section=GENERAL&amp;section=HARDWARE","required":false,"style":"form","explode":true,"schema":{"type":"array","example":["GENERAL"],"items":{"$ref":"#/components/schemas/MobileDeviceSection"},"default":["GENERAL"]}},{"name":"exception-handling","in":"query","description":"Controls how the endpoint handles exceptions when processing device data.\n- STRICT (default): Returns a 500 error with details when a device has data processing issues.\n  Each problematic device is surfaced one at a time.\n- LENIENT: Returns a 200 response even when devices have processing issues. Problematic sections\n  will be null in the response, and all devices (including those with issues) are included.\n  Exceptions are logged to the Jamf Pro Server logs.\n","required":false,"style":"form","explode":true,"schema":{"type":"string","example":"STRICT","enum":["STRICT","LENIENT"],"default":"STRICT"}},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort\nis displayName:asc. Multiple sort criteria are supported and must be separated with\na comma.\n\nFields allowed in the sort: `airPlayPassword`, `appAnalyticsEnabled`, `assetTag`, `availableSpaceMb`,\n`batteryLevel`, `batteryHealth`, `bluetoothLowEnergyCapable`, `bluetoothMacAddress`, `capacityMb`,\n`lostModeEnabledDate`, `declarativeDeviceManagementEnabled`, `deviceId`, `deviceLocatorServiceEnabled`,\n`devicePhoneNumber`, `diagnosticAndUsageReportingEnabled`, `displayName`, `doNotDisturbEnabled`,\n`enrollmentSessionTokenValid`, `exchangeDeviceId`, `cloudBackupEnabled`, `osBuild`,\n`osSupplementalBuildVersion`, `osVersion`, `osRapidSecurityResponse`, `ipAddress`, `itunesStoreAccountActive`,\n`mobileDeviceId`, `managementId`, `languages`, `lastBackupDate`, `lastContactDate`, `lastEnrolledDate`, `lastCloudBackupDate`,\n`lastInventoryUpdateDate`, `locales`, `locationServicesForSelfServiceMobileEnabled`, `lostModeEnabled`,\n`managed`, `mdmProfileExpirationDate`, `model`, `modelIdentifier`,\n`modelNumber`, `modemFirmwareVersion`, `preferredVoiceNumber`, `quotaSize`, `residentUsers`,\n`serialNumber`, `sharedIpad`, `supervised`, `tethered`,\n`timeZone`, `udid`, `usedSpacePercentage`, `wifiMacAddress`,\n`deviceOwnershipType`, `building`, `department`, `emailAddress`,\n`fullName`, `userPhoneNumber`, `position`, `room`,\n`username`, `appleCareId`, `leaseExpirationDate`,`lifeExpectancyYears`,\n`poDate`, `poNumber`, `purchasePrice`, `purchasedOrLeased`,\n`purchasingAccount`, `purchasingContact`, `vendor`, `warrantyExpirationDate`,\n`activationLockEnabled`, `blockEncryptionCapable`, `dataProtection`, `fileEncryptionCapable`,\n`hardwareEncryptionSupported`, `jailbreakStatus`, `passcodeCompliant`, `passcodeCompliantWithProfile`,\n`passcodeLockGracePeriodEnforcedSeconds`, `passcodePresent`, `carrierSettingsVersion`,\n`cellularTechnology`, `currentCarrierNetwork`, `currentMobileCountryCode`, `currentMobileNetworkCode`,\n`dataRoamingEnabled`, `eid`, `network`, `homeMobileCountryCode`,\n`homeMobileNetworkCode`, `iccid`, `imei`, `imei2`,\n`meid`, `personalHotspotEnabled`, `voiceRoamingEnabled`, `roaming`, `lastLoggedInUsernameSelfService`, `lastLoggedInUsernameSelfServiceTimestamp`, `lastLoggedInUsernameMdm`, `lastLoggedInUsernameMdmTimestamp`\n\nExample: `sort=displayName:desc,username:asc`\n","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["displayName:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter mobile device collection.\nDefault filter is empty query - returning all results for the requested page.\n\nFields allowed in the query: `airPlayPassword`, `appAnalyticsEnabled`, `assetTag`, `availableSpaceMb`,\n`batteryLevel`, `bluetoothLowEnergyCapable`, `bluetoothMacAddress`, `capacityMb`,\n`declarativeDeviceManagementEnabled`, `deviceId`, `deviceLocatorServiceEnabled`, `devicePhoneNumber`,\n`diagnosticAndUsageReportingEnabled`, `displayName`, `doNotDisturbEnabled`, `exchangeDeviceId`,\n`cloudBackupEnabled`, `osBuild`, `osSupplementalBuildVersion`, `osVersion`, `osRapidSecurityResponse`,\n`ipAddress`, `itunesStoreAccountActive`, `mobileDeviceId`, `managementId`, `languages`, `lastContactDate`, `lastInventoryUpdateDate`, `locales`,\n`locationServicesForSelfServiceMobileEnabled`, `lostModeEnabled`, `managed`, `model`,\n`modelIdentifier`, `modelNumber`, `modemFirmwareVersion`, `preferredVoiceNumber`, `quotaSize`,\n`residentUsers`, `serialNumber`, `sharedIpad`, `supervised`,\n`tethered`, `timeZone`, `udid`, `usedSpacePercentage`,\n`wifiMacAddress`, `building`, `department`, `emailAddress`,\n`fullName`, `userPhoneNumber`, `position`, `room`,\n`username`, `appleCareId`, `lifeExpectancyYears`, `poNumber`,\n`purchasePrice`, `purchasedOrLeased`, `purchasingAccount`, `purchasingContact`,\n`vendor`, `activationLockEnabled`, `awaitingConfiguration`, `blockEncryptionCapable`, `dataProtection`,\n`fileEncryptionCapable`, `lockdownModeEnabled`, `passcodeCompliant`, `passcodeCompliantWithProfile`, `passcodeLockGracePeriodEnforcedSeconds`,\n`passcodePresent`, `returnToServiceEnabled`, `carrierSettingsVersion`, `currentCarrierNetwork`,\n`currentMobileCountryCode`, `currentMobileNetworkCode`, `dataRoamingEnabled`, `eid`,\n`network`, `homeMobileCountryCode`, `homeMobileNetworkCode`, `iccid`,\n`imei`, `imei2`, `meid`, `personalHotspotEnabled`,\n`roaming`, `lastLoggedInUsernameSelfService`, `lastLoggedInUsernameSelfServiceTimestamp`, `lastLoggedInUsernameMdm`, `lastLoggedInUsernameMdmTimestamp`,\n`groupId`, `groupName`\n\nThis param can be combined with paging and sorting.\nExample: `filter=displayName==\"iPad\"`\n","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MobileDeviceInventorySearchResults"}}}}},"x-required-privileges":["Read Mobile Devices"]}},"/v2/mobile-devices/{id}":{"get":{"tags":["mobile-devices"],"summary":"Get Mobile Device\n","description":"Get MobileDevice\n\n> 📋 **Required privilege:** Read Mobile Devices","parameters":[{"name":"id","in":"path","description":"instance id of mobile device record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MobileDeviceV2"}}}},"404":{"description":"Specified mobile device object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Mobile Devices"]},"patch":{"tags":["mobile-devices"],"summary":"Update fields on a mobile device that are allowed to be modified by users\n","description":"Updates fields on a mobile device that are allowed to be modified by users.\n\n> 📋 **Required privilege:** Update Mobile Devices","parameters":[{"name":"id","in":"path","description":"instance id of mobile device record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMobileDeviceV2"}}},"required":true},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MobileDeviceDetailsV2"}}}},"403":{"description":"Account not allowed to modify device","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Specified mobile device object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Mobile Devices"]}},"/v2/mobile-devices/{id}/detail":{"get":{"tags":["mobile-devices"],"summary":"Get Mobile Device\n","description":"Get MobileDevice\n\n> 📋 **Required privilege:** Read Mobile Devices","parameters":[{"name":"id","in":"path","description":"instance id of mobile device record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MobileDeviceDetailsGetV2"}}}},"404":{"description":"Specified mobile device object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Mobile Devices"]}},"/v2/mobile-devices/{id}/erase":{"post":{"tags":["mobile-devices"],"summary":"Erase a Mobile Device\n","description":"Erase a Mobile Device\n\n> 📋 **Required privilege:** Send Mobile Device Remote Wipe Command","parameters":[{"name":"id","in":"path","description":"Id of the Mobile Device to erase","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Options for eraseDevice command","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EraseDeviceMobileDeviceRequest"}}}},"responses":{"200":{"description":"Erase command was queued for this device.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EraseDeviceMobileDeviceResponse"}}}},"400":{"description":"Return to service requirements not met.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Insufficient privileges to perform this action."},"404":{"description":"Mobile device not found."},"500":{"description":"Failure, unable to queue command.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Send Mobile Device Remote Wipe Command"],"x-action":true}},"/v2/mobile-devices/{id}/paired-devices":{"get":{"tags":["mobile-devices"],"summary":"Return paginated Mobile Device Inventory records of all paired devices for the device\n","description":"Return paginated Mobile Device Inventory records of all paired devices for the device\n\n> 📋 **Required privilege:** Read Mobile Devices","parameters":[{"name":"id","in":"path","description":"instance id of mobile device record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"section","in":"query","description":"section of mobile device details, if not specified, Paired Devices section data is returned. Multiple section parameters are supported, e.g. section=GENERAL&amp;section=HARDWARE","required":false,"style":"form","explode":true,"schema":{"type":"array","example":["GENERAL"],"items":{"$ref":"#/components/schemas/MobileDeviceSection"},"default":["GENERAL"]}},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort\nis displayName:asc. Multiple sort criteria are supported and must be separated with\na comma.\n\nFields allowed in the sort: `airPlayPassword`, `appAnalyticsEnabled`, `assetTag`, `availableSpaceMb`,\n`batteryLevel`, `bluetoothLowEnergyCapable`, `bluetoothMacAddress`, `capacityMb`,\n`lostModeEnabledDate`, `declarativeDeviceManagementEnabled`, `deviceId`, `deviceLocatorServiceEnabled`,\n`devicePhoneNumber`, `diagnosticAndUsageReportingEnabled`, `displayName`, `doNotDisturbEnabled`,\n`enrollmentSessionTokenValid`, `osBuild`, `osSupplementalBuildVersion`, `osVersion`, `osRapidSecurityResponse`,\n`ipAddress`, `itunesStoreAccountActive`, `mobileDeviceId`, `languages`, `lastContactDate`, `lastEnrolledDate`, `lastCloudBackupDate`,\n`lastInventoryUpdateDate`, `locales`, `lostModeEnabled`,\n`managed`, `mdmProfileExpirationDate`, `model`, `modelIdentifier`, `modelNumber`, `modemFirmwareVersion`,\n`preferredVoiceNumber`, `serialNumber`, `supervised`, `timeZone`, `udid`, `usedSpacePercentage`, `wifiMacAddress`,\n`deviceOwnershipType`, `building`, `department`, `emailAddress`,\n`fullName`, `userPhoneNumber`, `position`, `room`,\n`username`, `appleCareId`, `leaseExpirationDate`,`lifeExpectancyYears`,\n`poDate`, `poNumber`, `purchasePrice`, `purchasedOrLeased`,\n`purchasingAccount`, `purchasingContact`, `vendor`, `warrantyExpirationDate`,\n`activationLockEnabled`, `blockEncryptionCapable`, `dataProtection`, `fileEncryptionCapable`,\n`hardwareEncryptionSupported`, `jailbreakStatus`, `passcodeCompliant`, `passcodeCompliantWithProfile`,\n`passcodeLockGracePeriodEnforcedSeconds`, `passcodePresent`, `carrierSettingsVersion`,\n`cellularTechnology`, `currentCarrierNetwork`, `currentMobileCountryCode`, `currentMobileNetworkCode`,\n`dataRoamingEnabled`, `eid`, `network`, `homeMobileCountryCode`,\n`homeMobileNetworkCode`, `iccid`, `imei`, `imei2`,\n`meid`, `personalHotspotEnabled`, `voiceRoamingEnabled`, `roaming`, `lastLoggedInUsernameSelfService`, `lastLoggedInUsernameSelfServiceTimestamp`, `lastLoggedInUsernameMdm`, `lastLoggedInUsernameMdmTimestamp`\n\nExample: `sort=displayName:desc,username:asc`\n","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["displayName:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter mobile device collection.\nDefault filter is empty query - returning all results for the requested page.\n\nFields allowed in the query: `airPlayPassword`, `appAnalyticsEnabled`, `assetTag`, `availableSpaceMb`,\n`batteryLevel`, `bluetoothLowEnergyCapable`, `bluetoothMacAddress`, `capacityMb`,\n`declarativeDeviceManagementEnabled`, `deviceId`, `deviceLocatorServiceEnabled`, `devicePhoneNumber`,\n`diagnosticAndUsageReportingEnabled`, `displayName`, `doNotDisturbEnabled`,\n`osBuild`, `osSupplementalBuildVersion`, `osVersion`, `osRapidSecurityResponse`,\n`ipAddress`, `itunesStoreAccountActive`, `mobileDeviceId`, `languages`, `lastContactDate`, `lastInventoryUpdateDate`, `locales`,\n`lostModeEnabled`, `managed`, `model`,\n`modelIdentifier`, `modelNumber`, `modemFirmwareVersion`, `preferredVoiceNumber`, `serialNumber`, `supervised`, `timeZone`, `udid`, `usedSpacePercentage`,\n`wifiMacAddress`, `building`, `department`, `emailAddress`,\n`fullName`, `userPhoneNumber`, `position`, `room`,\n`username`, `appleCareId`, `lifeExpectancyYears`, `poNumber`,\n`purchasePrice`, `purchasedOrLeased`, `purchasingAccount`, `purchasingContact`,\n`vendor`, `activationLockEnabled`, `blockEncryptionCapable`, `dataProtection`,\n`fileEncryptionCapable`, `passcodeCompliant`, `passcodeCompliantWithProfile`, `passcodeLockGracePeriodEnforcedSeconds`,\n`passcodePresent`, `carrierSettingsVersion`, `currentCarrierNetwork`,\n`currentMobileCountryCode`, `currentMobileNetworkCode`, `dataRoamingEnabled`, `eid`,\n`network`, `homeMobileCountryCode`, `homeMobileNetworkCode`, `iccid`,\n`imei`, `imei2`, `meid`, `personalHotspotEnabled`,\n`roaming`, `lastLoggedInUsernameSelfService`, `lastLoggedInUsernameSelfServiceTimestamp`, `lastLoggedInUsernameMdm`, `lastLoggedInUsernameMdmTimestamp`,\n`groupId`, `groupName`\n\nThis param can be combined with paging and sorting.\nExample: `filter=displayName==\"iPad\"`\n","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MobileDeviceInventorySearchResults"}}}}},"x-required-privileges":["Read Mobile Devices"]}},"/v2/mobile-devices/{id}/unmanage":{"post":{"tags":["mobile-devices"],"summary":"Unmanage a Mobile Device\n","description":"Unmanage a Mobile Device\n\n> 📋 **Required privilege:** Unmanage Mobile Devices","parameters":[{"name":"id","in":"path","description":"Id of the mobile device to remove the MDM profile from","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Command to remove the mdm profile was queued","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmanageMobileDeviceResponse"}}}},"403":{"description":"Insufficient privileges to perform this action."},"500":{"description":"Failure, unable to queue command.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Unmanage Mobile Devices"],"x-action":true}},"/v1/oidc/direct-idp-login-url":{"get":{"tags":["oidc"],"summary":"Retrieve the URL to directly login to the IdP\n","description":"Retrieve the URL to directly login to the IdP","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OidcDirectIdpLoginSkipUrl"}}}},"404":{"description":"OIDC is disabled or no authorization registration ID found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-authentication-required":true}},"/v1/oidc/dispatch":{"post":{"tags":["oidc"],"summary":"Provide the url to redirect for OIDC login","description":"Provide the url to redirect for OIDC login based on email","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OidcLoginDispatchRequest"}}},"required":true},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OidcLoginDispatchResponse"}}}},"400":{"description":"Email address or original URL parameter is invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"OIDC is disabled, or OIDC login dispatch is unavailable because the OIDC broker is enabled","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2026-02-17","x-action":true,"x-authentication-required":false}},"/v1/oidc/generate-certificate":{"post":{"tags":["oidc"],"summary":"Generate a new keystore used for signing OIDC messages\n","description":"Generates a new certificate used for signing OIDC messages\n\n> 📋 **Required privilege:** Update SSO Settings","responses":{"201":{"description":"Successful response"},"503":{"description":"OIDC is disabled","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update SSO Settings"],"x-action":true}},"/v1/oidc/public-features":{"get":{"tags":["oidc"],"summary":"Get the public features of the OIDC configuration","description":"Retrieves public OIDC configuration features.","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OidcPublicFeaturesResponse"}}}}},"x-authentication-required":false}},"/v1/oidc/public-key":{"get":{"tags":["oidc"],"summary":"Get the public key of the keystore used for signing OIDC messages as a JWT\n","description":"Gets the public key of the keystore used for signing OIDC messages as a JWT","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OidcJwksResponse"}}}},"404":{"description":"Unable to retrieve OIDC certificate public key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"OIDC is disabled","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-authentication-required":false}},"/v2/oidc/dispatch":{"post":{"tags":["oidc"],"summary":"Provide the url to redirect for OIDC login","description":"Provide the url to redirect for OIDC login based on email","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OidcLoginDispatchRequest"}}},"required":true},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OidcLoginDispatchResponseV2"}}}},"400":{"description":"Email address or original URL parameter is invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"OIDC is disabled, or OIDC login dispatch is unavailable because the OIDC broker is enabled","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-action":true,"x-authentication-required":false}},"/v1/onboarding":{"get":{"tags":["onboarding"],"summary":"Get the current onboarding settings configuration.","description":"Get the current onboarding settings configuration.\n\n> 📋 **Required privilege:** Read Onboarding Configuration","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnboardingConfiguration"}}}}},"x-required-privileges":["Read Onboarding Configuration"]},"put":{"tags":["onboarding"],"summary":"Update the onboarding configuration.","description":"Update the onboarding configuration.\n\n> 📋 **Required privilege:** Update Onboarding Configuration","requestBody":{"description":"Onboarding settings to save.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnboardingConfiguration"}}},"required":true},"responses":{"200":{"description":"Successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnboardingConfiguration"}}}},"400":{"description":"Unable to add invalid or ineligible items to the onboarding configuration.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Onboarding Configuration"]}},"/v1/onboarding/eligible-apps":{"get":{"tags":["onboarding"],"summary":"Retrieves a list of applications that are eligible to be used in an onboarding configuration","description":"Retrieves a list of applications that are eligible to be used in an onboarding configuration\n\n> 📋 **Required privilege:** Read Onboarding Configuration","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnboardingEligibleItemsSearchResult"}}}}},"x-required-privileges":["Read Onboarding Configuration"]}},"/v1/onboarding/eligible-configuration-profiles":{"get":{"tags":["onboarding"],"summary":"Retrieves a list of configuration profiles that are eligible to be used in an onboarding configuration","description":"Retrieves a list of configuration profiles that are eligible to be used in an onboarding configuration\n\n> 📋 **Required privilege:** Read Onboarding Configuration","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnboardingEligibleItemsSearchResult"}}}}},"x-required-privileges":["Read Onboarding Configuration"]}},"/v1/onboarding/eligible-policies":{"get":{"tags":["onboarding"],"summary":"Retrieves a list of policies that are eligible to be used in an onboarding configuration","description":"Retrieves a list of policies that are eligible to be used in an onboarding configuration\n\n> 📋 **Required privilege:** Read Onboarding Configuration","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnboardingEligibleItemsSearchResult"}}}}},"x-required-privileges":["Read Onboarding Configuration"]}},"/v1/onboarding/history":{"get":{"tags":["onboarding"],"summary":"Get Onboarding history object\n","description":"Gets Onboarding history object\n\n\n> 📋 **Required privilege:** Read Onboarding Configuration","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["date:desc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and date<2019-12-15","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Details of onboarding history were found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistorySearchResults"}}}}},"x-required-privileges":["Read Onboarding Configuration"]},"post":{"tags":["onboarding"],"summary":"Add Onboarding history object notes\n","description":"Adds Onboarding history object notes\n\n\n> 📋 **Required privilege:** Update Onboarding Configuration","requestBody":{"description":"history notes to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistoryNote"}}},"required":true},"responses":{"201":{"description":"Notes of onboarding history were added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"503":{"description":"Onboarding history can not be saved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Onboarding Configuration"]}},"/v1/onboarding/history/export":{"post":{"tags":["onboarding"],"summary":"Export history object collection in specified format for Onboarding\n","description":"Export history object collection in specified format for Onboarding\n\n\n> 📋 **Required privilege:** Read Onboarding Configuration","parameters":[{"$ref":"#/components/parameters/export-fields"},{"$ref":"#/components/parameters/export-labels"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["date:desc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and date<2019-12-15","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"requestBody":{"description":"Optional. Override query parameters since they can make URI exceed 2,000 character limit.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportParameters"}}},"required":false},"responses":{"200":{"description":"Export successful","content":{"text/csv":{"schema":{"format":"binary","example":"username,date,note,details\nadmin,2019-02-04 21:09:31,Edited,item detail\n"}}}},"400":{"description":"Export fields specified incorrectly - non-existing column or duplicate on the list.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"Export currently unavailable, all export-related resources are in use. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Onboarding Configuration"],"x-action":true}},"/v1/packages":{"get":{"tags":["packages"],"summary":"Retrieve Packages","description":"Retrieves packages\n\n> 📋 **Required privilege:** Read Packages","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorts results by one or more criteria, following the format property:asc/desc. Default sort is ID:asc. If using multiple criteria, separate with commas.","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}},{"name":"filter","in":"query","description":"Filters results. Use RSQL format for query. Allows for many fields, including ID, name, etc. Can be combined with paging and sorting. Fields allowed in the query: id, fileName, packageName, categoryId, info, notes, manifestFileName, cloudTransferStatus. Default filter is an empty query and returns all results from the requested page.","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackagesSearchResults"}}}}},"x-required-privileges":["Read Packages"]},"post":{"tags":["packages"],"summary":"Create package","description":"Create package\n\n> 📋 **Required privilege:** Create Packages","requestBody":{"description":"Package to be created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Package"}}},"required":true},"responses":{"201":{"description":"Package was created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}}},"x-required-privileges":["Create Packages"]}},"/v1/packages/delete-multiple":{"post":{"tags":["packages"],"summary":"Delete multiple packages at once","description":"IDs of the packages to be deleted\n\n> 📋 **Required privilege:** Delete Packages","requestBody":{"description":"ids of the package to be deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ids"}}},"required":true},"responses":{"204":{"description":"All specified packages deleted successfully"},"400":{"description":"Returns error codes and IDs for any packages that were unable to be deleted. Possible error codes include INVALID_ID (Package ID does not exist) and SYSTEM_EXCEPTION (A system exception occurred while attempting to delete the package).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Delete Packages"],"x-action":true}},"/v1/packages/export":{"post":{"tags":["packages"],"summary":"Export Packages collection\n","description":"Export Packages collection\n\n\n> 📋 **Required privilege:** Read Packages","parameters":[{"$ref":"#/components/parameters/export-fields"},{"$ref":"#/components/parameters/export-labels"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorts results by one or more criteria, following the format property:asc/desc. Default sort is ID:asc. If using multiple criteria, separate with commas.","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}},{"name":"filter","in":"query","description":"Filters results. Use RSQL format for query. Allows for many fields, including ID, name, etc. Can be combined with paging and sorting. Default filter is an empty query and returns all results from the requested page.","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"requestBody":{"description":"Optional. Can be used to override query parameters so that the URI does not exceed the 2,000 character limit.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportParameters"}}},"required":false},"responses":{"200":{"description":"Export successful","content":{"text/csv":{"schema":{"format":"binary","example":"id,packageName\n1,Chrome\n2,Firefox\n"}}}},"400":{"description":"Could not export. List may contain a non-existing column or a duplicate.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"Export currently unavailable. All export-related resources are in use. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Packages"],"x-action":true}},"/v1/packages/{id}":{"get":{"tags":["packages"],"summary":"Get specified Package object\n","description":"Gets specified Package object\n\n\n> 📋 **Required privilege:** Read Packages","parameters":[{"name":"id","in":"path","description":"instance id of package","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Package details found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Package"}}}},"404":{"description":"Specified package object could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Packages"]},"put":{"tags":["packages"],"summary":"Update specified package object\n","description":"Update specified package object\n\n\n> 📋 **Required privilege:** Update Packages","parameters":[{"name":"id","in":"path","description":"Instance ID of package","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Package object to update. IDs defined in this body will be ignored","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Package"}}},"required":true},"responses":{"200":{"description":"Package update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Package"}}}}},"x-required-privileges":["Update Packages"]},"delete":{"tags":["packages"],"summary":"Remove specified package\n","description":"Removes specified package\n\n\n> 📋 **Required privilege:** Delete Packages","parameters":[{"name":"id","in":"path","description":"Instance ID of package","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Package deleted successfully"}},"x-required-privileges":["Delete Packages"]}},"/v1/packages/{id}/history":{"get":{"tags":["packages"],"summary":"Get specified Package History object\n","description":"Gets specified Package history object\n\n\n> 📋 **Required privilege:** Read Packages","parameters":[{"name":"id","in":"path","description":"Instance ID of package history","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorts results by one or more criteria, following the format property:asc/desc. Default sort is ID:asc. If using multiple criteria, separate with commas.","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["date:desc"]}},{"name":"filter","in":"query","description":"Filters results. Use RSQL format for query. Allows for many fields, including ID, name, etc. Can be combined with paging and sorting. Default filter is an empty query and returns all results from the requested page.","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Details of package history were found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistorySearchResults"}}}},"404":{"description":"Specified package history object could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Packages"]},"post":{"tags":["packages"],"summary":"Add specified Package history object notes\n","description":"Adds specified Package history object notes\n\n\n> 📋 **Required privilege:** Update Packages","parameters":[{"name":"id","in":"path","description":"Instance ID of package history","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"History note to be created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistoryNote"}}},"required":true},"responses":{"201":{"description":"Package history note created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistory"}}}},"404":{"description":"Package history note could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"Package history note could not be saved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Packages"]}},"/v1/packages/{id}/history/export":{"post":{"tags":["packages"],"summary":"Export history object collection in specified format for specified Packages\n","description":"Export history object collection in specified format for specified Packages\n\n\n> 📋 **Required privilege:** Read Packages","parameters":[{"$ref":"#/components/parameters/export-fields"},{"$ref":"#/components/parameters/export-labels"},{"name":"id","in":"path","description":"Instance ID of package history note","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorts results by one or more criteria, following the format property:asc/desc. Default sort is ID:asc. If using multiple criteria, separate with commas.","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["date:desc"]}},{"name":"filter","in":"query","description":"Filters results. Use RSQL format for query. Allows for many fields, including ID, name, etc. Can be combined with paging and sorting. Default filter is an empty query and returns all results from the requested page.","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"requestBody":{"description":"Optional. Can be used to override query parameters so that the URI does not exceed the 2,000 character limit.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportParameters"}}},"required":false},"responses":{"200":{"description":"Export successful","content":{"text/csv":{"schema":{"format":"binary","example":"id,username,date,note,details\n1,admin,2019-02-04 21:09:31,Packages update,Some details\n"}}}},"400":{"description":"Could not export. List may contain a non-existing column or a duplicate.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"Export currently unavailable. All export-related resources are in use. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Packages"],"x-action":true}},"/v1/packages/{id}/manifest":{"post":{"tags":["packages"],"summary":"Add a manifest to a package\n","description":"Add a manifest to a package\n\n> 📋 **Required privileges:**\n> - Update Packages\n> - Read Packages","parameters":[{"name":"id","in":"path","description":"Id of the package the manifest should be assigned to","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"The manifest file to upload","format":"binary"}}}}},"required":true},"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Package"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Package with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"413":{"description":"Payload Too Large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Packages","Read Packages"]},"delete":{"tags":["packages"],"summary":"Delete the manifest for a specified package\n","description":"Delete the manifest file for a specified package\n\n\n> 📋 **Required privileges:**\n> - Update Packages\n> - Read Packages","parameters":[{"name":"id","in":"path","description":"Id of the package to delete manifest from","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Package manifest deleted successfully"},"404":{"description":"Package with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Packages","Read Packages"]}},"/v1/packages/{id}/upload":{"post":{"tags":["packages"],"summary":"Upload package","description":"Uploads a package\n\n> 📋 **Required privileges:**\n> - Update Packages\n> - Read Packages","parameters":[{"name":"id","in":"path","description":"instance id of package","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"The file to upload","format":"binary"}}}}},"required":true},"responses":{"201":{"description":"Successfully uploaded package","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"404":{"description":"Specified package object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Packages","Read Packages"],"x-action":true}},"/v1/parent-app":{"get":{"tags":["parent-app-preview"],"summary":"Get the current Jamf Parent app settings\n","description":"Get the current Jamf Parent app settings\n\n\n> 📋 **Required privilege:** Read Parent App Settings","responses":{"200":{"description":"Details of the current Jamf Parent app settings.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParentApp"}}}}},"x-required-privileges":["Read Parent App Settings"]},"put":{"tags":["parent-app-preview"],"summary":"Update Jamf Parent app settings\n","description":"Update Jamf Parent app settings\n\n\n> 📋 **Required privilege:** Update Parent App Settings","requestBody":{"description":"Jamf Parent app settings to save.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParentApp"}}},"required":true},"responses":{"200":{"description":"Jamf Parent app settings updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParentApp"}}}},"400":{"description":"Bad Request, could not parse input.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Parent App Settings"]}},"/v1/parent-app/history":{"get":{"tags":["parent-app-preview"],"summary":"Get Jamf Parent app settings history\n","description":"Gets Jamf Parent app settings history\n\n\n> 📋 **Required privilege:** Read Parent App Settings","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"$ref":"#/components/parameters/filter"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc ","required":false,"style":"form","explode":true,"schema":{"type":"string","default":"date:desc"}}],"responses":{"200":{"description":"Details of Jamf Parent app settings history were found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistorySearchResults"}}}}},"x-required-privileges":["Read Parent App Settings"]},"post":{"tags":["parent-app-preview"],"summary":"Add Jamf Parent app settings history notes\n","description":"Adds Jamf Parent app settings history notes\n\n\n> 📋 **Required privilege:** Update Parent App Settings","requestBody":{"description":"history notes to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistoryNote"}}},"required":true},"responses":{"201":{"description":"Notes to Jamf Parent app settings history were added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistory"}}}},"503":{"description":"Jamf Parent app history can not be saved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Parent App Settings"]}},"/v2/patch-management-accept-disclaimer":{"post":{"tags":["patch-management"],"summary":"Accept Patch Management disclaimer\n","description":"Accept Patch Management disclaimer\n\n> 📋 **Required privilege:** Update Patch Management Software Titles","responses":{"202":{"description":"Accepted"}},"x-required-privileges":["Update Patch Management Software Titles"],"x-action":true}},"/v2/patch-policies":{"get":{"tags":["patch-policies"],"summary":"Retrieve Patch Policies","description":"Retrieves a list of patch policies.\n\n> 📋 **Required privilege:** Read Patch Policies","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma.","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter Patch Policy collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: id, policyName, policyEnabled, policyTargetVersion, policyDeploymentMethod, softwareTitle, softwareTitleConfigurationId, pending, completed, deferred, and failed. This param can be combined with paging and sorting.","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchPolicies"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Patch Policies"]}},"/v2/patch-policies/policy-details":{"get":{"tags":["patch-policies"],"summary":"Retrieve Patch Policies","description":"Retrieves a list of patch policies.\n\n> 📋 **Required privilege:** Read Patch Policies","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma.","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter Patch Policy collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: id, name, enabled, targetPatchVersion, deploymentMethod, softwareTitleId, softwareTitleConfigurationId, killAppsDelayMinutes, killAppsMessage, isDowngrade, isPatchUnknownVersion, notificationHeader, selfServiceEnforceDeadline, selfServiceDeadline, installButtonText, selfServiceDescription, iconId, reminderFrequency, reminderEnabled. This param can be combined with paging and sorting.","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchPolicyDetails"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Patch Policies"]}},"/v2/patch-policies/{id}/dashboard":{"get":{"tags":["patch-policies"],"summary":"Return whether or not the requested patch policy is on the dashboard\n","description":"Returns whether or not the requested patch policy is on the dashboard\n\n> 📋 **Required privilege:** Read Patch Policies","parameters":[{"name":"id","in":"path","description":"patch policy id","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Whether the Patch Policy is on the Dashboard.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchPolicyV2OnDashboard"}}}},"404":{"description":"The requested Patch Policy does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Patch Policies"]},"post":{"tags":["patch-policies"],"summary":"Add a patch policy to the dashboard\n","description":"Adds a patch policy to the dashboard.\n\n> 📋 **Required privilege:** Read Patch Policies","parameters":[{"name":"id","in":"path","description":"patch policy id","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"OK"}},"x-action":true,"x-required-privileges":["Read Patch Policies"]},"delete":{"tags":["patch-policies"],"summary":"Remove a patch policy from the dashboard\n","description":"Removes a patch policy from the dashboard.\n\n> 📋 **Required privilege:** Read Patch Policies","parameters":[{"name":"id","in":"path","description":"patch policy id","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"OK"}},"x-required-privileges":["Read Patch Policies"]}},"/v2/patch-policies/{id}/logs":{"get":{"tags":["patch-policy-logs"],"summary":"Retrieve Patch Policy Logs\n","description":"Retrieves Patch Policy Logs\n\n> 📋 **Required privilege:** Read Patch Policies","parameters":[{"name":"id","in":"path","description":"patch policy id","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is deviceName:asc. Multiple sort criteria are supported and must be separated with a comma.","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["deviceName:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter Patch Policy Logs collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: deviceId, deviceName, statusCode, statusDate, attemptNumber, ignoredForPatchPolicyId. This param can be combined with paging and sorting.","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchPolicyLogs"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Patch Policy Log with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Patch Policies"]}},"/v2/patch-policies/{id}/logs/eligible-retry-count":{"get":{"tags":["patch-policy-logs"],"summary":"Return the count of the Patch Policy Logs for the patch policy id that are eligible for a retry attempt\n","description":"return the count of the patch policy logs for the patch policy id that  are eligible for a retry attempt\n\n> 📋 **Required privilege:** Read Patch Policies","parameters":[{"name":"id","in":"path","description":"patch policy id","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Number of patch policy logs found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchPolicyLogEligibleRetryCount"}}}}},"x-required-privileges":["Read Patch Policies"]}},"/v2/patch-policies/{id}/logs/retry":{"post":{"tags":["patch-policy-logs"],"summary":"Send retry attempts for specific devices","description":"Send retry attempts for specific devices\n\n> 📋 **Required privilege:** Update Patch Policies","parameters":[{"name":"id","in":"path","description":"patch policy id","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchPolicyLogRetry"}}},"required":true},"responses":{"204":{"description":"OK"}},"x-required-privileges":["Update Patch Policies"],"x-action":true}},"/v2/patch-policies/{id}/logs/retry-all":{"post":{"tags":["patch-policy-logs"],"summary":"Send retry attempts for all devices","description":"Send retry attempts for all devices\n\n> 📋 **Required privilege:** Update Patch Policies","parameters":[{"name":"id","in":"path","description":"patch policy id","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"202":{"description":"OK"},"204":{"description":"OK"}},"x-required-privileges":["Update Patch Policies"],"x-action":true}},"/v2/patch-policies/{id}/logs/{deviceId}":{"get":{"tags":["patch-policy-logs"],"summary":"Retrieves a single Patch Policy Log\n","description":"Retrieves a single Patch Policy Log\n\n> 📋 **Required privilege:** Read Patch Policies","parameters":[{"name":"id","in":"path","description":"patch policy id","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"deviceId","in":"path","description":"device id","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Patch Policy Log","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchPolicyLogV2"}}}},"404":{"description":"Patch Policy Logs with those ids do not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Patch Policies"]}},"/v2/patch-policies/{id}/logs/{deviceId}/details":{"get":{"tags":["patch-policy-logs"],"summary":"Return attempt details for a specific log","description":"Return attempt details for a specific log\n\n> 📋 **Required privilege:** Read Patch Policies","parameters":[{"name":"id","in":"path","description":"patch policy id","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"deviceId","in":"path","description":"device id","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Attempt details","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PatchPolicyLogDetail"}}}}},"404":{"description":"Patch Policy Logs with those ids do not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Patch Policies"]}},"/v2/patch-software-title-configurations":{"get":{"tags":["patch-software-title-configurations"],"summary":"Retrieve Patch Software Title Configurations","description":"Retrieves patch software title configurations\n\n> 📋 **Required privilege:** Read Patch Management Software Titles","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PatchSoftwareTitleConfiguration"}}}}}},"deprecated":true,"x-deprecation-date":"2026-07-14","x-required-privileges":["Read Patch Management Software Titles"]},"post":{"tags":["patch-software-title-configurations"],"summary":"Create Patch Software Title Configurations","description":"Creates Patch Software Title Configurations using sToken\n\n> 📋 **Required privilege:** Create Patch Management Software Titles","requestBody":{"description":"Software title configurations to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchSoftwareTitleConfigurationBase"}}},"required":true},"responses":{"201":{"description":"Patch Software Title Configurations were created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2026-07-14","x-required-privileges":["Create Patch Management Software Titles"]}},"/v2/patch-software-title-configurations/{id}":{"get":{"tags":["patch-software-title-configurations"],"summary":"Retrieve Patch Software Title Configurations with the supplied id","description":"Retrieves Patch Software Title Configurations with the supplied id\n\n> 📋 **Required privilege:** Read Patch Management Software Titles","parameters":[{"name":"id","in":"path","description":"Patch Software Title Configurations identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchSoftwareTitleConfiguration"}}}},"404":{"description":"Patch Software Title Configurations with that id do not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2026-07-14","x-required-privileges":["Read Patch Management Software Titles"]},"delete":{"tags":["patch-software-title-configurations"],"summary":"Delete Patch Software Title Configurations with the supplied id","description":"Deletes Patch Software Title Configurations with the supplied id\n\n> 📋 **Required privilege:** Delete Patch Management Software Titles","parameters":[{"name":"id","in":"path","description":"Patch Software Title Configurations identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Success"},"404":{"description":"Specified Patch Software Title Configurations object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2026-07-14","x-required-privileges":["Delete Patch Management Software Titles"]},"patch":{"tags":["patch-software-title-configurations"],"summary":"Update Patch Software Title Configurations","description":"Updates Patch Software Title Configurations\n\n> 📋 **Required privilege:** Update Patch Management Software Titles","parameters":[{"name":"id","in":"path","description":"Patch Software Title Configurations identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Patch Software Title Configurations to update","content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/PatchSoftwareTitleConfigurationPatch"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchSoftwareTitleConfiguration"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Software Title Configurations with that id do not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"There was an error applying the patch","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2026-07-14","x-required-privileges":["Update Patch Management Software Titles"]}},"/v2/patch-software-title-configurations/{id}/dashboard":{"get":{"tags":["patch-software-title-configurations"],"summary":"Return whether or not the requested software title configuration is on the dashboard\n","description":"Returns whether or not the requested software title configuration is on the dashboard\n\n> 📋 **Required privilege:** Read Patch Management Software Titles","parameters":[{"name":"id","in":"path","description":"software title configuration id","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Whether the software title configuration is on the Dashboard.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SoftwareTitleConfigurationOnDashboard"}}}},"404":{"description":"The requested software title configuration does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2026-07-14","x-required-privileges":["Read Patch Management Software Titles"]},"post":{"tags":["patch-software-title-configurations"],"summary":"Add a software title configuration to the dashboard\n","description":"Adds asoftware title configuration to the dashboard.\n\n> 📋 **Required privilege:** Read Patch Management Software Titles","parameters":[{"name":"id","in":"path","description":"software title configuration id","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"OK"}},"deprecated":true,"x-deprecation-date":"2026-07-14","x-action":true,"x-required-privileges":["Read Patch Management Software Titles"]},"delete":{"tags":["patch-software-title-configurations"],"summary":"Remove a software title configuration from the dashboard\n","description":"Removes a software title configuration from the dashboard.\n\n> 📋 **Required privilege:** Read Patch Management Software Titles","parameters":[{"name":"id","in":"path","description":"software title configuration id","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"OK"}},"deprecated":true,"x-deprecation-date":"2026-07-14","x-required-privileges":["Read Patch Management Software Titles"]}},"/v2/patch-software-title-configurations/{id}/definitions":{"get":{"tags":["patch-software-title-configurations"],"summary":"Retrieve Patch Software Title Definitions with the supplied id","description":"Retrieves patch software title definitions with the supplied id\n\n> 📋 **Required privilege:** Read Patch Management Software Titles","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"id","in":"path","description":"Patch Software Title identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is absoluteOrderId:asc. Multiple sort criteria are supported and must be separated with a comma.","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["absoluteOrderId:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter Patch Software Title Definition collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: id, version, minimumOperatingSystem, releaseDate, reboot, standalone and absoluteOrderId. This param can be combined with paging and sorting.","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchSoftwareTitleDefinitions"}}}},"404":{"description":"Patch Software Title Definitions with that id do not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2026-07-14","x-required-privileges":["Read Patch Management Software Titles"]}},"/v2/patch-software-title-configurations/{id}/dependencies":{"get":{"tags":["patch-software-title-configurations"],"summary":"Retrieve list of Patch Software Title Configuration Dependencies","description":"Retrieve list of Patch Software Title Configuration Dependencies\n\n> 📋 **Required privilege:** Read Patch Management Software Titles","parameters":[{"name":"id","in":"path","description":"Patch Software Title Configuration Id","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchSoftwareTitleConfigurationDependencies"}}}}},"deprecated":true,"x-deprecation-date":"2026-07-14","x-required-privileges":["Read Patch Management Software Titles"]}},"/v2/patch-software-title-configurations/{id}/export-report":{"get":{"tags":["patch-software-title-configurations"],"summary":"Export Patch Reporting Data","description":"Export Patch Reporting Data\n\n> 📋 **Required privilege:** Read Patch Management Software Titles","parameters":[{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter Patch Report collection on version equality only. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: version. Comparators allowed in the query: ==, != This param can be combined with paging and sorting.","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}},{"name":"accept","in":"header","description":"File","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Patch Software Title Configurations identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"columns-to-export","in":"query","description":"List of column names to export","required":true,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["computerName","deviceId","username","operatingSystemVersion","lastContactTime","buildingName","departmentName","siteName","version"]}}],"responses":{"200":{"description":"Export successful","content":{"text/csv":{"schema":{"format":"binary"}},"text/tab":{"schema":{"format":"binary"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Patch Software Title Extension Attributes with that id do not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"415":{"description":"Incorrect media type specified.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"Export currently unavailable, all export-related resources are in use. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2026-07-14","x-required-privileges":["Read Patch Management Software Titles"],"x-action":true}},"/v2/patch-software-title-configurations/{id}/extension-attributes":{"get":{"tags":["patch-software-title-configurations"],"summary":"Retrieve Software Title Extension Attributes with the supplied id","description":"Retrieves software title extension attributes with the supplied id\n\n> 📋 **Required privilege:** Read Patch Management Software Titles","parameters":[{"name":"id","in":"path","description":"Patch Software Title identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PatchSoftwareTitleExtensionAttributes"}}}}},"404":{"description":"Patch Software Title Extension Attributes with that id do not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2026-07-14","x-required-privileges":["Read Patch Management Software Titles"]}},"/v2/patch-software-title-configurations/{id}/history":{"get":{"tags":["patch-software-title-configurations"],"summary":"Get specified Patch Software Title Configuration history object\n","description":"Gets specified Patch Software Title Configuration history object\n\n\n> 📋 **Required privilege:** Read Patch Management Software Titles","parameters":[{"name":"id","in":"path","description":"Patch Software Title Configuration Id","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma. ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["date:desc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Details of Patch Software Title Configuration history were found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistorySearchResults"}}}},"404":{"description":"Specified Patch Software Title Configuration object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2026-07-14","x-required-privileges":["Read Patch Management Software Titles"]},"post":{"tags":["patch-software-title-configurations"],"summary":"Add Patch Software Title Configuration history object notes\n","description":"Adds Patch Software Title Configuration history object notes\n\n> 📋 **Required privilege:** Update Patch Management Software Titles","parameters":[{"name":"id","in":"path","description":"Patch Software Title Configuration Id","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"History notes to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistoryNote"}}},"required":true},"responses":{"201":{"description":"Notes of Patch Software Title Configuration history were added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Patch Software Title Configuration with that Id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"Patch Software Title Configuration history can not be saved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2026-07-14","x-required-privileges":["Update Patch Management Software Titles"]}},"/v2/patch-software-title-configurations/{id}/patch-report":{"get":{"tags":["patch-software-title-configurations"],"summary":"Retrieve Patch Software Title Configuration Patch Report","description":"Retrieve Patch Software Title Configuration Patch Report\n\n> 📋 **Required privilege:** Read Patch Management Software Titles","parameters":[{"name":"id","in":"path","description":"Patch Software Title Configurations identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is computerName:asc. Multiple sort criteria are supported and must be separated with a comma. Supported fields: computerName, deviceId, username, operatingSystemVersion, lastContactTime, buildingName, departmentName, siteName, version","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["computerName:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter Patch Report collection on version equality only. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: version. Comparators allowed in the query: ==, != This param can be combined with paging and sorting.","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchSoftwareTitleReportSearchResult"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Patch Software Title Configuration with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2026-07-14","x-required-privileges":["Read Patch Management Software Titles"]}},"/v2/patch-software-title-configurations/{id}/patch-summary":{"get":{"tags":["patch-software-title-configurations"],"summary":"Return Active Patch Summary","description":"Returns active patch summary.\n\n> 📋 **Required privilege:** Read Patch Management Software Titles","parameters":[{"name":"id","in":"path","description":"Patch id","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Active Patch Summary","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchSummary"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Patch id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2026-07-14","x-required-privileges":["Read Patch Management Software Titles"]}},"/v2/patch-software-title-configurations/{id}/patch-summary/versions":{"get":{"tags":["patch-software-title-configurations"],"summary":"Returns patch versions","description":"Returns patch versions\n\n> 📋 **Required privilege:** Read Patch Management Software Titles","parameters":[{"name":"id","in":"path","description":"Patch id","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Patch versions","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PatchSummaryVersion"}}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Patch id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"deprecated":true,"x-deprecation-date":"2026-07-14","x-required-privileges":["Read Patch Management Software Titles"]}},"/v3/patch-software-title-configurations":{"get":{"tags":["patch-software-title-configurations"],"summary":"Retrieve Patch Software Title Configurations","description":"Retrieves patch software title configurations\n\n> 📋 **Required privilege:** Read Patch Management Software Titles","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PatchSoftwareTitleConfiguration"}}}}}},"x-required-privileges":["Read Patch Management Software Titles"]},"post":{"tags":["patch-software-title-configurations"],"summary":"Create Patch Software Title Configurations","description":"Creates Patch Software Title Configurations using sToken\n\n> 📋 **Required privilege:** Create Patch Management Software Titles","requestBody":{"description":"Software title configurations to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchSoftwareTitleConfigurationBase"}}},"required":true},"responses":{"201":{"description":"Patch Software Title Configurations were created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Create Patch Management Software Titles"]}},"/v3/patch-software-title-configurations/{id}":{"get":{"tags":["patch-software-title-configurations"],"summary":"Retrieve Patch Software Title Configurations with the supplied id","description":"Retrieves Patch Software Title Configurations with the supplied id\n\n> 📋 **Required privilege:** Read Patch Management Software Titles","parameters":[{"name":"id","in":"path","description":"Patch Software Title Configurations identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchSoftwareTitleConfiguration"}}}},"404":{"description":"Patch Software Title Configurations with that id do not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Patch Management Software Titles"]},"delete":{"tags":["patch-software-title-configurations"],"summary":"Delete Patch Software Title Configurations with the supplied id","description":"Deletes Patch Software Title Configurations with the supplied id\n\n> 📋 **Required privilege:** Delete Patch Management Software Titles","parameters":[{"name":"id","in":"path","description":"Patch Software Title Configurations identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Success"},"404":{"description":"Specified Patch Software Title Configurations object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Delete Patch Management Software Titles"]},"patch":{"tags":["patch-software-title-configurations"],"summary":"Update Patch Software Title Configurations","description":"Updates Patch Software Title Configurations\n\n> 📋 **Required privilege:** Update Patch Management Software Titles","parameters":[{"name":"id","in":"path","description":"Patch Software Title Configurations identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Patch Software Title Configurations to update","content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/PatchSoftwareTitleConfigurationPatch"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchSoftwareTitleConfiguration"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Software Title Configurations with that id do not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"There was an error applying the patch","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Patch Management Software Titles"]}},"/v3/patch-software-title-configurations/{id}/dashboard":{"get":{"tags":["patch-software-title-configurations"],"summary":"Return whether or not the requested software title configuration is on the dashboard\n","description":"Returns whether or not the requested software title configuration is on the dashboard\n\n> 📋 **Required privilege:** Read Patch Management Software Titles","parameters":[{"name":"id","in":"path","description":"software title configuration id","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Whether the software title configuration is on the Dashboard.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SoftwareTitleConfigurationOnDashboard"}}}},"404":{"description":"The requested software title configuration does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Patch Management Software Titles"]},"post":{"tags":["patch-software-title-configurations"],"summary":"Add a software title configuration to the dashboard\n","description":"Adds a software title configuration to the dashboard.\n\n> 📋 **Required privilege:** Read Patch Management Software Titles","parameters":[{"name":"id","in":"path","description":"software title configuration id","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"OK"}},"x-action":true,"x-required-privileges":["Read Patch Management Software Titles"]},"delete":{"tags":["patch-software-title-configurations"],"summary":"Remove a software title configuration from the dashboard\n","description":"Removes a software title configuration from the dashboard.\n\n> 📋 **Required privilege:** Read Patch Management Software Titles","parameters":[{"name":"id","in":"path","description":"software title configuration id","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"OK"}},"x-required-privileges":["Read Patch Management Software Titles"]}},"/v3/patch-software-title-configurations/{id}/definitions":{"get":{"tags":["patch-software-title-configurations"],"summary":"Retrieve Patch Software Title Definitions with the supplied id","description":"Retrieves patch software title definitions with the supplied id\n\n> 📋 **Required privilege:** Read Patch Management Software Titles","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"id","in":"path","description":"Patch Software Title identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is absoluteOrderId:asc. Multiple sort criteria are supported and must be separated with a comma.","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["absoluteOrderId:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter Patch Software Title Definition collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: id, version, minimumOperatingSystem, releaseDate, reboot, standalone and absoluteOrderId. This param can be combined with paging and sorting.","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchSoftwareTitleDefinitions"}}}},"404":{"description":"Patch Software Title Definitions with that id do not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Patch Management Software Titles"]}},"/v3/patch-software-title-configurations/{id}/dependencies":{"get":{"tags":["patch-software-title-configurations"],"summary":"Retrieve list of Patch Software Title Configuration Dependencies","description":"Retrieve list of Patch Software Title Configuration Dependencies\n\n> 📋 **Required privilege:** Read Patch Management Software Titles","parameters":[{"name":"id","in":"path","description":"Patch Software Title Configuration Id","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchSoftwareTitleConfigurationDependencies"}}}}},"x-required-privileges":["Read Patch Management Software Titles"]}},"/v3/patch-software-title-configurations/{id}/export-report":{"get":{"tags":["patch-software-title-configurations"],"summary":"Export Patch Reporting Data","description":"Export Patch Reporting Data\n\n> 📋 **Required privilege:** Read Patch Management Software Titles","parameters":[{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter Patch Report collection on version equality only. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: version. Comparators allowed in the query: ==, != This param can be combined with paging and sorting.","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}},{"name":"accept","in":"header","description":"File","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Patch Software Title Configurations identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"columns-to-export","in":"query","description":"List of column names to export","required":true,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["computerName","deviceId","username","operatingSystemVersion","lastCheckIn","buildingName","departmentName","siteName","version"]}}],"responses":{"200":{"description":"Export successful","content":{"text/csv":{"schema":{"format":"binary"}},"text/tab":{"schema":{"format":"binary"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Patch Software Title Extension Attributes with that id do not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"415":{"description":"Incorrect media type specified.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"Export currently unavailable, all export-related resources are in use. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Patch Management Software Titles"],"x-action":true}},"/v3/patch-software-title-configurations/{id}/extension-attributes":{"get":{"tags":["patch-software-title-configurations"],"summary":"Retrieve Software Title Extension Attributes with the supplied id","description":"Retrieves software title extension attributes with the supplied id\n\n> 📋 **Required privilege:** Read Patch Management Software Titles","parameters":[{"name":"id","in":"path","description":"Patch Software Title identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PatchSoftwareTitleExtensionAttributes"}}}}},"404":{"description":"Patch Software Title Extension Attributes with that id do not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Patch Management Software Titles"]}},"/v3/patch-software-title-configurations/{id}/history":{"get":{"tags":["patch-software-title-configurations"],"summary":"Get specified Patch Software Title Configuration history object\n","description":"Gets specified Patch Software Title Configuration history object\n\n\n> 📋 **Required privilege:** Read Patch Management Software Titles","parameters":[{"name":"id","in":"path","description":"Patch Software Title Configuration Id","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma. ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["date:desc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Details of Patch Software Title Configuration history were found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistorySearchResults"}}}},"404":{"description":"Specified Patch Software Title Configuration object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Patch Management Software Titles"]},"post":{"tags":["patch-software-title-configurations"],"summary":"Add Patch Software Title Configuration history object notes\n","description":"Adds Patch Software Title Configuration history object notes\n\n> 📋 **Required privilege:** Update Patch Management Software Titles","parameters":[{"name":"id","in":"path","description":"Patch Software Title Configuration Id","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"History notes to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistoryNote"}}},"required":true},"responses":{"201":{"description":"Notes of Patch Software Title Configuration history were added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Patch Software Title Configuration with that Id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"Patch Software Title Configuration history can not be saved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Patch Management Software Titles"]}},"/v3/patch-software-title-configurations/{id}/patch-report":{"get":{"tags":["patch-software-title-configurations"],"summary":"Retrieve Patch Software Title Configuration Patch Report","description":"Retrieve Patch Software Title Configuration Patch Report\n\n> 📋 **Required privilege:** Read Patch Management Software Titles","parameters":[{"name":"id","in":"path","description":"Patch Software Title Configurations identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is computerName:asc. Multiple sort criteria are supported and must be separated with a comma. Supported fields: computerName, deviceId, username, operatingSystemVersion, lastCheckIn, buildingName, departmentName, siteName, version","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["computerName:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter Patch Report collection on version equality only. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: version. Comparators allowed in the query: ==, != This param can be combined with paging and sorting.","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchSoftwareTitleReportV3SearchResult"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Patch Software Title Configuration with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Patch Management Software Titles"]}},"/v3/patch-software-title-configurations/{id}/patch-summary":{"get":{"tags":["patch-software-title-configurations"],"summary":"Return Active Patch Summary","description":"Returns active patch summary.\n\n> 📋 **Required privilege:** Read Patch Management Software Titles","parameters":[{"name":"id","in":"path","description":"Patch id","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Active Patch Summary","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchSummary"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Patch id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Patch Management Software Titles"]}},"/v3/patch-software-title-configurations/{id}/patch-summary/versions":{"get":{"tags":["patch-software-title-configurations"],"summary":"Returns patch versions","description":"Returns patch versions\n\n> 📋 **Required privilege:** Read Patch Management Software Titles","parameters":[{"name":"id","in":"path","description":"Patch id","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Patch versions","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PatchSummaryVersion"}}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Patch id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Patch Management Software Titles"]}},"/settings/obj/policyProperties":{"get":{"tags":["policies-preview"],"summary":"Get Policy Properties object\n","description":"Gets `Policy Properties` object.\n\n\n> 📋 **Required privilege:** Read Policies","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyProperties"}}}}},"deprecated":true,"x-required-privileges":["Read Policies"],"x-deprecation-date":"2021-11-07"},"put":{"tags":["policies-preview"],"summary":"Update Policy Properties object\n","description":"Update Policy Properties object\n\n\n> 📋 **Required privilege:** Update Policies","requestBody":{"description":"Policy Properties object to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyProperties"}}},"required":true},"responses":{"201":{"description":"Policy Properties was updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyProperties"}}}}},"deprecated":true,"x-required-privileges":["Update Policies"],"x-deprecation-date":"2021-11-07"}},"/v1/policy-properties":{"get":{"tags":["policies-preview"],"summary":"Get Policy Properties object\n","description":"Gets `Policy Properties` object.\n\n\n> 📋 **Required privilege:** Read Policies","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyPropertiesV1"}}}}},"x-required-privileges":["Read Policies"]},"put":{"tags":["policies-preview"],"summary":"Update Policy Properties object\n","description":"Update Policy Properties object\n\n\n> 📋 **Required privilege:** Update Policies","requestBody":{"description":"Policy Properties object to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyPropertiesV1"}}},"required":true},"responses":{"200":{"description":"Policy Properties was updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyPropertiesV1"}}}}},"x-required-privileges":["Update Policies"]}},"/v1/reenrollment":{"get":{"tags":["re-enrollment-preview"],"summary":"Get Re-enrollment object\n","description":"Gets Re-enrollment object\n\n\n> 📋 **Required privilege:** Read Re-enrollment","responses":{"200":{"description":"Details of Re-enrollment object were found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Reenrollment"}}}},"404":{"description":"Re-enrollment object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Re-enrollment"]},"put":{"tags":["re-enrollment-preview"],"summary":"Update the Re-enrollment object\n","description":"Update the Re-enrollment object\n\n\n> 📋 **Required privilege:** Update Re-enrollment","requestBody":{"description":"Re-enrollment object to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Reenrollment"}}},"required":true},"responses":{"201":{"description":"Re-enrollment record was updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Reenrollment"}}}}},"x-required-privileges":["Update Re-enrollment"]}},"/v1/reenrollment/history":{"get":{"tags":["re-enrollment-preview"],"summary":"Get Re-enrollment history object\n","description":"Gets Re-enrollment history object\n\n\n> 📋 **Required privilege:** Read Re-enrollment","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/size"},{"$ref":"#/components/parameters/pagesize"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc ","required":false,"style":"form","explode":true,"schema":{"type":"string","default":"date:desc"}}],"responses":{"200":{"description":"Details of re-enrollment history were found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistorySearchResults"}}}}},"x-required-privileges":["Read Re-enrollment"]},"post":{"tags":["re-enrollment-preview"],"summary":"Add specified Re-enrollment history object notes\n","description":"Adds specified Re-enrollment history object notes\n\n\n> 📋 **Required privilege:** Update Re-enrollment","requestBody":{"description":"history notes to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistoryNote"}}},"required":true},"responses":{"201":{"description":"Notes of re-enrollment history were added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistory"}}}},"503":{"description":"Re-enrollment history can not be saved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Re-enrollment"]}},"/v1/reenrollment/history/export":{"post":{"tags":["re-enrollment-preview"],"summary":"Export reenrollment history collection\n","description":"Export reenrollment history collection\n\n\n> 📋 **Required privilege:** Read Re-enrollment","parameters":[{"$ref":"#/components/parameters/export-fields"},{"$ref":"#/components/parameters/export-labels"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is id:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=id:desc,name:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: id, name. This param can be combined with paging and sorting. Example: name==\"*script*\"","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"requestBody":{"description":"Optional. Override query parameters since they can make URI exceed 2,000 character limit.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportParameters"}}},"required":false},"responses":{"200":{"description":"Export successful","content":{"text/csv,application/json":{"schema":{"format":"binary","example":"Username,DATE,NOTES,Details\nadmin, 2022-02-04T11:56:26.343Z, Edited ,Re-enrollment Restricted true\n"}}}},"400":{"description":"Export fields specified incorrectly - non-existing column or duplicate in the list.\nSupported columns: id,name,categoryName,categoryId,priority.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"Export currently unavailable, all export-related resources are in use. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Re-enrollment"],"x-action":true}},"/preview/remote-administration-configurations":{"get":{"tags":["remote-administration"],"summary":"Get information about all remote administration configurations.","description":"Remote administration feature creates a secure screen-sharing experience between Jamf Pro administrators and their end-users.\n\n> 📋 **Required privilege:** Read Remote Administration","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"}],"responses":{"200":{"description":"Remote administration configurations returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoteAdministrationSearchResults"}}}},"404":{"description":"Remote Administration feature is not available.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Remote Administration"]}},"/v1/return-to-service":{"get":{"tags":["return-to-service"],"summary":"Get all Return to Service Configurations\n","description":"Gets all return to service configurations.\n\n> 📋 **Required privilege:** View Return To Service Configurations","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnToServiceConfigurationSearchResults"}}}}},"x-required-privileges":["View Return To Service Configurations"]},"post":{"tags":["return-to-service"],"summary":"Create a Return to Service Configuration\n","description":"Create a return to service configuration\n\n> 📋 **Required privilege:** Edit Return To Service Configurations","requestBody":{"description":"Return to Service Configuration to create. ids defined in this body will be ignored","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnToServiceConfigurationRequest"}}},"required":true},"responses":{"201":{"description":"Return to Service Configuration was created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Edit Return To Service Configurations"]}},"/v1/return-to-service/{id}":{"get":{"tags":["return-to-service"],"summary":"Retrieve a Return to Service Configuration with the supplied id\n","description":"Retrieves a Return to Service Configuration with the supplied id\n\n> 📋 **Required privilege:** View Return To Service Configurations","parameters":[{"name":"id","in":"path","description":"Return to Service Configuration identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnToServiceConfiguration"}}}},"404":{"description":"Return to Service Configuration with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["View Return To Service Configurations"]},"put":{"tags":["return-to-service"],"summary":"Update a Return to Service Configuration\n","description":"Updates a Return to Service Configuration\n\n> 📋 **Required privilege:** Edit Return To Service Configurations","parameters":[{"name":"id","in":"path","description":"Return to Service Configuration identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Return to Service Configuration to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnToServiceConfigurationRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnToServiceConfiguration"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Return to Service Configuration with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"The Return to Service Configuration was modified by another process. Read the Return to Service Configuration again for updated changes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Edit Return To Service Configurations"]},"delete":{"tags":["return-to-service"],"summary":"Delete a Return To Service Configuration with the supplied id\n","description":"Deletes a Return To Service Configuration with the supplied id\n\n> 📋 **Required privilege:** Delete Return To Service Configurations","parameters":[{"name":"id","in":"path","description":"Return To Service Configurations identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Success"},"404":{"description":"Return to Service Configuration with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Delete Return To Service Configurations"]}},"/v1/scheduler/jobs":{"get":{"tags":["scheduler"],"summary":"Retrieve all Jamf Pro Scheduler jobs","description":"Retrieves the names of all Jamf Pro Scheduler jobs","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchedulerJobs"}}}}},"x-authentication-required":true}},"/v1/scheduler/jobs/{jobKey}/triggers":{"get":{"tags":["scheduler"],"summary":"Retrieve all triggers for a Jamf Pro Scheduler job","description":"Retrieves all triggers for a Jamf Pro Scheduler job","parameters":[{"name":"jobKey","in":"path","description":"Jamf Pro Scheduler Job Key","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorts results by one or more criteria, following the format property:asc/desc. Default sort is nextFireTime:asc. If using multiple criteria, separate with commas.","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["nextFireTime:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter the Jamf Pro Scheduler triggers collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: triggerKey, previousFireTime, nextFireTime.","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchedulerJob"}}}}},"x-authentication-required":true}},"/v1/scheduler/summary":{"get":{"tags":["scheduler"],"summary":"Retrieve a summary of the Jamf Pro Scheduler","description":"Retrieves a summary of the Jamf Pro Scheduler","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchedulerSummary"}}}}},"x-authentication-required":true}},"/v1/scripts":{"get":{"tags":["scripts"],"summary":"Search for sorted and paged Scripts\n","description":"Search for sorted and paged scripts\n\n> 📋 **Required privilege:** Read Scripts","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is name:asc. Multiple sort criteria are supported and must be separated with a comma. Fields allowed in the query: `id`, `name`, `info`, `notes`, `priority`, `categoryId`, `categoryName`, `parameter4` up to `parameter11`, `osRequirements`, `scriptContents`. Example: sort=date:desc,name:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["name:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter scripts collection. Default search is empty query - returning all results for the requested page. Fields allowed in the query: `id`, `name`, `info`, `notes`, `priority`, `categoryId`, `categoryName`, `parameter4` up to `parameter11`, `osRequirements`, `scriptContents`. This param can be combined with paging and sorting. Example: filter=categoryName==\"Category\" and name==\"*script name*\"","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Found scripts matching search params.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScriptsSearchResults"}}}}},"x-required-privileges":["Read Scripts"]},"post":{"tags":["scripts"],"summary":"Create a Script\n","description":"Creates a script\n\n> 📋 **Required privilege:** Create Scripts","requestBody":{"description":"new script to create. ids defined in this body will be ignored","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Script"}}},"required":true},"responses":{"201":{"description":"Script created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}}},"x-required-privileges":["Create Scripts"]}},"/v1/scripts/{id}":{"get":{"tags":["scripts"],"summary":"Retrieve a full script object\n","description":"Retrieves a full script object\n\n> 📋 **Required privilege:** Read Scripts","parameters":[{"name":"id","in":"path","description":"Script object identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Script"}}}},"404":{"description":"Script with that ID does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Scripts"]},"put":{"tags":["scripts"],"summary":"Replace the script at the id with the supplied information\n","description":"Replaces the script at the id with the supplied information\n\n> 📋 **Required privilege:** Update Scripts","parameters":[{"name":"id","in":"path","description":"Script object identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"new script to upload to existing id. ids defined in this body will be ignored","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Script"}}},"required":true},"responses":{"200":{"description":"Script at id was updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Script"}}}},"404":{"description":"Script with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Scripts"]},"delete":{"tags":["scripts"],"summary":"Delete a Script at the specified id\n","description":"Deletes a script at the specified id\n\n> 📋 **Required privilege:** Delete Scripts","parameters":[{"name":"id","in":"path","description":"Script object identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful response"}},"x-required-privileges":["Delete Scripts"]}},"/v1/scripts/{id}/download":{"get":{"tags":["scripts"],"summary":"Download a text file of the Script contents\n","description":"Download a text file of the script contents\n\n> 📋 **Required privilege:** Read Scripts","parameters":[{"name":"id","in":"path","description":"id of the script to be downloaded","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The script of the specified id","content":{"text/plain":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Scripts"]}},"/v1/scripts/{id}/history":{"get":{"tags":["scripts"],"summary":"Get specified Script history object\n","description":"Gets specified Script history object\n\n\n> 📋 **Required privilege:** Read Scripts","parameters":[{"name":"id","in":"path","description":"id of script history record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["date:desc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistorySearchResults"}}}},"404":{"description":"Specified script does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Scripts"]},"post":{"tags":["scripts"],"summary":"Add specified Script history object notes\n","description":"Adds specified Script history object notes\n\n\n> 📋 **Required privilege:** Update Scripts","parameters":[{"name":"id","in":"path","description":"instance id of script history record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"history notes to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistoryNote"}}},"required":true},"responses":{"201":{"description":"Notes of script history were added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistory"}}}},"404":{"description":"Specified script does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"Script history can not be saved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Scripts"]}},"/v1/self-service/settings":{"get":{"tags":["self-service"],"summary":"Get an object representation of Self Service settings\n","description":"gets an object representation of Self Service settings\n\n\n> 📋 **Required privilege:** Read Self Service","responses":{"200":{"description":"successful GET\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SelfServiceSettings"}}}}},"x-required-privileges":["Read Self Service"]},"put":{"tags":["self-service"],"summary":"Put an object representation of Self Service settings\n","description":"puts an object representation of Self Service settings\n\n\n> 📋 **Required privilege:** Update Self Service","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"]}},"/v1/self-service/settings/history":{"get":{"tags":["self-service"],"summary":"Get a page of Self Service settings history\n","description":"Get a page of Self Service settings history\n\n\n> 📋 **Required privilege:** Read Self Service","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"$ref":"#/components/parameters/sort"},{"$ref":"#/components/parameters/filter"}],"responses":{"200":{"description":"Details of Self Service settings history were found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistorySearchResults"}}}}},"x-required-privileges":["Read Self Service"]},"post":{"tags":["self-service"],"summary":"Add Self Service settings history notes\n","description":"Add Self Service settings history notes\n\n\n> 📋 **Required privilege:** Update Self Service","requestBody":{"description":"history notes to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistoryNote"}}},"required":true},"responses":{"201":{"description":"Notes to Self Service settings history were added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}}},"x-required-privileges":["Update Self Service"]}},"/v1/self-service/branding/ios":{"get":{"tags":["self-service-branding-ios"],"summary":"Search for sorted and paged iOS branding configurations\n","description":"Search for sorted and paged iOS branding configurations\n\n> 📋 **Required privilege:** Read Self Service Branding Configuration","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=id:desc,brandingName:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IosBrandingSearchResults"}}}}},"x-required-privileges":["Read Self Service Branding Configuration"]},"post":{"tags":["self-service-branding-ios"],"summary":"Create a Self Service iOS branding configuration with the supplied\n","description":"Create a Self Service iOS branding configuration with the supplied details\n\n> 📋 **Required privilege:** Create Self Service Branding Configuration","requestBody":{"description":"The iOS branding configuration to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IosBrandingConfiguration"}}},"required":false},"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}}},"x-required-privileges":["Create Self Service Branding Configuration"]}},"/v1/self-service/branding/ios/{id}":{"get":{"tags":["self-service-branding-ios"],"summary":"Read a single Self Service iOS branding configuration indicated by the provided id\n","description":"Read a single Self Service iOS branding configuration indicated by the provided id.\n\n> 📋 **Required privilege:** Read Self Service Branding Configuration","parameters":[{"name":"id","in":"path","description":"id of iOS branding configuration","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IosBrandingConfiguration"}}}}},"x-required-privileges":["Read Self Service Branding Configuration"]},"put":{"tags":["self-service-branding-ios"],"summary":"Update a Self Service iOS branding configuration with the supplied details\n","description":"Update a Self Service iOS branding configuration with the supplied details\n\n> 📋 **Required privilege:** Update Self Service Branding Configuration","parameters":[{"name":"id","in":"path","description":"id of iOS branding configuration","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"The iOS branding configuration values to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IosBrandingConfiguration"}}},"required":false},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IosBrandingConfiguration"}}}},"404":{"description":"Invalid id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Self Service Branding Configuration"]},"delete":{"tags":["self-service-branding-ios"],"summary":"Delete the Self Service iOS branding configuration indicated by the provided id\n","description":"Delete the Self Service iOS branding configuration indicated by the provided id.\n\n> 📋 **Required privilege:** Delete Self Service Branding Configuration","parameters":[{"name":"id","in":"path","description":"id of iOS branding configuration","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful response"},"404":{"description":"Invalid id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Delete Self Service Branding Configuration"]}},"/v1/self-service/branding/macos":{"get":{"tags":["self-service-branding-macos"],"summary":"Search for sorted and paged macOS branding configurations\n","description":"Search for sorted and paged macOS branding configurations\n\n> 📋 **Required privileges:**\n> - Read Self Service Branding Configuration\n> - Read Self Service","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=id:desc,brandingName:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MacOsBrandingSearchResults"}}}}},"x-required-privileges":["Read Self Service Branding Configuration","Read Self Service"]},"post":{"tags":["self-service-branding-macos"],"summary":"Create a Self Service macOS branding configuration with the supplied\n","description":"Create a Self Service macOS branding configuration with the supplied details\n\n> 📋 **Required privilege:** Create Self Service Branding Configuration","requestBody":{"description":"The macOS branding configuration to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MacOsBrandingConfiguration"}}},"required":false},"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}}},"x-required-privileges":["Create Self Service Branding Configuration"]}},"/v1/self-service/branding/macos/{id}":{"get":{"tags":["self-service-branding-macos"],"summary":"Read a single Self Service macOS branding configuration indicated by the provided id\n","description":"Read a single Self Service macOS branding configuration indicated by the provided id.\n\n> 📋 **Required privilege:** Read Self Service Branding Configuration","parameters":[{"name":"id","in":"path","description":"id of macOS branding configuration","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MacOsBrandingConfiguration"}}}}},"x-required-privileges":["Read Self Service Branding Configuration"]},"put":{"tags":["self-service-branding-macos"],"summary":"Update a Self Service macOS branding configuration with the supplied details\n","description":"Update a Self Service macOS branding configuration with the supplied details\n\n> 📋 **Required privilege:** Update Self Service Branding Configuration","parameters":[{"name":"id","in":"path","description":"id of macOS branding configuration","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"The macOS branding configuration values to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MacOsBrandingConfiguration"}}},"required":false},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MacOsBrandingConfiguration"}}}},"404":{"description":"Invalid id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Self Service Branding Configuration"]},"delete":{"tags":["self-service-branding-macos"],"summary":"Delete the Self Service macOS branding configuration indicated by the provided id\n","description":"Delete the Self Service macOS branding configuration indicated by the provided id.\n\n> 📋 **Required privilege:** Delete Self Service Branding Configuration","parameters":[{"name":"id","in":"path","description":"id of macOS branding configuration","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful response"},"404":{"description":"Invalid id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Delete Self Service Branding Configuration"]}},"/self-service/branding/images":{"post":{"tags":["self-service-branding-preview"],"summary":"Upload an image\n","description":"Uploads an image\n\n> 📋 **Required privilege:** Update Self Service Branding Configuration","requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"The file to upload","format":"binary"}}}}},"required":true},"responses":{"201":{"description":"Image successfully uploaded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandingImageUrl"}}}}},"x-required-privileges":["Update Self Service Branding Configuration"]}},"/v1/self-service-plus/feature-toggle/enabled":{"get":{"tags":["self-service-plus"],"summary":"Determines if Self Service Plus feature toggle is enabled.","description":"This endpoint is used to determine if the Self Service Plus feature toggle is enabled.\n","operationId":"getSelfServicePlusFeatureToggleEnabled","responses":{"204":{"description":"Feature toggle is enabled"},"404":{"description":"Feature toggle is disabled"}},"x-authentication-required":true}},"/v1/self-service-plus/settings":{"get":{"tags":["self-service-plus"],"summary":"Get Self Service Plus settings.","description":"Get Self Service Plus settings.\n\n> 📋 **Required privilege:** Read Self Service","operationId":"getSelfServicePlusSettings","responses":{"200":{"description":"Self Service Plus settings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SelfServicePlusSettings"}}}}},"x-required-privileges":["Read Self Service"]},"put":{"tags":["self-service-plus"],"summary":"Save Self Service Plus settings.","description":"Save Self Service Plus settings.\n\n> 📋 **Required privilege:** Update Self Service","operationId":"putSelfServicePlusSettings","requestBody":{"description":"Self Service Plus settings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SelfServicePlusSettings"}}},"required":true},"responses":{"204":{"description":"Successful PUT"}},"x-required-privileges":["Update Self Service"]}},"/v1/service-discovery-enrollment/well-known-settings":{"get":{"tags":["service-discovery-enrollment"],"summary":"Get service discovery well-known settings for all organizations","description":"Returns current settings for all AxM organizations.\n\n\n> 📋 **Required privilege:** Read User-Initiated Enrollment","responses":{"200":{"description":"Well-known settings retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WellKnownSettingsResponse"}}}},"401":{"description":"Authentication required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read User-Initiated Enrollment"]},"put":{"tags":["service-discovery-enrollment"],"summary":"Update service discovery well-known settings","description":"Accepts JSON payload to update enrollment types for AxM organizations.\nRequires \"Update User-Initiated Enrollment\" privilege.\n\n\n> 📋 **Required privilege:** Update User-Initiated Enrollment","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WellKnownSettingsRequest"}}},"required":true},"responses":{"204":{"description":"Well-known settings updated successfully"},"400":{"description":"Bad request. Invalid enrollment type or malformed request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Authentication required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update User-Initiated Enrollment"]}},"/v1/sites":{"get":{"tags":["sites"],"summary":"Find all sites\n","description":"Find all sites\n\n\n> 📋 **Required privilege:** Read Sites","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/V1Site"}}}}}},"security":[{"Bearer":[]}],"x-required-privileges":["Read Sites"]}},"/v1/sites/{id}/objects":{"get":{"tags":["sites"],"summary":"Find and filter site objects for a site ID\n","description":"Find site objects for Site ID, with the ability to filter out different object types and object IDs for the site ID\n\n\n> 📋 **Required privilege:** Read Sites","parameters":[{"name":"id","in":"path","description":"Site ID to get objects for\n","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"1"}},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: `property:asc/desc`. Default sort\nis `objectType:asc`. Multiple sort criteria are supported and must be separated\nwith a comma.\n\nExample: `sort=objectId:asc,objectType:desc`.\n","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["objectType:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing filter of site object information.\nDefault filter returns all objects for the site ID.\n\nFields allowed in the query: `objectType`, `objectId`\n\nExample: `filter=objectType==\"User\"`\n\nList of `objectType` options (case-insensitive) [\"Computer\", \"Peripheral\", \"Licensed Software\", \"Licensed Software Template\", \"Policy\", \"macOS Configuration Profile\", \"Restricted Software\", \"Managed Preference Profile\", \"Computer Group\", \"Mobile Device\", \"Apple TV\", \"Android Device\", \"User Group\", \"iOS Configuration Profile\", \"Mobile Device App\", \"E-book\", \"Mobile Device Group\", \"Classroom\", \"Advanced Computer Search\", \"Advanced Mobile Search\", \"Advanced User Search\", \"Advanced User Content Search\", \"Computer Invitation\", \"Mobile Device Invitation\", \"Mobile Device Enrollment Profile\", \"Device Enrollment Program Instance\", \"Mobile Device Prestage\", \"Computer DEP Prestage\", \"Enrollment Customization\", \"VPP Location\", \"VPP Subscription\", \"VPP Invitation\", \"VPP Assignment\", \"User\", \"Network Integration\", \"Mac App\", \"App Installer\", \"Self Service Plugin\", \"Software Title\", \"Patch Software Title Summary\", \"Patch Policy\", \"Patch Software Title Configuration\", \"Change Password\", \"Mobile Device Inventory\", \"Computer Inventory\", \"Change Management\", \"Licensed Software License\"]\n","required":false,"style":"form","explode":true,"schema":{"type":"string","default":"objectType==\"User\""}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SiteObject"}}}}}},"security":[{"Bearer":[]}],"x-required-privileges":["Read Sites"]}},"/v1/slasa":{"get":{"tags":["slasa"],"summary":"Get the status of SLASA","description":"Get if SLASA has been accepted or not","responses":{"200":{"description":"Whether SLASA has been accepted or not","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SlasaAcceptance"}}}}},"x-authentication-required":false},"post":{"tags":["slasa"],"summary":"Accept the SLASA","description":"Accept the SLASA for Jamf Pro.\n\n> 📋 **Required privileges:**\n> - Update License Information\n> - View JSS Information","responses":{"204":{"description":"SLASA has been accepted"}},"x-required-privileges":["Update License Information","View JSS Information"],"x-action":true}},"/v1/computers/{id}/recalculate-smart-groups":{"post":{"tags":["smart-computer-groups-preview"],"summary":"Recalculate a smart group for the given id\n","description":"Recalculates a smart group for the given id and then\nreturns the count of smart groups the computer falls into\n\n\n> 📋 **Required privilege:** Update Smart Computer Groups","parameters":[{"name":"id","in":"path","description":"id of computer","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecalculationResults"}}}},"400":{"description":"smart group not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-action":true,"x-required-privileges":["Update Smart Computer Groups"]}},"/v1/smart-computer-groups/{id}/recalculate":{"post":{"tags":["smart-computer-groups-preview"],"summary":"Recalculate the smart group for the given id\n","description":"Recalculates the smart group for the given id and then\nreturns the ids for the computers in the smart group\n\n\n> 📋 **Required privilege:** Update Smart Computer Groups","parameters":[{"name":"id","in":"path","description":"instance id of smart group","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecalculationResults"}}}},"400":{"description":"smart group not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-action":true,"x-required-privileges":["Update Smart Computer Groups"]}},"/v1/mobile-devices/{id}/recalculate-smart-groups":{"post":{"tags":["smart-mobile-device-groups-preview"],"summary":"Recalculate all smart groups for the given device id and then return count of smart groups that device fall into\n","description":"Recalculates all smart groups for the given device id and then\nreturns the count of smart groups the device falls into\n\n\n> 📋 **Required privilege:** Update Smart Mobile Device Groups","parameters":[{"name":"id","in":"path","description":"id of mobile device","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecalculationResults"}}}},"400":{"description":"smart group not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-action":true,"x-required-privileges":["Update Smart Mobile Device Groups"]}},"/v1/smart-mobile-device-groups/{id}/recalculate":{"post":{"tags":["smart-mobile-device-groups-preview"],"summary":"Recalculate a smart group for the given id then return the ids for the devices in the smart group\n","description":"recalculates a smart group for the given id and then\nreturns the ids for the devices in the smart group\n\n\n> 📋 **Required privilege:** Update Smart Mobile Device Groups","parameters":[{"name":"id","in":"path","description":"instance id of smart group","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecalculationResults"}}}},"400":{"description":"smart group not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-action":true,"x-required-privileges":["Update Smart Mobile Device Groups"]}},"/v1/smart-user-groups/{id}/recalculate":{"post":{"tags":["smart-user-groups-preview"],"summary":"Recalculate the smart group for the given id and then return the ids for the users in the smart group\n","description":"Recalculates the smart group for the given id and then\nreturns the ids for the users in the smart group\n\n\n> 📋 **Required privilege:** Update Smart User Groups","parameters":[{"name":"id","in":"path","description":"instance id of smart group","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecalculationResults"}}}},"400":{"description":"smart group not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-action":true,"x-required-privileges":["Update Smart User Groups"]}},"/v1/users/{id}/recalculate-smart-groups":{"post":{"tags":["smart-user-groups-preview"],"summary":"Recalculate a smart group for the given user id and then return the count of smart groups the user falls into\n","description":"Recalculates a smart group for the given user id and then\nreturns the count of smart groups the user falls into\n\n\n> 📋 **Required privilege:** Update Smart User Groups","parameters":[{"name":"id","in":"path","description":"id of user","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecalculationResults"}}}},"400":{"description":"smart group not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-action":true,"x-required-privileges":["Update Smart User Groups"]}},"/v1/smtp-server/history":{"get":{"tags":["smtp-server"],"summary":"Get specified SMTP Server history object\n","description":"Get specified SMTP Server history object\n\n\n> 📋 **Required privilege:** Read SMTP Server","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is name:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,username:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","example":["date:desc"],"items":{"type":"string"},"default":["date:desc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Details of SMTP Server history were found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistorySearchResultsV1"}}}},"404":{"description":"Specified SMTP Server history object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read SMTP Server"]},"post":{"tags":["smtp-server"],"summary":"Add SMTP Server history object notes\n","description":"Adds SMTP Server history object notes\n\n\n> 📋 **Required privilege:** Update SMTP Server","requestBody":{"description":"History notes to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistoryNote"}}},"required":true},"responses":{"201":{"description":"Notes of SMTP Server history were added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"503":{"description":"SMTP Server history cannot be saved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update SMTP Server"]}},"/v1/smtp-server/test":{"post":{"tags":["smtp-server"],"summary":"Test functionality of an SMTP Server","description":"Test functionality of an SMTP Server\n\n> 📋 **Required privilege:** Read SMTP Server","requestBody":{"description":"Recipient email to test SMTP Server","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmtpServerTest"}}},"required":true},"responses":{"202":{"description":"Success"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read SMTP Server"],"x-action":true}},"/v2/smtp-server":{"get":{"tags":["smtp-server"],"summary":"Finds the Jamf Pro SMTP Server information\n","description":"Finds the Jamf Pro SMTP Server information\n\n\n> 📋 **Required privilege:** Read SMTP Server","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmtpServerV2"}}}}},"x-required-privileges":["Read SMTP Server"]},"put":{"tags":["smtp-server"],"summary":"Updates Jamf Pro SMTP Server information\n","description":"Updates Jamf Pro SMTP Server information. If requiresAuthentication is set to true, a username and password must be provided\n\n\n> 📋 **Required privilege:** Update SMTP Server","parameters":[{"name":"oauth-state","in":"query","description":"The OAuth state that was last used to authorize a Google Mail account. This is only required when the authentication type is Google Mail and new accounts are being added.","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"requestBody":{"description":"SMTP Server to update","content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/SmtpServerV2"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmtpServerV2"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"There was an error applying the put","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update SMTP Server"]}},"/v2/smtp-server/allowed-auth-types":{"get":{"tags":["smtp-server"],"summary":"Get allowed SMTP authentication types\n","description":"Returns the list of authentication types currently available on this instance.\nAvailability is controlled at the instance or knobs level and is independent of current SMTP settings.\n\n\n> 📋 **Required privilege:** Read SMTP Server","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmtpAuthenticationTypeList"}}}}},"x-required-privileges":["Read SMTP Server"]}},"/v2/sso/cert":{"get":{"tags":["sso-certificate"],"summary":"Retrieve the certificate currently configured for use with SSO\n","description":"Retrieves the certificate currently configured for use with SSO.\n\n> 📋 **Required privilege:** Read SSO Settings","responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SsoKeystoreResponseWithDetails"}}}}},"x-required-privileges":["Read SSO Settings"]},"put":{"tags":["sso-certificate"],"summary":"Update the certificate used by Jamf Pro to sign SSO requests to the identify provider\n","description":"Update the certificate used by Jamf Pro to sign SSO requests to the identify provider.\n\n> 📋 **Required privilege:** Update SSO Settings","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SsoKeystore"}}},"required":true},"responses":{"200":{"description":"Successfully changed the keystore.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SsoKeystoreResponseWithDetails"}}}},"400":{"description":"One or more parameters were invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update SSO Settings"]},"post":{"tags":["sso-certificate"],"summary":"Jamf Pro will generate a new certificate and use it to sign SSO\n","description":"Jamf Pro will generate a new certificate and use it to sign SSO requests to the identity provider.\n\n> 📋 **Required privilege:** Update SSO Settings","responses":{"200":{"description":"Newly generated will be set and returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SsoKeystoreResponseWithDetails"}}}}},"x-required-privileges":["Update SSO Settings"],"x-action":true},"delete":{"tags":["sso-certificate"],"summary":"Delete the currently configured certificate used by SSO\n","description":"Deletes the currently configured certificate used by SSO.\n\n> 📋 **Required privilege:** Update SSO Settings","responses":{"204":{"description":"Operation successful."}},"x-required-privileges":["Update SSO Settings"]}},"/v2/sso/cert/download":{"get":{"tags":["sso-certificate"],"summary":"Download the certificate currently configured for use with Jamf Pro's SSO configuration\n","description":"Downloads the certificate currently configured for use with Jamf Pro's SSO configuration\n\n> 📋 **Required privilege:** Read SSO Settings","responses":{"200":{"description":"Request successful","content":{"text/plain":{"schema":{"type":"string","format":"binary"}}}}},"x-required-privileges":["Read SSO Settings"]}},"/v2/sso/cert/parse":{"post":{"tags":["sso-certificate"],"summary":"Parse the certificate to get details about certificate type and keys needed to upload certificate file\n","description":"Parse the certificate to get details about certificate type and keys needed to upload certificate file.\n\n> 📋 **Required privilege:** Update SSO Settings","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SsoKeystoreParse"}}},"required":true},"responses":{"200":{"description":"Successfully parsed the certificate.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SsoKeystoreCertParseResponse"}}}},"400":{"description":"One or more parameters were invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-action":true,"x-required-privileges":["Update SSO Settings"]}},"/v1/sso/failover":{"get":{"tags":["sso-failover"],"summary":"Retrieve the current failover settings","description":"Retrieve the current failover settings\n\n> 📋 **Required privilege:** Read SSO Settings","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SsoFailoverData"}}}},"400":{"description":"Failover url not generated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read SSO Settings"]}},"/v1/sso/failover/generate":{"post":{"tags":["sso-failover"],"summary":"Regenerates failover url","description":"Regenerates failover url, by changing failover key to new one, and returns new failover settings\n\n> 📋 **Required privilege:** Update SSO Settings","responses":{"200":{"description":"The generation was successful and generated failover settings are returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SsoFailoverData"}}}}},"x-required-privileges":["Update SSO Settings"],"x-action":true}},"/v1/oauth2/session-tokens":{"get":{"tags":["sso-oauth-session-tokens"],"summary":"Retrieve the access token and user information for the current session.\n","description":"Retrieve the access token and user information for the current session.","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OauthTokens"}}}},"400":{"description":"Unable to retrieve tokens"}},"x-authentication-required":true}},"/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"]},"put":{"tags":["sso-settings"],"summary":"Updates the current Single Sign On configuration settings\n","description":"Updates the current Single Sign On configuration settings\n\n> 📋 **Required privilege:** Update SSO Settings","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SsoSettingsV3"}}}},"responses":{"200":{"description":"The update was successful and the newly updated object is returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SsoSettingsV3"}}}},"400":{"description":"Bad Request. Either required fields are missing or there was a validation exception.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update SSO Settings"]}},"/v3/sso/dependencies":{"get":{"tags":["sso-settings"],"summary":"Retrieve the list of Enrollment Customizations using SSO\n","description":"Retrieves the list of Enrollment Customizations using SSO\n\n> 📋 **Required privilege:** Read SSO Settings","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollmentCustomizationDependencies"}}}}},"x-required-privileges":["Read SSO Settings"]}},"/v3/sso/disable":{"post":{"tags":["sso-settings"],"summary":"Disable SSO\n","description":"Disable SSO\n\n> 📋 **Required privilege:** Update SSO Settings","responses":{"202":{"description":"SSO has been disabled"},"400":{"description":"SSO object don't exist or is already disabled"},"409":{"description":"SSO cannot be disabled due to existing dependencies to it. This might happen if there are enrollment customizations depending on it or if SSO is the only authentication method available for the users."}},"x-required-privileges":["Update SSO Settings"],"x-action":true}},"/v3/sso/history":{"get":{"tags":["sso-settings"],"summary":"Get SSO history object\n","description":"Gets SSO history object\n\n\n> 📋 **Required privilege:** Read SSO Settings","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:desc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Details of SSO history were found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistorySearchResults"}}}}},"x-required-privileges":["Read SSO Settings"]},"post":{"tags":["sso-settings"],"summary":"Add SSO history object notes\n","description":"Adds SSO history object notes\n\n> 📋 **Required privilege:** Update SSO Settings","requestBody":{"description":"history notes to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistoryNote"}}},"required":true},"responses":{"201":{"description":"Notes of SSO history were added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"503":{"description":"SSO object history can not be saved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update SSO Settings"]}},"/v3/sso/metadata/download":{"get":{"tags":["sso-settings"],"summary":"Download the Jamf Pro SAML metadata file\n","description":"Download the Jamf Pro SAML metadata file\n\n> 📋 **Required privilege:** Read SSO Settings","responses":{"200":{"description":"Successful resposne","content":{"text/plain":{"schema":{"type":"string","format":"binary"}}}}},"x-required-privileges":["Read SSO Settings"]}},"/v3/sso/oidc-broker-config":{"get":{"tags":["sso-settings"],"summary":"Get the OIDC broker configuration\n","description":"Returns the tenant's currently selected OIDC broker configuration from the remote\nauthentication service. Secret fields are never included in the response.\n\n\n> 📋 **Required privilege:** Read SSO Settings","responses":{"200":{"description":"The broker configuration for this tenant.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OidcBrokerConfig"}}}},"404":{"description":"Not Found. Either no broker configuration is selected for this tenant, or the configuration could not be read because a prerequisite is unavailable — the OIDC identity provider configuration feature is disabled, or machine-to-machine credentials are not configured.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read SSO Settings"]},"put":{"tags":["sso-settings"],"summary":"Update the OIDC broker configuration\n","description":"Full-replacement update of the tenant's selected broker configuration's contents on the\nremote authentication service. Omit clientSecret/privateKeyJwt to keep the currently\nstored value; supply either to rotate it — except when this request changes\nclientAuthMethod, which requires the new method's credential to be supplied, because the\nauthentication service clears the credential belonging to the method being left. The\nconfiguration is always written as an ADMIN_SSO capability, CONFIDENTIAL client; neither\nvalue is settable through this request.\n\n\n> 📋 **Required privilege:** Update SSO Settings","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OidcBrokerConfigUpdate"}}},"required":true},"responses":{"204":{"description":"The broker configuration was updated."},"400":{"description":"Bad Request. No broker configuration UUID is stored for this tenant; the request changes clientAuthMethod without supplying the credential the new method requires; a required field is missing or invalid; or the authentication service rejected the submitted configuration.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Not Found. The authentication service no longer holds the broker configuration stored for this tenant.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"Service Unavailable. The update could not be attempted or completed — either a prerequisite is unavailable (the OIDC identity provider configuration feature is disabled, or machine-to-machine credentials are not configured) or the authentication service could not be reached.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update SSO Settings"]}},"/startup-status":{"get":{"tags":["startup-status"],"summary":"Retrieve information about application startup\n","description":"Retrieves information about application startup. Current startup operation taking place (if any) and overall startup completion percentage.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartupStatus"}}}}},"x-authentication-required":false}},"/v1/static-user-groups":{"get":{"tags":["static-user-groups-preview"],"summary":"Return a list of all Static User Groups\n","description":"Returns a list of all static user groups.\n\n\n> 📋 **Required privilege:** Read Static User Groups","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/StaticUserGroup"}}}}}},"x-required-privileges":["Read Static User Groups"]}},"/v1/static-user-groups/{id}":{"get":{"tags":["static-user-groups-preview"],"summary":"Return a specific Static User Group by id\n","description":"Returns a specific static user group by id.\n\n\n> 📋 **Required privilege:** Read Static User Groups","parameters":[{"name":"id","in":"path","description":"Instance id of static user group record","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StaticUserGroup"}}}},"404":{"description":"Specified static user group object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Static User Groups"]}},"/v1/supervision-identities":{"get":{"tags":["supervision-identities-preview"],"summary":"Search for sorted and paged Supervision Identities\n","description":"Search for sorted and paged supervision identities\n\n> 📋 **Required privilege:** Read Apple Configurator Enrollment","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/size"},{"$ref":"#/components/parameters/pagesize"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc ","required":false,"style":"form","explode":true,"schema":{"type":"string","default":"id:asc"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupervisionIdentitySearchResults"}}}}},"x-required-privileges":["Read Apple Configurator Enrollment"]},"post":{"tags":["supervision-identities-preview"],"summary":"Create a Supervision Identity for the supplied information\n","description":"Creates a Supervision Identity for the supplied information\n\n> 📋 **Required privilege:** Update Apple Configurator Enrollment","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupervisionIdentityCreate"}}},"required":true},"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupervisionIdentity"}}}},"500":{"description":"Something went wrong","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Apple Configurator Enrollment"]}},"/v1/supervision-identities/upload":{"post":{"tags":["supervision-identities-preview"],"summary":"Upload the Supervision Identity .p12 file\n","description":"Uploads the Supervision Identity .p12 file\n\n> 📋 **Required privilege:** Update Apple Configurator Enrollment","requestBody":{"description":"The base 64 encoded .p12 file alone with other needed information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupervisionIdentityCertificateUpload"}}},"required":true},"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupervisionIdentity"}}}},"500":{"description":"Something went wrong","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Apple Configurator Enrollment"],"x-action":true}},"/v1/supervision-identities/{id}":{"get":{"tags":["supervision-identities-preview"],"summary":"Retrieve a Supervision Identity with the supplied id\n","description":"Retrieves a Supervision Identity with the supplied id\n\n> 📋 **Required privilege:** Read Apple Configurator Enrollment","parameters":[{"name":"id","in":"path","description":"Supervision Identity identifier","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupervisionIdentity"}}}},"404":{"description":"Supervision Identity with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Apple Configurator Enrollment"]},"put":{"tags":["supervision-identities-preview"],"summary":"Update a Supervision Identity with the supplied information\n","description":"Updates a Supervision Identity with the supplied information\n\n> 📋 **Required privilege:** Update Apple Configurator Enrollment","parameters":[{"name":"id","in":"path","description":"Supervision Identity identifier","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupervisionIdentityUpdate"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupervisionIdentity"}}}},"404":{"description":"Supervision Identity with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Something went wrong","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Apple Configurator Enrollment"]},"delete":{"tags":["supervision-identities-preview"],"summary":"Delete a Supervision Identity with the supplied id\n","description":"Deletes a Supervision Identity with the supplied id\n\n> 📋 **Required privilege:** Update Apple Configurator Enrollment","parameters":[{"name":"id","in":"path","description":"Supervision Identity identifier","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Success"},"404":{"description":"Supervision Identity with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Apple Configurator Enrollment"]}},"/v1/supervision-identities/{id}/download":{"get":{"tags":["supervision-identities-preview"],"summary":"Download the Supervision Identity .p12 file\n","description":"Download the Supervision Identity .p12 file\n\n> 📋 **Required privilege:** Read Apple Configurator Enrollment","parameters":[{"name":"id","in":"path","description":"Supervision Identity identifier","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Apple Configurator Enrollment"]}},"/v1/teacher-app":{"get":{"tags":["teacher-app"],"summary":"Get the Jamf Teacher settings that you have access to see\n","description":"Get the Jamf Teacher settings that you have access to see.\n\n> 📋 **Required privilege:** Read Teacher App Settings","responses":{"200":{"description":"List of Jamf Teacher settings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeacherSettingsResponse"}}}}},"x-required-privileges":["Read Teacher App Settings"]},"put":{"tags":["teacher-app"],"summary":"Update a Jamf Teacher settings object\n","description":"Update a Jamf Teacher settings object.\n\n> 📋 **Required privilege:** Update Teacher App Settings","requestBody":{"description":"Teacher settings to create.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeacherSettingsRequest"}}},"required":true},"responses":{"200":{"description":"Updated Jamf Teacher settings.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeacherSettingsResponse"}}}},"500":{"description":"Update Failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Teacher App Settings"]}},"/v1/teacher-app/history":{"get":{"tags":["teacher-app"],"summary":"Get Jamf Teacher app settings history\n","description":"Gets Jamf Teacher app settings history\n\n\n> 📋 **Required privilege:** Read Teacher App Settings","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"$ref":"#/components/parameters/sort"},{"$ref":"#/components/parameters/filter"}],"responses":{"200":{"description":"Details of Jamf Teacher app settings history were found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistorySearchResults"}}}}},"x-required-privileges":["Read Teacher App Settings"]},"post":{"tags":["teacher-app"],"summary":"Add Jamf Teacher app settings history notes\n","description":"Adds Jamf Teacher app settings history notes\n\n\n> 📋 **Required privilege:** Update Teacher App Settings","requestBody":{"description":"history notes to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistoryNote"}}},"required":true},"responses":{"201":{"description":"Notes to Jamf Teacher app settings history were added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"503":{"description":"Jamf Teacher app history can not be saved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Teacher App Settings"]}},"/preview/remote-administration-configurations/team-viewer":{"post":{"tags":["team-viewer-remote-administration"],"summary":"Create Team Viewer Remote Administration connection configuration","description":"Creates Team Viewer Remote Administration connection configuration\n\n> 📋 **Required privilege:** Create Remote Administration","requestBody":{"description":"Team Viewer connection configuration create definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionConfigurationCandidateRequest"}}},"required":true},"responses":{"201":{"description":"Team Viewer connection configuration created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"400":{"description":"Invalid field for Team Viewer connection configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Insufficient privileges or site not found for Team Viewer connection configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"Site limit exceeded for Team Viewer connection configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Create Remote Administration"]}},"/preview/remote-administration-configurations/team-viewer/{configurationId}/sessions":{"get":{"tags":["team-viewer-remote-administration"],"summary":"Get a paginated list of sessions\n","description":"Returns a paginated list of sessions for a given configuration ID\n\n> 📋 **Required privilege:** Read Remote Administration","parameters":[{"name":"configurationId","in":"path","description":"ID of the Team Viewer connection configuration","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter sessions collection.\nDefault filter is empty query - returning all results for the requested page.\n\nFields allowed in the query: `deviceId`, `deviceType`, `state`\n\nThis param can be combined with paging.\n","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""},"example":"deviceId==1 and deviceType==\"COMPUTER\" and state==\"OPEN\""}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionDetailsSearchResults"}}}},"403":{"description":"Insufficient privileges","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Remote Administration"]},"post":{"tags":["team-viewer-remote-administration"],"summary":"Create a new session","description":"Creates a new Team Viewer session to be used to establish a remote connection\n\n> 📋 **Required privilege:** Create Remote Administration","parameters":[{"name":"configurationId","in":"path","description":"ID of the Team Viewer connection configuration","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Team Viewer session attributes","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionCandidateRequest"}}},"required":true},"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"400":{"description":"Invalid attributes for Team Viewer session","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Insufficient privileges","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"Connection configuration is not active or there is an active session for the device","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Create Remote Administration"]}},"/preview/remote-administration-configurations/team-viewer/{configurationId}/sessions/{sessionId}":{"get":{"tags":["team-viewer-remote-administration"],"summary":"Get a session by its ID\n","description":"Returns a session details if found.\n\n> 📋 **Required privilege:** Read Remote Administration","parameters":[{"name":"configurationId","in":"path","description":"ID of the Team Viewer connection configuration","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"sessionId","in":"path","description":"ID of the Team Viewer session","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionDetails"}}}},"403":{"description":"Insufficient privileges","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Remote Administration"]}},"/preview/remote-administration-configurations/team-viewer/{configurationId}/sessions/{sessionId}/close":{"post":{"tags":["team-viewer-remote-administration"],"summary":"Close a session","description":"Changes the session state from open to close. Closing a session means it is not possible to establish new remote connection between devices\n\n> 📋 **Required privilege:** Update Remote Administration","parameters":[{"name":"configurationId","in":"path","description":"ID of the Team Viewer connection configuration","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"sessionId","in":"path","description":"ID of the Team Viewer session","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful response"},"403":{"description":"Insufficient privileges","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"Connection configuration is not active","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Remote Administration"],"x-action":true}},"/preview/remote-administration-configurations/team-viewer/{configurationId}/sessions/{sessionId}/resend-notification":{"post":{"tags":["team-viewer-remote-administration"],"summary":"Resend nofications for a session","description":"Resends configured notifications (e.g. Self Service push notifications).\n\n> 📋 **Required privilege:** Update Remote Administration","parameters":[{"name":"configurationId","in":"path","description":"ID of the Team Viewer connection configuration","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"sessionId","in":"path","description":"ID of the Team Viewer session","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful response"},"403":{"description":"Insufficient privileges","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"Connection configuration is not active or session is already closed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Remote Administration"],"x-action":true}},"/preview/remote-administration-configurations/team-viewer/{configurationId}/sessions/{sessionId}/status":{"get":{"tags":["team-viewer-remote-administration"],"summary":"Get a session status by its ID\n","description":"Returns a session status if found.\n\n> 📋 **Required privilege:** Read Remote Administration","parameters":[{"name":"configurationId","in":"path","description":"ID of the Team Viewer connection configuration","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"sessionId","in":"path","description":"ID of the Team Viewer session","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionStatus"}}}},"403":{"description":"Insufficient privileges","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Team Viewer session status not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Remote Administration"]}},"/preview/remote-administration-configurations/team-viewer/{id}":{"get":{"tags":["team-viewer-remote-administration"],"summary":"Get Team Viewer Remote Administration connection configuration","description":"Returns Team Viewer Remote Administration connection configuration\n\n> 📋 **Required privilege:** Read Remote Administration","parameters":[{"name":"id","in":"path","description":"ID of the Team Viewer connection configuration","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns Team Viewer connection configuration response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionConfigurationResponse"}}}},"404":{"description":"Team Viewer connection configuration does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Remote Administration"]},"delete":{"tags":["team-viewer-remote-administration"],"summary":"Delete Team Viewer Remote Administration connection configuration","description":"Deletes Team Viewer Remote Administration connection configuration\n\n> 📋 **Required privilege:** Delete Remote Administration","parameters":[{"name":"id","in":"path","description":"ID of the Team Viewer connection configuration","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Team Viewer connection configuration deleted successfully"}},"x-required-privileges":["Delete Remote Administration"]},"patch":{"tags":["team-viewer-remote-administration"],"summary":"Update Team Viewer Remote Administration connection configuration","description":"Updates Team Viewer Remote Administration connection configuration\n\n> 📋 **Required privilege:** Update Remote Administration","parameters":[{"name":"id","in":"path","description":"ID of the Team Viewer connection configuration","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Team Viewer connection configuration update request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionConfigurationUpdateRequest"}}},"required":true},"responses":{"200":{"description":"Team Viewer connection configuration updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionConfigurationResponse"}}}},"400":{"description":"Invalid field for Team Viewer connection configuration update request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Team Viewer connection configuration does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Remote Administration"]}},"/preview/remote-administration-configurations/team-viewer/{id}/status":{"get":{"tags":["team-viewer-remote-administration"],"summary":"Get Team Viewer Remote Administration connection status","description":"Returns Team Viewer Remote Administration connection status\n\n> 📋 **Required privilege:** Read Remote Administration","parameters":[{"name":"id","in":"path","description":"ID of the Team Viewer connection configuration","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns Team Viewer connection status response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionConfigurationStatusResponse"}}}}},"x-required-privileges":["Read Remote Administration"]}},"/v1/time-zones":{"get":{"tags":["time-zones-preview"],"summary":"Return information about the currently supported Time Zones\n","description":"Returns information about the currently supported time zones\n","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TimeZone"}}}}}},"x-authentication-required":false}},"/settings/issueTomcatSslCertificate":{"post":{"tags":["tomcat-settings-preview"],"summary":"Generate a SSL Certificate using Jamf Certificate Authority\n","description":"generate a SSL Certificate using Jamf Certificate Authority\n\n> 📋 **Required privilege:** Update Apache Tomcat Settings","responses":{"204":{"description":"SSL certificate created successfully"}},"x-required-privileges":["Update Apache Tomcat Settings"],"x-action":true}},"/v1/user/change-password":{"post":{"tags":["user"],"summary":"Changes the user account password.\n","description":"Changes the account password for a currently authenticated user.\n\n\n> 📋 **Required privilege:** Change Password","requestBody":{"description":"Current account password and new password.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangePassword"}}},"required":true},"responses":{"202":{"description":"Password for user successfully changed."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded"}},"x-required-privileges":["Change Password"],"x-authentication-required":true,"x-action":true,"x-rate-limit":true}},"/user":{"get":{"tags":["user-session-preview"],"summary":"Return all Jamf Pro user acounts\n","description":"Return all Jamf Pro user acounts.\n\n\n> 📋 **Required privilege:** Read Accounts","responses":{"200":{"description":"List of all Jamf Pro user acounts.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Account"}}}}}},"x-required-privileges":["Read Accounts"]}},"/user/updateSession":{"post":{"tags":["user-session-preview"],"summary":"Update values in the User's current session\n","description":"Updates values in the user's current session.\n","requestBody":{"description":"Values to update in user's current session.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session"}}},"required":false},"responses":{"200":{"description":"The user's current session has been sucessfully updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session"}}}}},"x-authentication-required":true}},"/v1/user-sessions/active":{"get":{"tags":["user-sessions"],"summary":"Get active user sessions.\n","description":"Returns detailed information about currently logged in users.\n\n\n> 📋 **Required privilege:** Read User","responses":{"200":{"description":"Active user sessions retrieved successfully.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ActiveUserSession"}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read User"],"x-authentication-required":true}},"/v1/user-sessions/count":{"get":{"tags":["user-sessions"],"summary":"Get count of active user sessions.\n","description":"Returns the number of currently logged in users.\n\n\n> 📋 **Required privilege:** Read User","responses":{"200":{"description":"Count of active user sessions retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActiveUsersCount"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read User"],"x-authentication-required":true}},"/v1/users":{"get":{"tags":["users"],"summary":"Retrieve users with pagination and filtering","description":"Retrieves a paginated list of users with optional filtering and sorting.\n\n> 📋 **Required privilege:** Read User","parameters":[{"name":"page","in":"query","description":"Page to display. Uses zero-based indexing.","required":false,"style":"form","explode":true,"schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"page-size","in":"query","description":"Number of results per page. Maximum of 1000.","required":false,"style":"form","explode":true,"schema":{"maximum":1000,"minimum":1,"type":"integer","format":"int32","default":100}},{"name":"sort","in":"query","description":"Sorting criteria in the format: property(:asc|desc). Default sort order is ascending.\nMultiple sort criteria are supported.\n\nExamples:\n- sort=username\n- sort=username:asc\n- sort=username:asc,realname:desc","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}},{"name":"filter","in":"query","description":"RSQL filter to limit results. Supports all user fields.\n\nExamples:\n- filter=username==\"john*\"\n- filter=realname==\"John Smith\"\n- filter=email==\"*@jamf.com\"\n- filter=position==\"Manager\";id!=\"1\"\n- filter=id=in=(123,456,789)","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}},{"name":"platform","in":"query","description":"Optional. Return platform identifiers instead of internal identifiers when set to true.","required":false,"style":"form","explode":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Users retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedUserResults"}}}},"400":{"description":"Invalid request parameters"},"500":{"description":"Internal server error"}},"x-required-privileges":["Read User"],"x-authentication-required":true},"post":{"tags":["users"],"summary":"Create a new user in inventory","description":"Creates a new user in the inventory.\n\n> 📋 **Required privilege:** Create User","parameters":[{"name":"platform","in":"query","description":"Internal platform request indicator","required":false,"style":"form","explode":true,"schema":{"type":"boolean","default":false},"x-internal":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserInventory"}}},"required":true},"responses":{"201":{"description":"User successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"400":{"description":"Invalid user data provided"},"500":{"description":"Internal server error"}},"x-required-privileges":["Create User"],"x-authentication-required":true}},"/v1/users/{id}":{"get":{"tags":["users"],"summary":"Retrieve a user by ID","description":"Retrieves a single user by their ID.\n\n> 📋 **Required privilege:** Read User","parameters":[{"name":"id","in":"path","description":"ID of the user to retrieve","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"platform","in":"query","description":"Optional. Return platform identifiers instead of internal identifiers when set to true.","required":false,"style":"form","explode":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"User retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"404":{"description":"User with specified ID not found"},"500":{"description":"Internal server error"}},"x-required-privileges":["Read User"],"x-authentication-required":true},"put":{"tags":["users"],"summary":"Update a user in inventory","description":"Updates an existing user in the inventory by ID.\n\n> 📋 **Required privilege:** Update User","parameters":[{"name":"id","in":"path","description":"ID of the user to update","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"1"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserInventory"}}},"required":true},"responses":{"204":{"description":"User successfully updated"},"400":{"description":"Invalid user data provided"},"404":{"description":"User with specified ID not found"},"500":{"description":"Internal server error"}},"x-required-privileges":["Update User"],"x-authentication-required":true},"delete":{"tags":["users"],"summary":"Delete a user from inventory","description":"Deletes a user from the inventory by ID.\n\n> 📋 **Required privilege:** Delete User","parameters":[{"name":"id","in":"path","description":"ID of the user to delete","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"1"}}],"responses":{"204":{"description":"User successfully deleted"},"404":{"description":"User with specified ID not found"},"500":{"description":"Internal server error"}},"x-required-privileges":["Delete User"],"x-authentication-required":true}},"/v1/pki/venafi":{"post":{"tags":["venafi-preview"],"summary":"Create a PKI configuration in Jamf Pro for Venafi\n","description":"Creates a Venafi PKI configuration in Jamf Pro, which can be used to issue certificates\n\n\n> 📋 **Required privilege:** Update PKI","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VenafiCaRecord"}}},"required":true},"responses":{"201":{"description":"Successful response creates a Venafi PKI configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"400":{"description":"Invalid attributes for Certificate Authority configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update PKI"]}},"/v1/pki/venafi/{id}":{"get":{"tags":["venafi-preview"],"summary":"Retrieve a Venafi PKI configuration from Jamf Pro\n","description":"Retrieve a Venafi PKI configuration from Jamf Pro\n\n\n> 📋 **Required privilege:** Read PKI","parameters":[{"name":"id","in":"path","description":"ID of the Venafi configuration","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response returns a Venafi PKI configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VenafiCaRecord"}}}},"404":{"description":"Certificate Authority not found for Id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read PKI"]},"delete":{"tags":["venafi-preview"],"summary":"Delete a Venafi PKI configuration from Jamf Pro\n","description":"Delete a Venafi PKI configuration from Jamf Pro\n\n\n> 📋 **Required privilege:** Update PKI","parameters":[{"name":"id","in":"path","description":"ID of the Venafi configuration","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful response deletes Venafi PKI configuration from Jamf Pro"},"404":{"description":"Certificate Authority not found for Id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"Conflict deleting target, Venafi PKI configuration still in use on Configuration Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update PKI"]},"patch":{"tags":["venafi-preview"],"summary":"Update a Venafi PKI configuration in Jamf Pro\n","description":"Update a Venafi PKI configuration in Jamf Pro\n\n\n> 📋 **Required privilege:** Update PKI","parameters":[{"name":"id","in":"path","description":"ID of the Venafi configuration","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VenafiCaRecord"}}},"required":true},"responses":{"200":{"description":"Successful response returns a Venafi PKI configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VenafiCaRecord"}}}},"400":{"description":"Invalid attributes for Certificate Authority configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Certificate Authority not found for Id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update PKI"]}},"/v1/pki/venafi/{id}/connection-status":{"get":{"tags":["venafi-preview"],"summary":"Tests the communication between Jamf Pro and a Jamf Pro PKI Proxy Server\n","description":"Tests the communication between Jamf Pro and a Jamf Pro PKI Proxy Server\n\n\n> 📋 **Required privilege:** Read PKI","parameters":[{"name":"id","in":"path","description":"ID of the Venafi configuration","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully connected to Venafi","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VenafiServiceStatus"}}}},"503":{"description":"Why we failed to connect","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read PKI"]}},"/v1/pki/venafi/{id}/dependent-profiles":{"get":{"tags":["venafi-preview"],"summary":"Get configuration profile data using specified Venafi CA object\n","description":"Get configuration profile data using specified Venafi CA object\n\n\n> 📋 **Required privilege:** Read PKI","parameters":[{"name":"id","in":"path","description":"ID of the Venafi configuration","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully returns a list of configuration profile data connected to the Venafi CA","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VenafiPkiPayloadRecordSearchResults"}}}}},"x-required-privileges":["Read PKI"]}},"/v1/pki/venafi/{id}/history":{"get":{"tags":["venafi-preview"],"summary":"Get specified Venafi CA history object\n","description":"Get specified Venafi CA history object\n\n\n> 📋 **Required privilege:** Read PKI","parameters":[{"name":"id","in":"path","description":"ID of the Venafi configuration","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["date:desc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Details of Venafi CA history was found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistorySearchResults"}}}},"404":{"description":"Specified Venafi CA object does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read PKI"]},"post":{"tags":["venafi-preview"],"summary":"Add specified Venafi CA Object Note\n","description":"Adds specified Venafi CA Object Note\n\n\n> 📋 **Required privilege:** Update PKI","parameters":[{"name":"id","in":"path","description":"instance id of Venafi CA history record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"venafi ca history notes to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistoryNote"}}},"required":true},"responses":{"201":{"description":"Notes of Venafi CA history were added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"404":{"description":"Specified Venafi CA object does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"Venafi CA history can not be saved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update PKI"]}},"/v1/pki/venafi/{id}/jamf-public-key":{"get":{"tags":["venafi-preview"],"summary":"Downloads a certificate used to secure communication between Jamf Pro and a Jamf Pro PKI Proxy Server\n","description":"Downloads a certificate for an existing Venafi configuration that can be used to secure communication between Jamf Pro and a Jamf Pro PKI Proxy Server\n\n\n> 📋 **Required privilege:** Read PKI","parameters":[{"name":"id","in":"path","description":"ID of the Venafi configuration","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response downloads the certificate","content":{"application/pem-certificate-chain":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Keystore not found for Certificate Authority","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Certificate not found for Id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read PKI"]}},"/v1/pki/venafi/{id}/jamf-public-key/regenerate":{"post":{"tags":["venafi-preview"],"summary":"Regenerates a certificate used to secure communication between Jamf Pro and a Jamf Pro PKI Proxy Server\n","description":"Regenerates a certificate for an existing Venafi configuration that can be used to secure communication between Jamf Pro and a Jamf Pro PKI Proxy Server\n\n\n> 📋 **Required privilege:** Update PKI","parameters":[{"name":"id","in":"path","description":"ID of the Venafi configuration","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful response regenerates the certificate"},"404":{"description":"Certificate Authority not found for Id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-action":true,"x-required-privileges":["Update PKI"]}},"/v1/pki/venafi/{id}/proxy-trust-store":{"get":{"tags":["venafi-preview"],"summary":"Downloads the PKI Proxy Server public key to secure communication between Jamf Pro and a Jamf Pro PKI Proxy Server\n","description":"Downloads the uploaded PKI Proxy Server public key to do basic TLS certificate validation between Jamf Pro and a Jamf Pro PKI Proxy Server\n\n\n> 📋 **Required privilege:** Read PKI","parameters":[{"name":"id","in":"path","description":"ID of the Venafi configuration","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response downloads the certificate","content":{"application/pem-certificate-chain":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Keystore not found for Certificate Authority","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Certificate not found for Certificate Authority","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read PKI"]},"post":{"tags":["venafi-preview"],"summary":"Uploads the PKI Proxy Server public key to secure communication between Jamf Pro and a Jamf Pro PKI Proxy Server\n","description":"Uploads the PKI Proxy Server public key to do basic TLS certificate validation between Jamf Pro and a Jamf Pro PKI Proxy Server\n\n\n> 📋 **Required privilege:** Update PKI","parameters":[{"name":"id","in":"path","description":"ID of the Venafi configuration","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/pem-certificate-chain":{"schema":{"type":"string","format":"binary"}}},"required":true},"responses":{"204":{"description":"Successful response replaces or removes public key"},"400":{"description":"Keystore not found for Certificate Authority","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Certificate not found for Certificate Authority","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update PKI"]},"delete":{"tags":["venafi-preview"],"summary":"Removes the PKI Proxy Server public key used to secure communication between Jamf Pro and a Jamf Pro PKI Proxy Server\n","description":"Removes the uploaded PKI Proxy Server public key to do basic TLS certificate validation between Jamf Pro and a Jamf Pro PKI Proxy Server\n\n\n> 📋 **Required privilege:** Update PKI","parameters":[{"name":"id","in":"path","description":"ID of the Venafi configuration","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful removes public key"},"404":{"description":"Certificate Authority not found for Id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update PKI"]}},"/v1/volume-purchasing-locations":{"get":{"tags":["volume-purchasing-locations"],"summary":"Retrieve Volume Purchasing Locations","description":"Retrieves Volume Purchasing Locations\n\n> 📋 **Required privilege:** Read Volume Purchasing Locations","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma.","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter Volume Purchasing Location collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: id, name, appleId, email, organizationName, tokenExpiration, countryCode, locationName, automaticallyPopulatePurchasedContent, sendNotificationWhenNoLongerAssigned, siteId and siteName. This param can be combined with paging and sorting.","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VolumePurchasingLocations"}}}}},"x-required-privileges":["Read Volume Purchasing Locations"]},"post":{"tags":["volume-purchasing-locations"],"summary":"Create a Volume Purchasing Location","description":"Creates a Volume Purchasing Location using an sToken\n\n> 📋 **Required privilege:** Create Volume Purchasing Locations","requestBody":{"description":"Volume Purchasing Location to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VolumePurchasingLocationPost"}}},"required":true},"responses":{"201":{"description":"Volume Purchasing Location was created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Create Volume Purchasing Locations"]}},"/v1/volume-purchasing-locations/{id}":{"get":{"tags":["volume-purchasing-locations"],"summary":"Retrieve a Volume Purchasing Location with the supplied id","description":"Retrieves a Volume Purchasing Location with the supplied id\n\n> 📋 **Required privilege:** Read Volume Purchasing Locations","parameters":[{"name":"id","in":"path","description":"Volume Purchasing Location identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VolumePurchasingLocation"}}}},"404":{"description":"Volume Purchasing Location with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Volume Purchasing Locations"]},"delete":{"tags":["volume-purchasing-locations"],"summary":"Delete a Volume Purchasing Location with the supplied id","description":"Deletes a Volume Purchasing Location with the supplied id\n\n> 📋 **Required privilege:** Delete Volume Purchasing Locations","parameters":[{"name":"id","in":"path","description":"Volume Purchasing Location identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Success"},"404":{"description":"Specified Volume Purchasing Location object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Delete Volume Purchasing Locations"]},"patch":{"tags":["volume-purchasing-locations"],"summary":"Update a Volume Purchasing Location","description":"Updates a Volume Purchasing Location\n\n> 📋 **Required privilege:** Update Volume Purchasing Locations","parameters":[{"name":"id","in":"path","description":"Volume Purchasing Location identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Volume Purchasing Location to update","content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/VolumePurchasingLocationPatch"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VolumePurchasingLocation"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Volume Purchasing Location with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"There was an error applying the patch","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Volume Purchasing Locations"]}},"/v1/volume-purchasing-locations/{id}/content":{"get":{"tags":["volume-purchasing-locations"],"summary":"Retrieve the Volume Purchasing Content for the Volume Purchasing Location with the supplied id","description":"Retrieves the Volume Purchasing Content for the Volume Purchasing Location with the supplied id\n\n> 📋 **Required privilege:** Read Volume Purchasing Locations","parameters":[{"name":"id","in":"path","description":"Volume Purchasing Location identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is name:asc. Multiple sort criteria are supported and must be separated with a comma.","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter Volume Purchasing Content collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: name, licenseCountTotal, licenseCountInUse, licenseCountReported, contentType, and pricingParam. This param can be combined with paging and sorting.","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VolumePurchasingContentList"}}}},"404":{"description":"Volume Purchasing Location with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Volume Purchasing Locations"]}},"/v1/volume-purchasing-locations/{id}/history":{"get":{"tags":["volume-purchasing-locations"],"summary":"Get specified Volume Purchasing Location history object\n","description":"Gets specified Volume Purchasing Location history object\n\n\n> 📋 **Required privilege:** Read Volume Purchasing Locations","parameters":[{"name":"id","in":"path","description":"instance id of Volume Purchasing Location history record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma. ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["date:desc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Details of Volume Purchasing Location history were found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistorySearchResults"}}}},"404":{"description":"Specified Volume Purchasing Location object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Volume Purchasing Locations"]},"post":{"tags":["volume-purchasing-locations"],"summary":"Add specified Volume Purchasing Location history object notes\n","description":"Adds specified Volume Purchasing Location history object notes\n\n\n> 📋 **Required privilege:** Update Volume Purchasing Locations","parameters":[{"name":"id","in":"path","description":"instance id of Volume Purchasing Location history record","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"history note to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistoryNote"}}},"required":true},"responses":{"201":{"description":"Notes of Volume Purchase Location history were added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistory"}}}},"404":{"description":"Specified Volume Purchase Location object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"Volume Purchase Location history can not be saved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Volume Purchasing Locations"]}},"/v1/volume-purchasing-locations/{id}/reclaim":{"post":{"tags":["volume-purchasing-locations"],"summary":"Reclaim a Volume Purchasing Location with the supplied id","description":"Reclaims a Volume Purchasing Location with the supplied id\n\n> 📋 **Required privilege:** Update Volume Purchasing Locations","parameters":[{"name":"id","in":"path","description":"Volume Purchasing Location identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"202":{"description":"Request accepted"}},"x-required-privileges":["Update Volume Purchasing Locations"],"x-action":true}},"/v1/volume-purchasing-locations/{id}/revoke-licenses":{"post":{"tags":["volume-purchasing-locations"],"summary":"Revoke licenses for a Volume Purchasing Location with the supplied id","description":"Revokes licenses for a Volume Purchasing Location with the supplied id. The licenses must be revokable - any asset whose licenses are irrevocable will not be revoked.\n\n> 📋 **Required privilege:** Update Volume Purchasing Locations","parameters":[{"name":"id","in":"path","description":"Volume Purchasing Location identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"202":{"description":"Request accepted"},"404":{"description":"Volume Purchasing Location with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Volume Purchasing Locations"],"x-action":true}},"/v1/volume-purchasing-subscriptions":{"get":{"tags":["volume-purchasing-subscriptions"],"summary":"Retrieve Volume Purchasing Subscriptions","description":"Retrieves Volume Purchasing Subscriptions\n\n> 📋 **Required privilege:** Read Volume Purchasing Locations","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Allowable properties are id, name, and enabled.","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["id:asc"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VolumePurchasingSubscriptions"}}}}},"x-required-privileges":["Read Volume Purchasing Locations"]},"post":{"tags":["volume-purchasing-subscriptions"],"summary":"Create a Volume Purchasing Subscription","description":"Creates a Volume Purchasing Subscription\n\n> 📋 **Required privilege:** Create Volume Purchasing Locations","requestBody":{"description":"Volume Purchasing Subscription to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VolumePurchasingSubscriptionBase"}}},"required":true},"responses":{"201":{"description":"Volume Purchasing Subscription was created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Failed to create volume purchasing subscription","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Create Volume Purchasing Locations"]}},"/v1/volume-purchasing-subscriptions/{id}":{"get":{"tags":["volume-purchasing-subscriptions"],"summary":"Retrieve a Volume Purchasing Subscription with the supplied id","description":"Retrieves a Volume Purchasing Subscription with the supplied id\n\n> 📋 **Required privilege:** Read Volume Purchasing Locations","parameters":[{"name":"id","in":"path","description":"Volume Purchasing Subscription identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VolumePurchasingSubscription"}}}},"404":{"description":"Volume Purchasing Subscription with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Volume Purchasing Locations"]},"put":{"tags":["volume-purchasing-subscriptions"],"summary":"Update a Volume Purchasing Subscription","description":"Updates a Volume Purchasing Subscription\n\n> 📋 **Required privilege:** Update Volume Purchasing Locations","parameters":[{"name":"id","in":"path","description":"Volume Purchasing Subscription identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"Volume Purchasing Subscription to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VolumePurchasingSubscriptionBase"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VolumePurchasingSubscription"}}}},"404":{"description":"Volume Purchasing Subscription with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Failed to update volume purchasing subscription","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Volume Purchasing Locations"]},"delete":{"tags":["volume-purchasing-subscriptions"],"summary":"Delete a Volume Purchasing Subscription with the supplied id","description":"Deletes a Volume Purchasing Subscription with the supplied id\n\n> 📋 **Required privilege:** Delete Volume Purchasing Locations","parameters":[{"name":"id","in":"path","description":"Volume Purchasing Subscription identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Success"},"404":{"description":"VPP Subscription with that id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Delete Volume Purchasing Locations"]}},"/v1/volume-purchasing-subscriptions/{id}/history":{"get":{"tags":["volume-purchasing-subscriptions"],"summary":"Get specified Volume Purchasing Subscription history object\n","description":"Gets specified Volume Purchasing Subscription history object\n\n\n> 📋 **Required privilege:** Read Volume Purchasing Locations","parameters":[{"name":"id","in":"path","description":"Volume Purchasing Subscription Id","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page-size"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma. ","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["date:desc"]}},{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Details of Volume Purchasing Subscription history were found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistorySearchResults"}}}},"404":{"description":"Specified Volume Purchasing Subscription object does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Read Volume Purchasing Locations"]},"post":{"tags":["volume-purchasing-subscriptions"],"summary":"Add Volume Purchasing Subscription history object notes\n","description":"Adds Volume Purchasing Subscription history object notes\n\n> 📋 **Required privilege:** Update Volume Purchasing Locations","parameters":[{"name":"id","in":"path","description":"Volume Purchasing Subscription Id","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"History notes to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectHistoryNote"}}},"required":true},"responses":{"201":{"description":"Notes of Volume Purchasing Subscription history were added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrefResponse"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Volume Purchasing Subscription with that Id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"Volume Purchasing Subscription history can not be saved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"x-required-privileges":["Update Volume Purchasing Locations"]}}},"components":{"schemas":{"AccessGroupsPreviewSearchResults":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":10},"results":{"type":"array","items":{"$ref":"#/components/schemas/EnrollmentAccessGroupPreview"}}}},"AccessManagementSetting":{"type":"object","properties":{"automatedDeviceEnrollmentServerUuid":{"maxLength":256,"type":"string","example":"4B637BAB65D14E6DA63A74E4F6F82C4B","default":""}}},"Account":{"type":"object","properties":{"id":{"type":"integer","example":1},"username":{"type":"string","example":"admin"},"realName":{"type":"string","example":"IT Bob"},"email":{"type":"string","example":"ITBob@Jamf.com"},"preferences":{"$ref":"#/components/schemas/AccountPreferences"},"isMultiSiteAdmin":{"type":"boolean","example":false},"accessLevel":{"type":"string","example":"FullAccess","enum":["FullAccess","SiteAccess","GroupBasedAccess"]},"privilegeSet":{"type":"string","example":"CUSTOM","enum":["ADMINISTRATOR","AUDITOR","ENROLLMENT","CUSTOM"]},"privilegesBySite":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"example":{"1":["Read SSO Settings","Delete eBooks"]}},"groupIds":{"type":"array","example":[1,3],"items":{"type":"integer"}},"currentSiteId":{"type":"integer","example":1}}},"AccountDrivenUserEnrollmentSessionTokenSettings":{"type":"object","properties":{"enabled":{"type":"boolean","example":false},"expirationIntervalDays":{"type":"integer","example":1},"expirationIntervalSeconds":{"type":"integer","example":86400}},"description":"Settings for Account Driven User Enrollment. Only 1 of expirationIntervalDays or expirationIntervalSeconds can be supplied."},"AccountGroup":{"type":"object","properties":{"accessLevel":{"type":"string","example":"FullAccess","enum":["FullAccess","SiteAccess","GroupBasedAccess"]},"privilegeSet":{"type":"string","example":"CUSTOM","enum":["ADMINISTRATOR","AUDITOR","ENROLLMENT","CUSTOM"]},"siteId":{"type":"integer","example":1},"privileges":{"type":"array","example":"Read SSO Settings","items":{"type":"string"}},"memberUserIds":{"type":"array","example":[1,3],"items":{"type":"integer"}}}},"AccountGroupSearchResultsV1":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","description":"Total number of account groups matching the filter criteria","example":1},"results":{"minItems":0,"type":"array","description":"The collection of account groups for the requested page","items":{"$ref":"#/components/schemas/AccountGroupV1"}}}},"AccountGroupV1":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"1"},"name":{"minLength":1,"type":"string","example":"Admin"},"accessLevel":{"type":"string","description":"Access level for the account group","enum":["FullAccess","SiteAccess","GroupBasedAccess"],"default":"FullAccess"},"privilegeLevel":{"type":"string","description":"Privilege level for the account group","enum":["ADMINISTRATOR","AUDITOR","ENROLLMENT","CUSTOM"],"default":"ADMINISTRATOR"},"siteId":{"type":"string","example":"-1"},"ldapServerId":{"type":"string","example":"-1"},"directoryGroupId":{"type":"string","example":""},"members":{"type":"array","description":"Members of this account group","items":{"required":["id"],"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"1"},"username":{"type":"string","nullable":true,"example":"admin"},"realname":{"type":"string","nullable":true,"example":"Admin User"},"email":{"type":"string","nullable":true,"example":"admin@jamf.com"}}}},"privileges":{"type":"array","description":"List of privilege strings assigned to this group","example":["Read Computers","Update Computers"],"items":{"type":"string"}}}},"AccountPreferences":{"type":"object","properties":{"language":{"type":"string","example":"en"},"dateFormat":{"type":"string","example":"MM/dd/yyyy"},"region":{"type":"string","example":"Europe"},"timezone":{"type":"string","example":"Etc/GMT"},"isDisableRelativeDates":{"type":"boolean","example":false}}},"AccountPreferencesSearchType":{"type":"string","nullable":false,"example":"EXACT_MATCH","enum":["EXACT_MATCH","STARTS_WITH","CONTAINS"]},"AccountPreferencesUserInterfaceDisplayTheme":{"type":"string","nullable":false,"example":"MATCH_SYSTEM","enum":["MATCH_SYSTEM","LIGHT","DARK"]},"AccountPreferencesV1":{"type":"object","properties":{"language":{"type":"string","example":"en"},"dateFormat":{"type":"string","example":"MM/dd/yyyy"},"region":{"type":"string","example":"Europe"},"timezone":{"type":"string","example":"Etc/GMT"},"disableRelativeDates":{"type":"boolean","example":false}}},"AccountPreferencesV5":{"required":["computerApplicationSearchMethod","computerApplicationUsageSearchMethod","computerLocalUserAccountSearchMethod","computerPackageReceiptSearchMethod","computerPrinterSearchMethod","computerSearchMethod","computerServiceSearchMethod","configProfilesSortingMethod","dateFormat","disablePageLeaveCheck","disableRelativeDates","disableShortcutsTooltips","disableTablePagination","language","mobileDeviceAppSearchMethod","mobileDeviceSearchMethod","resultsPerPage","showDirectoryGroupUuidColumn","timezone","userAllContentSearchMethod","userEbookSearchMethod","userInterfaceDisplayTheme","userMacAppStoreAppSearchMethod","userMobileDeviceAppSearchMethod","userSearchMethod"],"type":"object","properties":{"language":{"type":"string","description":"Language codes supported by Jamf Pro","nullable":false,"enum":["en","de","fr","es","ja","zh-hant"],"default":"en"},"dateFormat":{"type":"string","nullable":false,"example":"MM/dd/yyyy"},"timezone":{"type":"string","nullable":false,"example":"America/Chicago"},"resultsPerPage":{"type":"integer","example":50,"default":100},"userInterfaceDisplayTheme":{"$ref":"#/components/schemas/AccountPreferencesUserInterfaceDisplayTheme"},"disableRelativeDates":{"type":"boolean","nullable":false,"example":false},"disablePageLeaveCheck":{"type":"boolean","nullable":false,"example":true},"disableTablePagination":{"type":"boolean","nullable":false,"example":true},"showDirectoryGroupUuidColumn":{"type":"boolean","nullable":false,"example":false},"disableShortcutsTooltips":{"type":"boolean","nullable":false,"example":true},"configProfilesSortingMethod":{"type":"string","nullable":false,"example":"ALPHABETICALLY"},"computerSearchMethod":{"$ref":"#/components/schemas/AccountPreferencesSearchType"},"computerApplicationSearchMethod":{"$ref":"#/components/schemas/AccountPreferencesSearchType"},"computerApplicationUsageSearchMethod":{"$ref":"#/components/schemas/AccountPreferencesSearchType"},"computerFontSearchMethod":{"$ref":"#/components/schemas/AccountPreferencesSearchType"},"computerPluginSearchMethod":{"$ref":"#/components/schemas/AccountPreferencesSearchType"},"computerSoftwareUpdateSearchMethod":{"$ref":"#/components/schemas/AccountPreferencesSearchType"},"computerLocalUserAccountSearchMethod":{"$ref":"#/components/schemas/AccountPreferencesSearchType"},"computerPackageReceiptSearchMethod":{"$ref":"#/components/schemas/AccountPreferencesSearchType"},"computerPrinterSearchMethod":{"$ref":"#/components/schemas/AccountPreferencesSearchType"},"computerPeripheralSearchMethod":{"$ref":"#/components/schemas/AccountPreferencesSearchType"},"computerServiceSearchMethod":{"$ref":"#/components/schemas/AccountPreferencesSearchType"},"mobileDeviceSearchMethod":{"$ref":"#/components/schemas/AccountPreferencesSearchType"},"mobileDeviceAppSearchMethod":{"$ref":"#/components/schemas/AccountPreferencesSearchType"},"userSearchMethod":{"$ref":"#/components/schemas/AccountPreferencesSearchType"},"userAllContentSearchMethod":{"$ref":"#/components/schemas/AccountPreferencesSearchType"},"userMobileDeviceAppSearchMethod":{"$ref":"#/components/schemas/AccountPreferencesSearchType"},"userMacAppStoreAppSearchMethod":{"$ref":"#/components/schemas/AccountPreferencesSearchType"},"userEbookSearchMethod":{"$ref":"#/components/schemas/AccountPreferencesSearchType"}}},"AccountPreferencesV6":{"required":["computerApplicationSearchMethod","computerApplicationUsageSearchMethod","computerLocalUserAccountSearchMethod","computerPackageReceiptSearchMethod","computerPrinterSearchMethod","computerSearchMethod","computerServiceSearchMethod","configProfilesSortingMethod","dateFormat","disablePageLeaveCheck","disableRelativeDates","disableShortcutsTooltips","disableTablePagination","language","mobileDeviceAppSearchMethod","mobileDeviceSearchMethod","resultsPerPage","showDirectoryGroupUuidColumn","timezone","userAllContentSearchMethod","userEbookSearchMethod","userInterfaceDisplayTheme","userMacAppStoreAppSearchMethod","userMobileDeviceAppSearchMethod","userSearchMethod"],"type":"object","properties":{"language":{"type":"string","description":"Language codes supported by Jamf Pro","nullable":false,"enum":["en","de","fr","es","ja","zh-hant"],"default":"en"},"dateFormat":{"type":"string","nullable":false,"example":"MM/dd/yyyy"},"timezone":{"type":"string","nullable":false,"example":"America/Chicago"},"resultsPerPage":{"type":"integer","example":50,"default":100},"userInterfaceDisplayTheme":{"$ref":"#/components/schemas/AccountPreferencesUserInterfaceDisplayTheme"},"disableRelativeDates":{"type":"boolean","nullable":false,"example":false},"disablePageLeaveCheck":{"type":"boolean","nullable":false,"example":true},"disableTablePagination":{"type":"boolean","nullable":false,"example":true},"showDirectoryGroupUuidColumn":{"type":"boolean","nullable":false,"example":false},"disableShortcutsTooltips":{"type":"boolean","nullable":false,"example":true},"configProfilesSortingMethod":{"type":"string","nullable":false,"example":"ALPHABETICALLY"},"computerSearchMethod":{"$ref":"#/components/schemas/AccountPreferencesSearchType"},"computerApplicationSearchMethod":{"$ref":"#/components/schemas/AccountPreferencesSearchType"},"computerApplicationUsageSearchMethod":{"$ref":"#/components/schemas/AccountPreferencesSearchType"},"computerSoftwareUpdateSearchMethod":{"$ref":"#/components/schemas/AccountPreferencesSearchType"},"computerLocalUserAccountSearchMethod":{"$ref":"#/components/schemas/AccountPreferencesSearchType"},"computerPackageReceiptSearchMethod":{"$ref":"#/components/schemas/AccountPreferencesSearchType"},"computerPrinterSearchMethod":{"$ref":"#/components/schemas/AccountPreferencesSearchType"},"computerPeripheralSearchMethod":{"$ref":"#/components/schemas/AccountPreferencesSearchType"},"computerServiceSearchMethod":{"$ref":"#/components/schemas/AccountPreferencesSearchType"},"mobileDeviceSearchMethod":{"$ref":"#/components/schemas/AccountPreferencesSearchType"},"mobileDeviceAppSearchMethod":{"$ref":"#/components/schemas/AccountPreferencesSearchType"},"userSearchMethod":{"$ref":"#/components/schemas/AccountPreferencesSearchType"},"userAllContentSearchMethod":{"$ref":"#/components/schemas/AccountPreferencesSearchType"},"userMobileDeviceAppSearchMethod":{"$ref":"#/components/schemas/AccountPreferencesSearchType"},"userMacAppStoreAppSearchMethod":{"$ref":"#/components/schemas/AccountPreferencesSearchType"},"userEbookSearchMethod":{"$ref":"#/components/schemas/AccountPreferencesSearchType"}}},"AccountSettingsRequest":{"type":"object","properties":{"id":{"type":"string","description":"id of Account Settings","nullable":false,"example":"1"},"payloadConfigured":{"type":"boolean","nullable":false,"example":true,"default":false},"localAdminAccountEnabled":{"type":"boolean","nullable":false,"example":true,"default":false},"adminUsername":{"minLength":0,"type":"string","nullable":false,"example":"admin","default":""},"adminPassword":{"minLength":0,"type":"string","nullable":false,"writeOnly":true,"example":"password","default":""},"hiddenAdminAccount":{"type":"boolean","nullable":false,"example":false,"default":false},"localUserManaged":{"type":"boolean","nullable":false,"example":true,"default":false},"userAccountType":{"type":"string","nullable":false,"enum":["ADMINISTRATOR","STANDARD","SKIP"],"default":"STANDARD"},"versionLock":{"type":"integer","nullable":false,"example":4,"default":0},"prefillPrimaryAccountInfoFeatureEnabled":{"type":"boolean","nullable":false,"example":true,"default":false},"prefillType":{"type":"string","description":"Values accepted are only CUSTOM and DEVICE_OWNER","nullable":false,"example":"DEVICE_OWNER","default":"CUSTOM"},"prefillAccountFullName":{"minLength":0,"type":"string","nullable":false,"example":"TestUser FullName","default":""},"prefillAccountUserName":{"minLength":0,"type":"string","nullable":false,"example":"UserName","default":""},"preventPrefillInfoFromModification":{"type":"boolean","nullable":false,"example":false,"default":false}}},"AccountSettingsResponse":{"type":"object","properties":{"id":{"type":"string","description":"id of Account Settings","nullable":false,"example":"1"},"payloadConfigured":{"type":"boolean","nullable":false,"example":true,"default":false},"localAdminAccountEnabled":{"type":"boolean","nullable":false,"example":true,"default":false},"adminUsername":{"minLength":0,"type":"string","nullable":false,"example":"admin","default":""},"hiddenAdminAccount":{"type":"boolean","nullable":false,"example":false,"default":false},"localUserManaged":{"type":"boolean","nullable":false,"example":true,"default":false},"userAccountType":{"type":"string","nullable":false,"enum":["ADMINISTRATOR","STANDARD","SKIP"],"default":"STANDARD"},"versionLock":{"minimum":0,"type":"integer","nullable":false,"example":4,"default":0},"prefillPrimaryAccountInfoFeatureEnabled":{"type":"boolean","nullable":false,"example":true,"default":false},"prefillType":{"type":"string","description":"Values accepted are only CUSTOM and DEVICE_OWNER","nullable":false,"example":"DEVICE_OWNER","default":"CUSTOM"},"prefillAccountFullName":{"minLength":0,"type":"string","nullable":false,"example":"TestUser FullName","default":""},"prefillAccountUserName":{"minLength":0,"type":"string","nullable":false,"example":"UserName","default":""},"preventPrefillInfoFromModification":{"type":"boolean","nullable":false,"example":false,"default":false}}},"ActivationCode":{"required":["activationCode"],"type":"object","properties":{"activationCode":{"maxLength":39,"minLength":32,"type":"string","description":"Activation Code for Jamf Pro. Hyphens are optional.","example":"A1A1-B2B2-C3C3-D4D4-E5E5-F6F6-G7G7-H8H8"}}},"ActiveUserSession":{"type":"object","properties":{"username":{"type":"string","description":"Username of the logged in user","example":"john.smith"},"sessionId":{"type":"string","description":"Unique session identifier","example":"4F3B2E1A-8C9D-4E5F-A6B7-C8D9E0F1A2B3"},"lastAccessedTime":{"type":"string","description":"Timestamp of when the session was last accessed","format":"date-time","example":"2024-12-22T10:30:00Z"},"creationTime":{"type":"string","description":"Timestamp of when the session was created","format":"date-time","example":"2024-12-22T09:00:00Z"},"userAgent":{"type":"string","description":"User agent string from the session","nullable":true,"example":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)"},"ipAddress":{"type":"string","description":"IP address associated with the session","nullable":true,"example":"192.168.1.100"}}},"ActiveUsersCount":{"type":"object","properties":{"activeUserCount":{"minimum":0,"type":"integer","description":"Number of currently logged in users","format":"int32","example":5}}},"AdcsCertificate":{"required":["data","filename"],"type":"object","properties":{"filename":{"maxLength":255,"minLength":1,"type":"string","description":"Server certificate filename should extend .cer or .pem, and client certificate filename should extend .p12 or .pfx.","example":"example.cer"},"data":{"type":"array","description":"Must be base-64 encoded data obtainable by `openssl base64 < /file/path/filename.pfx | tr -d '\\n' | pbcopy` in linux terminal, or similar parsing methods.","example":"MIINvwIBAzCCDXsGSGDqGSIb3DQEHAaCCDWwEgg1oMIINZDCCBg8GCSqGSIb3DQEHAaCCBgAEggX8MIIF+DCCBfQGCyqGSIb3DQEMCgECoIIE/jCCBPowHAYKKoZIhvcNAQwBAzAOBAhIPjJB7Ls2fAICB9AEggTY3EKQVRtYWdwsisoMtXWIYJXvLTLm3WtBULqFdkVIXiMg0Y6cKtMdYHoLKEhyZwcsFxiUSfM4QkGpo4woshiwjFBEwc7Iu3waIGe5CVmAsZ9ynvqBirCfelmt5mLn6iU+AjR/xcYqwV2MJNO+lo8K3gVGDHvE0caJQB2blFioW7QOsGb+8GWpNNdWkbTHB6zH3XRB1lVm+9rsr1BF1l3lzEQOlc4P1nBtNumf2TVBoU6cM4lgiWA0as896nUilj1w9AAXiQcdhIT4zaaJFP4AnXqL94bDDlfceA60HNpzCYRIGOhohnxBtquUoDw6uHBnmo6PMkB2KkYNVoxk+/+egF3arCdjbj4OkWhZ/wzNGa0uHTA6nG8bNWRXULWZ/QfvQi424vKfuLSGQty1AP0VHOeoY4SkWvDz+gCEfP29C8vk4kWcnl/0dsE1wmmowuydJvL6WhGRAPii1y/BOJW0FTXav03o7SP5aYZXnr8qLKKUkmSziV1toY7YFl7lUCKYj5j/1I+5uaGlEqbjEsQs6GwL6S9M6ggpbGSBT4fp4xH1FSXeRoWbbVKuB3+Sin8lwP4ZrSTarufWpYCnnLNfYgTFiatpbP9u9BS4PaBVZTFygyvl4Gj4QtVMtZy39tRqiN82RkG61DiTeLFI0xXGqMctQLpOHU8Rn07tBZBKWI6U5wc2nDKWr60ohQPVEglt5MEqYgPuPcoUvj2GOG536pHR6HeWiX3nszv3KCNxOog8hkvs1JKoJuByhgzeUR6ylHTBOq+jNrbTJvzWGXEK6+I5rUmViITmMksumg96kUgP2ZPYzGbaJLt0lE1zD+rI05EWroZh4GQpcwfX8PQkbadR10MXbhnPe039TwhbgtDecxgNZQd0Fs4WTZqzpZOkUpcvWxHmPm1iSCd860EvNKwJos4kAlgE2tMtPpAiNqhxOzzgMiSFdxOnTV3khJ2xTL4J8UsObbn2K6qp9EhXcUUl+0Xn7C8+T4PIYkW4G5LNkIjv/3Df7VGjaTwk0rJtFwJh8k09BPA4ETNaxC/C7JFwkW9eJYtYi/UxStMSrVj1HGmnsG036C+IYDjKeUWvNK7QV2mq+Pas5WncgRU8BwgU5D2fLffRjtnP1UnnTkHsk9wocUqIaEpylIDnmUzA6mgM/4vfibF2BHDgkLjo5w2kgSjoSsRp7z23RudESgIyax21aWtmBZvDLTCn7KXGwXPELxLoU3lvOow7G8XTwAymaV/ymn6aQDp9tEwMHL0slRc3okRtAkHvhwUWpy7wXHup/aGhciA0fpkZhU1UECxGybhjPANsBzB9gUoBo2QWmKI7pjAovDWTbqHMylEi0Xumj+FxJgrdSHm9IbkX92ShJKLoD/flGfMS9pNVaqoCSsa66lPSCNqnDEF85/rr1vDBwDHSPChZri7748VWXxNzoCnbp2wYlRTUn8DOvuMDdO5W/tWnxmHgaiOxOKgoiRsl0Rm2N9E9sse5VLkXnQG4/Ybgzdq9xsxB9RdL5pnXsvBjCc+ruH3/XW4ufEq10PvdruBSz7jFqMfXJZ0APqNcRAm6UVsLSIqYbDuaDXMIJATUzy+EGVLdUcLfcMpWWxXgtUr+mJLvWTTlHTdoF57mJoY0XiFe2lz/xsumI0CgA2z0AyUmvDGB4jANBgkrBgEEAYI3EQIxADATBgkqhkiG9w0BCRUxBgQEAQAAADBdBgkqhkiG9w0BCRQxUB5OAHQAZQAtADEANgAxADMANgAxADQANAAtADYAMQA4ADQALQA0ADYAYwAwAC0AOAA3ADIAMgAtAGEAZQBmADgAMgBkADkANABmAGUAZgBkMF0GCSsGAQQBgjcRATFQHk4ATQBpAGMAcgBvAHMAbwBmAHQAIABTAG8AZgB0AHcAYQByAGUAIABLAGUAeQAgAFMAdABvAHIAYQBnAGUAIABQAHIAbwB2AGkAZABlAHIwggdNBgkqhkiG9w0BBwGgggc+BIIHOjCCBzYwggODBgsqhkiG9w0BDAoBA6CCA3AwggNsBgoqhkiG9w0BCRYBoIIDXASCA1gwggNUMIICPKADAgECAhBQpWSN5vK+pExY7iCTjMhhMA0GCSqGSIb3DQEBCwUAMCgxJjAkBgNVBAMMHWt0bnN2bS13aW4yMDE2LmVuemlhbnRlY2guY29tMB4XDTIyMDMxNTEyMjAwM1oXDTMyMDMxNTEyMjk1OFowKDEmMCQGA1UEAwwda3Ruc3ZtLXdpbjIwMTYuZW56aWFudGVjaC5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCh2WEjlnlY37yMtBhNY/2q/Mgx7hSJMpb9sK4HY/RufB0olyVwA4sKG0+ER9wnC+brkT8CDamnzeC+x5OynZ8QaP7m0tQSLCJrfJ9EapUSgD/TZv7Y+qXnVhI5sSpKXMt0g8SCQEzvS5dsLylw6VENlhvEUSFlfjcZbrCsHQgqEahaPlxz2MG35UUkBSwarTK243wtDvSXiBhmAeWQvNDJqpUlLxKNmvAWSzjfpOdEM+iRHf3Nph2wqSSOS61XUJ55fC0UIAMjzGlEYpJrd73PJTyly5ZQGErDwgyLW/Qti65jgRLg8cMNDqBSTwQwo00SvM54EFOmrQP9nq/SrlkXAgMBAAGjejB4MA4GA1UdDwEB/wQEAwIBtjAdBgNVHSUEFjAUBggrBgEFBQcDAgYIKwYBBQUHAwEwKAYDVR0RBCEwH4Ida3Ruc3ZtLXdpbjIwMTYuZW56aWFudGVjaC5jb20wHQYDVR0OBBYEFD6G+I03qqd9Rd1UCSMy8WxzthG7MA0GCSqGSIb3DQEBCwUAA4IBAQBN5NrClbxY4AdOVSbD319s9ApGwzhA7VH2r73Qi07UtQslLUWHjN6D78ZU/rlqYRsF4yOI3Zxcp7KV9rfOVigJPNUPU9wQe0aPnPUy4qEGd0HJpXmmj8t17l/+gtV6I0Vs0de+OY1PkjfcvFLMOfjAzbG2VxPCm0kL1Jd86b60t/iiaE2l0fxn7UfVetpRZLNZV1X9fwB+raUqN2ILhsS7bFwj3PDpzMw/9qLj/hiE6+9QksSpDhkIJDjU48GiGtkidRoATK+paO0xso3nPLNi5s+CY5NprFeqizymTzOX8DJcjtINTU2CL41k7G0r/stv1YgBQDB7Rwg6bxyTfN68MQAwggOrBgsqhkiG9w0BDAoBA6CCA4MwggN/BgoqhkiG9w0BCRYBoIIDbwSCA2swggNnMIICT6ADAgECAhAaVZcv8KdtjUbjDGvLd3toMA0GCSqGSIb3DQEBCwUAMCgxJjAkBgNVBAMMHWt0bnN2bS13aW4yMDE2LmVuemlhbnRlY2guY29tMB4XDTIyMDMxNTEyMjAwM1oXDTMyMDMxNTEyMzAwM1owIDEeMBwGA1UEAwwVaDY4aGNnLnF1aWNrLmphbWYubmV0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAvBD1C4tR8vWZeSDdQ6AhynzMB47plvkqrXnmhcavlsDnu8Zfanr6gjUND0NK2Ufm0BBhH86kIcYMwehLYVNNfC3RTCT+QLo3wIn7VxUnsAPTqD23QjNwYnDTBQDkBrQIrFYaPc0RxO0MYexg/EqgEiAF1nJAZ3tndev1LBSEO5iN+8patoyV7jE3JlgF9qN0T0XCELrRpEi/pxKaVpAupXp38NBWVAJ6yqWuTCP2gcvnvo8KHHUTpJhwUcxr1aKUjX0LBnJ/mStQ8Cfckr7sLaHXyt4ei5uiQID69d/6JNoqpfoWW0EcHW8V3fiLX5fzsMBGjmRa/R8//zVM/ebpSwIDAQABo4GUMIGRMA4GA1UdDwEB/wQEAwIEsDAdBgNVHSUEFjAUBggrBgEFBQcDAgYIKwYBBQUHAwEwIAYDVR0RBBkwF4IVaDY4aGNnLnF1aWNrLmphbWYubmV0MB8GA1UdIwQYMBaAFD6G+I03qqd9Rd1UCSMy8WxzthG7MB0GA1UdDgQWBBT1Gk6lWWBdrF1z7n/FMgxT5Hb5YjANBgkqhkiG9w0BAQsFAAOCAQEAj0UtZ118booksRr7kDg47IhlhSlkhZVnZfkRUHY2QSYBkHNyilcb9rWJIAzrSI5q+RV+FDXDEc0at9CmH2yIb+dYSojxj1ebSCloZb5QiHfAZTFN5+AicESWb0PMGiiz1HeU8Bm2bjHIRx4OLKSm4agMck/6iBDJhduiidrEZkmz8MRFr04GE/9MAg3JG149JeCSS54seKx7tBx+dJjzHJg2HeqZtOKjaKLOnstquEVhwgGXIqH51lQd5SOfYJH1cQyi6xe7SBZ5YYYF1iubhMUqvYnbugskm35nYWk9XObw4QRnfTQNIuW6p1cz2Nk+yaDheraycaxbBGYaXMgIJzEVMBMGCSqGSIb3DQEJFTEGBAQBAAAAMDswHzAHBgUrDgMCGgQUA/Hryi7gjlbKpKpGVlTvAnjevyAEFFhGKjlcFPkz5+bUOnz1OcWq/3zPAgIH0A==","items":{"type":"string","format":"byte"}},"password":{"maxLength":255,"minLength":1,"type":"string","format":"password","nullable":true,"writeOnly":true,"example":"password-example"}}},"AdcsCertificateResponse":{"type":"object","properties":{"filename":{"maxLength":255,"type":"string","description":"Server certificate filename should extend .cer or .pem, and client certificate filename should extend .p12 or .pfx.","readOnly":true,"example":"example.cer"},"serialNumber":{"type":"string","readOnly":true,"example":"123456789456123"},"subject":{"type":"string","readOnly":true,"example":"CN=SubjectName, OU=OrganizationalUnit, O=Organization, L=Location, ST=State, C=Country"},"issuer":{"type":"string","readOnly":true,"example":"IssuerName"},"expirationDate":{"type":"string","format":"date-time","readOnly":true,"example":"2018-10-15T16:39:56Z"}}},"AdcsDependencies":{"type":"object","properties":{"totalCount":{"type":"integer","nullable":false,"example":1},"results":{"type":"array","items":{"$ref":"#/components/schemas/AdcsDependency"}}}},"AdcsDependency":{"type":"object","properties":{"configProfileId":{"type":"integer","nullable":false,"example":1},"configProfileName":{"type":"string","example":"name"},"configProfileType":{"type":"string","nullable":false,"readOnly":true,"example":"OSX_CONFIGURATION_PROFILE","enum":["OSX_CONFIGURATION_PROFILE","IOS_CONFIGURATION_PROFILE"]}}},"AdcsSettings":{"type":"object","properties":{"displayName":{"maxLength":255,"minLength":1,"type":"string","example":"Example Display Name"},"caName":{"maxLength":255,"minLength":1,"type":"string","example":"EXAMPLE-SUBCA02-CA"},"fqdn":{"maxLength":255,"minLength":1,"type":"string","example":"example-subca02.example.com"},"adcsUrl":{"maxLength":255,"minLength":1,"type":"string","example":"https://<host-name>.example.com"},"serverCert":{"$ref":"#/components/schemas/AdcsCertificate"},"clientCert":{"$ref":"#/components/schemas/AdcsCertificate"},"revocationEnabled":{"type":"boolean","example":true},"apiClientId":{"type":"string","example":"A11B43D6-9ED4-4B29-B726-E2DE747D2410"},"outbound":{"type":"boolean","example":true}},"description":"AD CS Settings object to create, or update with a merge-patch strategy. Certificate data must be provided in full, or not at all for update with merge-patch strategy."},"AdcsSettingsResponse":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"1"},"displayName":{"maxLength":255,"minLength":1,"type":"string","readOnly":true,"example":"Example Display Name"},"caName":{"maxLength":255,"minLength":1,"type":"string","readOnly":true,"example":"EXAMPLE-SUBCA02-CA"},"fqdn":{"maxLength":255,"minLength":1,"type":"string","readOnly":true,"example":"example-subca02.example.com"},"adcsUrl":{"maxLength":255,"minLength":1,"type":"string","readOnly":true,"example":"https://<host-name>.example.com"},"serverCert":{"$ref":"#/components/schemas/AdcsCertificateResponse"},"clientCert":{"$ref":"#/components/schemas/AdcsCertificateResponse"},"revocationEnabled":{"type":"boolean","readOnly":true,"example":true},"apiClientId":{"type":"string","readOnly":true,"example":"A11B43D6-9ED4-4B29-B726-E2DE747D2410"},"outbound":{"type":"boolean","readOnly":true,"example":true},"connectorLastCheckInTimestamp":{"type":"string","format":"date-time","readOnly":true,"example":"2018-10-15T16:39:56Z"}}},"AdvancedSearch":{"required":["name"],"type":"object","properties":{"id":{"minLength":1,"type":"string","readOnly":true,"example":"1"},"name":{"type":"string","example":"Andy's Search"},"criteria":{"type":"array","items":{"$ref":"#/components/schemas/SmartSearchCriterion"}},"displayFields":{"type":"array","example":["AirPlay Password","App Analytics Enabled"],"items":{"type":"string"}},"siteId":{"type":"string","nullable":true,"example":"-1"}}},"AdvancedSearchCriteriaChoices":{"type":"object","properties":{"choices":{"type":"array","example":["Option 1","Option 2"],"items":{"type":"string"}}}},"AdvancedSearchSearchResults":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":3},"results":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/AdvancedSearch"}}}},"AdvancedUserContentSearch":{"required":["name"],"type":"object","properties":{"id":{"minLength":1,"type":"string","readOnly":true,"example":"1"},"name":{"type":"string","example":"Andy's Search"},"criteria":{"type":"array","items":{"$ref":"#/components/schemas/SmartSearchCriterion"}},"displayFields":{"type":"array","example":["Content Name","Price"],"items":{"type":"string"}},"siteId":{"type":"string","nullable":true,"example":"-1"}}},"AdvancedUserContentSearchSearchResults":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":3},"results":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/AdvancedUserContentSearch"}}}},"ApiError":{"type":"object","properties":{"httpStatus":{"type":"integer","description":"HTTP status of the response","example":400},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiErrorCause"}}}},"ApiErrorCause":{"required":["field"],"type":"object","properties":{"code":{"type":"string","description":"Error-specific code that can be used to identify localization string, etc.","example":"8675309"},"field":{"type":"string","description":"Name of the field that caused the error.","example":"Name"},"description":{"type":"string","description":"A general description of error for troubleshooting/debugging. Generally this text should not be displayed to a user; instead refer to errorCode and it's localized text","example":"I've just picked up a fault in the AE35 unit. It's going to go 100% failure in 72 hours"},"id":{"type":"string","description":"id of object with error. Optional.","nullable":true,"example":"3"}}},"ApiIntegrationRequest":{"required":["authorizationScopes","displayName"],"type":"object","properties":{"authorizationScopes":{"type":"array","description":"API Role display names.\n","example":["Tootsie Roal","Jamf Reset"],"items":{"type":"string"}},"displayName":{"type":"string","example":"My API Integration"},"enabled":{"type":"boolean","example":true},"accessTokenLifetimeSeconds":{"type":"integer","example":300}}},"ApiIntegrationResponse":{"required":["appType","authorizationScopes","clientId","displayName","enabled","id"],"type":"object","properties":{"id":{"type":"integer","example":1},"authorizationScopes":{"type":"array","example":["Tootsie Roal","Jamf Reset"],"items":{"type":"string"}},"displayName":{"type":"string","example":"My API Integration"},"enabled":{"type":"boolean","example":true},"accessTokenLifetimeSeconds":{"type":"integer","example":300},"appType":{"type":"string","description":"Type of API Client:\n    * `CLIENT_CREDENTIALS` - A client ID and secret have been generated for this integration.\n    * `NATIVE_APP_OAUTH` - A native app (i.e., Jamf Reset) has been linked to this integration for auth code grant type via Managed App Config.\n    * `NONE` - No client is currently associated with this integration.\n","readOnly":true,"example":"CLIENT_CREDENTIALS","enum":["CLIENT_CREDENTIALS","NATIVE_APP_OAUTH","NONE"]},"clientId":{"type":"string","readOnly":true,"example":"538878d4-9744-43ed-8732-3df99d502bd6"}}},"ApiIntegrationSearchResult":{"required":["results","totalCount"],"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","readOnly":true,"example":1},"results":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/ApiIntegrationResponse"}}}},"ApiRole":{"required":["displayName","id","privileges"],"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"1"},"displayName":{"type":"string","example":"One Role to Rule them all"},"privileges":{"minItems":0,"type":"array","items":{"type":"string","example":"View License Serial Numbers"}}}},"ApiRolePrivileges":{"required":["privileges"],"type":"object","properties":{"privileges":{"minItems":0,"type":"array","items":{"type":"string","example":"Flush MDM Commands"}}}},"ApiRoleRequest":{"required":["displayName","privileges"],"type":"object","properties":{"displayName":{"type":"string","example":"One Role to Rule them all"},"privileges":{"minItems":0,"type":"array","items":{"type":"string","example":"View License Serial Numbers"}}}},"ApiRoleResult":{"required":["results","totalCount"],"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","readOnly":true,"example":1},"results":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/ApiRole"}}}},"ApnsClientPushStatus":{"type":"object","properties":{"deviceType":{"type":"string","description":"The type of MDM client device","nullable":false,"example":"MOBILE_DEVICE","enum":["MOBILE_DEVICE","MOBILE_DEVICE_USER","COMPUTER","COMPUTER_USER","TV","WATCH","VISION_PRO","UNKNOWN"]},"clientId":{"type":"string","description":"Id of the Computer or Device record in Jamf Pro","nullable":false,"example":"55"},"disabledAt":{"type":"string","description":"Timestamp when push notifications were disabled for this client (ISO-8601 format)","format":"date-time","nullable":false,"example":"2024-11-06T14:30:00Z"},"managementId":{"type":"string","description":"Unique identifier for the device management record","nullable":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"}},"description":"Information about a client with push notifications disabled"},"ApnsClientPushStatusSearchResults":{"required":["results","totalCount"],"type":"object","properties":{"totalCount":{"type":"integer","description":"Total number of records matching the query","format":"int64","example":42},"results":{"type":"array","description":"Array of APNS client push status records","items":{"$ref":"#/components/schemas/ApnsClientPushStatus"}}},"description":"Search results containing APNS client push status records"},"ApnsPushEnableRequest":{"type":"object","properties":{"requestedTime":{"type":"string","description":"Timestamp when the request was created (ISO-8601 format)","format":"date-time","example":"2024-11-06T14:30:00Z"},"status":{"type":"string","description":"Current status of the request","example":"QUEUED","enum":["QUEUED","STARTED","COMPLETED"]},"processedTime":{"type":"string","description":"Timestamp when the request was processed (ISO-8601 format), null if not yet processed","format":"date-time","nullable":true,"example":"2024-11-06T15:30:00Z"}},"description":"Status information for an enable all clients push request"},"AppAnalyticsSetting":{"type":"string","example":"ENABLE_APP_ANALYTICS","enum":["ENABLE_APP_ANALYTICS","DISABLE_APP_ANALYTICS"]},"AppConfigReinstallCode":{"type":"object","properties":{"reinstallCode":{"type":"string","example":"975767FE-074E-4F42-BB8B-925B1627CA6F"}}},"AppPath":{"required":["id","path"],"type":"object","properties":{"id":{"type":"string","description":"A \"-1\" id indicates a built-in path that cannot be deleted or modified.","example":"1"},"path":{"type":"string","example":"/Example/Path/To/App/"}}},"AppRequestFormInputField":{"required":["priority","title"],"type":"object","properties":{"id":{"type":"integer","readOnly":true,"example":1},"title":{"minLength":1,"type":"string","example":"Quantity"},"description":{"type":"string","nullable":true,"example":"How many of these would you like?"},"priority":{"maximum":255,"minimum":1,"type":"integer","description":"Highest priority is 1, lowest is 255","example":1}}},"AppRequestFormInputFieldSearchResults":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":3},"results":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/AppRequestFormInputField"}}}},"AppRequestSettings":{"type":"object","properties":{"isEnabled":{"type":"boolean","example":true},"appStoreLocale":{"type":"string","description":"Can be any of the country codes from /v1/app-store-country-codes or \"deviceLocale\" to use each individual device's locale","example":"deviceLocale"},"requesterUserGroupId":{"type":"integer","example":1},"approverEmails":{"type":"array","items":{"type":"string","example":"jane.doe@company.com, john.doe@company.com"}}}},"ApplicationAttributes":{"type":"object","properties":{"identifier":{"type":"string","nullable":true,"example":"com.jamf.selfservice"},"attributes":{"$ref":"#/components/schemas/Attributes"}}},"ApplicationConfiguration":{"type":"object","properties":{"configuration":{"type":"string","nullable":true,"example":"<plist><dict><key>Key</key><string>Value</string></dict></plist>"},"identifier":{"type":"string","example":"com.jamf.selfservice"}}},"ApplyRedemptionCodeCommand":{"allOf":[{"$ref":"#/components/schemas/MdmCommandBase"},{"type":"object","properties":{"identifier":{"type":"string","description":"The bundle identifier of the app","example":"com.example.app"},"redemptionCode":{"type":"string","description":"The redemption code that applies to the app pending installation","example":"SB56LT7YX8RH"}}}]},"AssignRemoveProfileResponseSyncState":{"type":"object","properties":{"id":{"type":"integer","example":1},"serialNumber":{"type":"string","example":"R7QFDE2YCFN4"},"profileUUID":{"type":"string","example":"9164E5F7C74C2A4C4BE90BB15E549F14"},"syncStatus":{"type":"string","example":"ASSIGN_SUCCESS"},"failureCount":{"type":"integer","example":0},"timestamp":{"type":"integer","example":1583855813080}}},"Assignment":{"type":"object","properties":{"mobileDeviceId":{"type":"string","example":"5"},"selected":{"type":"boolean","description":"If true the device should be added to the group, if false should be removed from the group","example":true}}},"AssignmentDtoV1":{"required":["deviceId","selected"],"type":"object","properties":{"deviceId":{"maxLength":50,"minLength":1,"type":"string","example":"56585788-8937-4bdf-b986-458048b1c36c"},"selected":{"type":"boolean","example":true}}},"Attributes":{"type":"object","properties":{"vpnUuid":{"type":"string","nullable":true,"example":"aaaaaaaa-3f1e-4b3a-a5b3-ca0cd7430937"},"associatedDomains":{"type":"array","items":{"type":"string","example":"jamf.com"}},"removable":{"type":"boolean","example":true},"enableDirectDownloads":{"type":"boolean","example":true},"contentFilterUuid":{"type":"string","example":"b7e6a1d2-4b3a-4c5a-8b3a-ca0cd7430937"},"dnsProxyUuid":{"type":"string","example":"e2a1f5b4-3c6d-4e8a-9b3a-1a2b3c4d5e6f"},"cellularSliceUuid":{"type":"string","example":"f3b2c6d7-4e8a-9b3a-1a2b3c4d5e6f"},"relayUuid":{"type":"string","example":"d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f9a"},"tapToPayScreenLock":{"type":"boolean","example":true},"hideable":{"type":"boolean","example":true},"lockable":{"type":"boolean","example":true}}},"AuthAccount":{"type":"object","properties":{"id":{"minimum":1,"type":"integer","example":1},"username":{"type":"string","example":"admin"},"realName":{"type":"string","example":"IT Bob"},"email":{"type":"string","example":"ITBob@Jamf.com"},"preferences":{"$ref":"#/components/schemas/AccountPreferences"},"isMultiSiteAdmin":{"type":"boolean","example":true},"accessLevel":{"type":"string","example":"FullAccess","enum":["FullAccess","SiteAccess","GroupBasedAccess"]},"privilegeSet":{"type":"string","example":"CUSTOM","enum":["ADMINISTRATOR","AUDITOR","ENROLLMENT","CUSTOM"]},"privilegesBySite":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"example":{"1":["Read SSO Settings","Delete eBooks"]}},"groupIds":{"type":"array","example":[1,3],"items":{"type":"integer"}},"currentSiteId":{"type":"integer","example":1}}},"AuthAccountV1":{"type":"object","properties":{"id":{"minLength":1,"type":"string","example":"1"},"username":{"type":"string","example":"admin"},"realName":{"type":"string","example":"IT Bob"},"email":{"type":"string","example":"ITBob@Jamf.com"},"preferences":{"$ref":"#/components/schemas/AccountPreferencesV1"},"multiSiteAdmin":{"type":"boolean","example":true},"accessLevel":{"type":"string","example":"FullAccess","enum":["FullAccess","SiteAccess","GroupBasedAccess"]},"privilegeSet":{"type":"string","example":"CUSTOM","enum":["ADMINISTRATOR","AUDITOR","ENROLLMENT","CUSTOM"]},"privilegesBySite":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"example":{"1":["Read SSO Settings","Delete eBooks"]}},"groupIds":{"type":"array","example":[1,3],"items":{"type":"string"}},"currentSiteId":{"type":"string","example":"1"},"currentDivisionId":{"type":"string","description":"Platform division identifier (UUID) for the user's current site","nullable":true,"example":"550e8400-e29b-41d4-a716-446655440000"}}},"AuthToken":{"type":"object","properties":{"token":{"type":"string","nullable":false,"example":"eyJhbGciOiJIUzUxMiJ9.eyJhdXRoZW50aWNhdGVkLWFwcCI6IkdFTkVSSUMiLCJhdXRoZW50aWNhdGlvbi10eXBlIjoiSlNTIiwiZ3JvdXBzIjpbXSwic3ViamVjdC10eXBlIjoiSlNTX1VTRVJfSUQiLCJ0b2tlbi11dWlkIjoiNzc0YWY3MGYtYWQ0Yy00N2QzLTk2MzktZjEwMjBhMTIwYzExIiwibGRhcC1zZXJ2ZXItaWQiOi0xLCJzdWIiOiIxIiwiZXhwIjoxNTM5NjE5MzQ4fQ.0t7sgYyIyA7kTTmrM8tMGE7fnXcJ1ZzQODAJp0pzg92-cBMQS0Cv8S9oWjkJD7VJS-CHA1dOppr0G_2dCPOfng"},"expires":{"type":"integer","example":1539619348124}}},"AuthTokenV1":{"type":"object","properties":{"token":{"type":"string","nullable":false,"example":"eyJhbGciOiJIUzUxMiJ9.eyJhdXRoZW50aWNhdGVkLWFwcCI6IkdFTkVSSUMiLCJhdXRoZW50aWNhdGlvbi10eXBlIjoiSlNTIiwiZ3JvdXBzIjpbXSwic3ViamVjdC10eXBlIjoiSlNTX1VTRVJfSUQiLCJ0b2tlbi11dWlkIjoiNzc0YWY3MGYtYWQ0Yy00N2QzLTk2MzktZjEwMjBhMTIwYzExIiwibGRhcC1zZXJ2ZXItaWQiOi0xLCJzdWIiOiIxIiwiZXhwIjoxNTM5NjE5MzQ4fQ.0t7sgYyIyA7kTTmrM8tMGE7fnXcJ1ZzQODAJp0pzg92-cBMQS0Cv8S9oWjkJD7VJS-CHA1dOppr0G_2dCPOfng"},"expires":{"type":"string","example":"2020-04-21T21:09:31.626Z"}}},"AuthenticationType":{"type":"string","example":"JSS","enum":["JSS","LDAP","SAML","INVITE","NATIVE_APP_API_INTEGRATION","DEVICE_SIGNATURE","CLOUD_CONNECTOR","SYSTEM_ACCOUNT","USER_ENROLLMENT","CLIENT_CREDENTIALS","OIDC","M2M"]},"Authorization":{"type":"object","properties":{"account":{"$ref":"#/components/schemas/AuthAccount"},"accountGroups":{"type":"array","items":{"$ref":"#/components/schemas/AccountGroup"}},"sites":{"type":"array","items":{"$ref":"#/components/schemas/Site"}},"authenticationType":{"$ref":"#/components/schemas/AuthenticationType"}}},"AuthorizationV1":{"type":"object","properties":{"account":{"$ref":"#/components/schemas/AuthAccountV1"},"accountGroups":{"type":"array","items":{"$ref":"#/components/schemas/AccountGroup"}},"sites":{"type":"array","items":{"$ref":"#/components/schemas/V1SiteBase"}},"authenticationType":{"$ref":"#/components/schemas/AuthenticationType"}}},"AvailableOsUpdates":{"type":"object","properties":{"availableUpdates":{"type":"object","properties":{"macOS":{"type":"array","example":["12.0.1","11.6.1","11.6","11.5.2"],"items":{"type":"string"}},"iOS":{"type":"array","example":["16.1.1","16.0.1","15.7.1","9.1"],"items":{"type":"string"}}},"nullable":false}}},"AvailableUpdates":{"type":"object","properties":{"availableUpdates":{"type":"array","example":["12.0.1","11.6.1","11.6","11.5.2"],"items":{"type":"string"}}}},"AzureConfiguration":{"required":["cloudIdPCommon","server"],"type":"object","properties":{"cloudIdPCommon":{"$ref":"#/components/schemas/CloudIdPCommon"},"server":{"$ref":"#/components/schemas/AzureServerConfiguration"}},"description":"A Cloud Identity Provider Azure configuration for responses"},"AzureConfigurationRequest":{"required":["cloudIdPCommon","server"],"type":"object","properties":{"cloudIdPCommon":{"$ref":"#/components/schemas/CloudIdPCommonRequest"},"server":{"$ref":"#/components/schemas/AzureServerConfigurationRequest"}},"description":"A Cloud Identity Provider Azure configuration for responses"},"AzureConfigurationUpdate":{"required":["cloudIdPCommon","server"],"type":"object","properties":{"cloudIdPCommon":{"$ref":"#/components/schemas/CloudIdPCommon"},"server":{"$ref":"#/components/schemas/AzureServerConfigurationUpdate"}},"description":"A Cloud Identity Provider Azure configuration for update"},"AzureMappings":{"required":["building","department","email","groupId","groupName","phone","position","realName","room","userId","userName"],"type":"object","properties":{"userId":{"type":"string","example":"id"},"userName":{"type":"string","example":"userPrincipalName"},"realName":{"type":"string","example":"displayName"},"email":{"type":"string","example":"mail"},"department":{"type":"string","example":"department"},"building":{"type":"string","example":"companyName"},"room":{"type":"string","example":"officeLocation"},"phone":{"type":"string","example":"mobilePhone"},"position":{"type":"string","example":"jobTitle"},"groupId":{"type":"string","example":"id"},"groupName":{"type":"string","example":"displayName"}},"description":"Azure Cloud Identity Provider mappings"},"AzureServerConfiguration":{"required":["deprecatedConsent","enabled","id","mappings","migrated","searchTimeout","tenantId","transitiveDirectoryMembershipEnabled","transitiveMembershipEnabled","transitiveMembershipUserField"],"type":"object","properties":{"id":{"type":"string","example":"1001"},"tenantId":{"type":"string","example":"db65d325-0350-4a17-9af9-b302d0fc386b"},"enabled":{"type":"boolean","example":true},"deprecatedConsent":{"type":"boolean","example":true},"migrated":{"type":"boolean","example":true},"mappings":{"$ref":"#/components/schemas/AzureMappings"},"searchTimeout":{"maximum":600,"minimum":5,"type":"integer","example":30},"transitiveMembershipEnabled":{"type":"boolean","description":"Use this field to enable transitive membership lookup with Single Sign On","example":false},"transitiveMembershipUserField":{"type":"string","description":"Use this field to set user field mapping for transitive membership lookup with Single Sign On","example":"userPrincipalName"},"transitiveDirectoryMembershipEnabled":{"type":"boolean","description":"Use this field to enable transitive membership lookup. This setting would not apply to Single Sign On","example":false},"membershipCalculationOptimizationEnabled":{"type":"boolean","description":"Use this field to enable membership calculation optimization. This setting would not apply to Single Sign On","example":true},"type":{"type":"string","description":"Type of Entra ID connection","example":"PUBLIC","enum":["PUBLIC","GCC_HIGH"]}},"description":"Azure Cloud Identity Provider configuration"},"AzureServerConfigurationRequest":{"required":["code","enabled","mappings","searchTimeout","tenantId","transitiveDirectoryMembershipEnabled","transitiveMembershipEnabled","transitiveMembershipUserField"],"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"1001"},"tenantId":{"type":"string","example":"db65d325-0350-4a17-9af9-b302d0fc386b"},"enabled":{"type":"boolean","example":true},"mappings":{"$ref":"#/components/schemas/AzureMappings"},"searchTimeout":{"maximum":600,"minimum":5,"type":"integer","example":30},"transitiveMembershipEnabled":{"type":"boolean","description":"Use this field to enable transitive membership lookup with Single Sign On","example":false},"transitiveMembershipUserField":{"type":"string","description":"Use this field to set user field mapping for transitive membership lookup with Single Sign On","example":"userPrincipalName"},"transitiveDirectoryMembershipEnabled":{"type":"boolean","description":"Use this field to enable transitive membership lookup. This setting would not apply to Single Sign On","example":false},"membershipCalculationOptimizationEnabled":{"type":"boolean","description":"Use this field to enable membership calculation optimization. This setting would not apply to Single Sign On","example":true},"code":{"type":"string","example":"auth"},"type":{"type":"string","description":"Type of Entra ID connection","example":"PUBLIC","enum":["PUBLIC","GCC_HIGH"]}},"description":"Azure Cloud Identity Provider configuration request"},"AzureServerConfigurationUpdate":{"required":["enabled","id","mappings","searchTimeout","transitiveDirectoryMembershipEnabled","transitiveMembershipEnabled","transitiveMembershipUserField"],"type":"object","properties":{"id":{"type":"string","example":"1001"},"enabled":{"type":"boolean","example":true},"mappings":{"$ref":"#/components/schemas/AzureMappings"},"searchTimeout":{"maximum":600,"minimum":5,"type":"integer","example":30},"transitiveMembershipEnabled":{"type":"boolean","description":"Use this field to enable transitive membership lookup with Single Sign On","example":false},"transitiveMembershipUserField":{"type":"string","description":"Use this field to set user field mapping for transitive membership lookup with Single Sign On","example":"userPrincipalName"},"transitiveDirectoryMembershipEnabled":{"type":"boolean","description":"Use this field to enable transitive membership lookup. This setting would not apply to Single Sign On","example":false},"membershipCalculationOptimizationEnabled":{"type":"boolean","description":"Use this field to enable membership calculation optimization. This setting would not apply to Single Sign On","example":true}},"description":"Azure Cloud Identity Provider configuration update"},"BlankPushRequest":{"required":["clientManagementIds"],"type":"object","properties":{"clientManagementIds":{"type":"array","example":["fd68c371-5921-436e-b16b-8a3c1bf90ee5","a1b2c3d4-5678-90ab-cdef-1234567890ab"],"items":{"type":"string"}}}},"BlankPushResponse":{"required":["errorUuids"],"type":"object","properties":{"errorUuids":{"type":"array","example":["a1b2c3d4-5678-90ab-cdef-1234567890ab","fd68c371-5921-436e-b16b-8a3c1bf90ee5"],"items":{"type":"string"}}}},"BrandingImageUrl":{"type":"object","properties":{"url":{"type":"string","example":"https://jamfpro.jamf/image?1"}}},"Building":{"required":["name"],"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"1"},"name":{"type":"string","example":"Apple Park"},"streetAddress1":{"type":"string","nullable":true,"example":"The McIntosh Tree"},"streetAddress2":{"type":"string","nullable":true,"example":"One Apple Park Way"},"city":{"type":"string","nullable":true,"example":"Cupertino"},"stateProvince":{"type":"string","nullable":true,"example":"California"},"zipPostalCode":{"type":"string","nullable":true,"example":"95014"},"country":{"type":"string","nullable":true,"example":"The United States of America"}}},"BuildingSearchResults":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":3},"results":{"type":"array","items":{"$ref":"#/components/schemas/Building"}}}},"CacheSettings":{"required":["cacheType","cacheUniqueId","memcachedEndpoints","timeToLiveSeconds"],"type":"object","properties":{"id":{"minLength":1,"type":"string","readOnly":true,"default":"0"},"name":{"type":"string","default":"cache configuration"},"cacheType":{"type":"string","example":"ehcache"},"timeToLiveSeconds":{"type":"integer","format":"int32","example":120},"timeToIdleSeconds":{"type":"integer","format":"int32","example":120},"directoryTimeToLiveSeconds":{"type":"integer","format":"int32","example":120},"ehcacheMaxBytesLocalHeap":{"type":"string","default":"null"},"cacheUniqueId":{"type":"string","description":"The default is for Jamf Pro to generate a UUID, so we can only give an example instead.","example":"24864549-94ea-4cc1-bb80-d7fb392c6556"},"elasticache":{"type":"boolean","default":false},"memcachedEndpoints":{"type":"array","example":[],"items":{"$ref":"#/components/schemas/MemcachedEndpoints"}}}},"CancelEnhancedLogCollectionCommand":{"allOf":[{"$ref":"#/components/schemas/MdmCommandBase"},{"type":"object"}]},"CategoriesSearchResults":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":3},"results":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/Category"}}}},"Category":{"required":["name","priority"],"type":"object","properties":{"id":{"minLength":1,"type":"string","readOnly":true,"example":"1"},"name":{"type":"string","example":"The Best"},"priority":{"type":"integer","format":"int32","example":9}}},"CeaTemplatesResults":{"required":["totalCount"],"type":"object","properties":{"totalCount":{"type":"integer","example":1},"results":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/ComputerExtensionAttributeTemplates"}}}},"Certificate":{"required":["data","filename"],"type":"object","properties":{"filename":{"maxLength":255,"minLength":1,"type":"string","description":"Client certificate filename should extend .p12.","example":"example.p12"},"data":{"type":"array","description":"Must be base-64 encoded data obtainable by `openssl base64 < /file/path/filename.p12 | tr -d '\\n' | pbcopy` in linux terminal, or similar parsing methods.","example":"MIINvwIBAzCCDXsGSGDqGSIb3DQEHAaCCDWwEgg1oMIINZDCCBg8GCSqGSIb3DQEHAaCCBgAEggX8MIIF+DCCBfQGCyqGSIb3DQEMCgECoIIE/jCCBPowHAYKKoZIhvcNAQwBAzAOBAhIPjJB7Ls2fAICB9AEggTY3EKQVRtYWdwsisoMtXWIYJXvLTLm3WtBULqFdkVIXiMg0Y6cKtMdYHoLKEhyZwcsFxiUSfM4QkGpo4woshiwjFBEwc7Iu3waIGe5CVmAsZ9ynvqBirCfelmt5mLn6iU+AjR/xcYqwV2MJNO+lo8K3gVGDHvE0caJQB2blFioW7QOsGb+8GWpNNdWkbTHB6zH3XRB1lVm+9rsr1BF1l3lzEQOlc4P1nBtNumf2TVBoU6cM4lgiWA0as896nUilj1w9AAXiQcdhIT4zaaJFP4AnXqL94bDDlfceA60HNpzCYRIGOhohnxBtquUoDw6uHBnmo6PMkB2KkYNVoxk+/+egF3arCdjbj4OkWhZ/wzNGa0uHTA6nG8bNWRXULWZ/QfvQi424vKfuLSGQty1AP0VHOeoY4SkWvDz+gCEfP29C8vk4kWcnl/0dsE1wmmowuydJvL6WhGRAPii1y/BOJW0FTXav03o7SP5aYZXnr8qLKKUkmSziV1toY7YFl7lUCKYj5j/1I+5uaGlEqbjEsQs6GwL6S9M6ggpbGSBT4fp4xH1FSXeRoWbbVKuB3+Sin8lwP4ZrSTarufWpYCnnLNfYgTFiatpbP9u9BS4PaBVZTFygyvl4Gj4QtVMtZy39tRqiN82RkG61DiTeLFI0xXGqMctQLpOHU8Rn07tBZBKWI6U5wc2nDKWr60ohQPVEglt5MEqYgPuPcoUvj2GOG536pHR6HeWiX3nszv3KCNxOog8hkvs1JKoJuByhgzeUR6ylHTBOq+jNrbTJvzWGXEK6+I5rUmViITmMksumg96kUgP2ZPYzGbaJLt0lE1zD+rI05EWroZh4GQpcwfX8PQkbadR10MXbhnPe039TwhbgtDecxgNZQd0Fs4WTZqzpZOkUpcvWxHmPm1iSCd860EvNKwJos4kAlgE2tMtPpAiNqhxOzzgMiSFdxOnTV3khJ2xTL4J8UsObbn2K6qp9EhXcUUl+0Xn7C8+T4PIYkW4G5LNkIjv/3Df7VGjaTwk0rJtFwJh8k09BPA4ETNaxC/C7JFwkW9eJYtYi/UxStMSrVj1HGmnsG036C+IYDjKeUWvNK7QV2mq+Pas5WncgRU8BwgU5D2fLffRjtnP1UnnTkHsk9wocUqIaEpylIDnmUzA6mgM/4vfibF2BHDgkLjo5w2kgSjoSsRp7z23RudESgIyax21aWtmBZvDLTCn7KXGwXPELxLoU3lvOow7G8XTwAymaV/ymn6aQDp9tEwMHL0slRc3okRtAkHvhwUWpy7wXHup/aGhciA0fpkZhU1UECxGybhjPANsBzB9gUoBo2QWmKI7pjAovDWTbqHMylEi0Xumj+FxJgrdSHm9IbkX92ShJKLoD/flGfMS9pNVaqoCSsa66lPSCNqnDEF85/rr1vDBwDHSPChZri7748VWXxNzoCnbp2wYlRTUn8DOvuMDdO5W/tWnxmHgaiOxOKgoiRsl0Rm2N9E9sse5VLkXnQG4/Ybgzdq9xsxB9RdL5pnXsvBjCc+ruH3/XW4ufEq10PvdruBSz7jFqMfXJZ0APqNcRAm6UVsLSIqYbDuaDXMIJATUzy+EGVLdUcLfcMpWWxXgtUr+mJLvWTTlHTdoF57mJoY0XiFe2lz/xsumI0CgA2z0AyUmvDGB4jANBgkrBgEEAYI3EQIxADATBgkqhkiG9w0BCRUxBgQEAQAAADBdBgkqhkiG9w0BCRQxUB5OAHQAZQAtADEANgAxADMANgAxADQANAAtADYAMQA4ADQALQA0ADYAYwAwAC0AOAA3ADIAMgAtAGEAZQBmADgAMgBkADkANABmAGUAZgBkMF0GCSsGAQQBgjcRATFQHk4ATQBpAGMAcgBvAHMAbwBmAHQAIABTAG8AZgB0AHcAYQByAGUAIABLAGUAeQAgAFMAdABvAHIAYQBnAGUAIABQAHIAbwB2AGkAZABlAHIwggdNBgkqhkiG9w0BBwGgggc+BIIHOjCCBzYwggODBgsqhkiG9w0BDAoBA6CCA3AwggNsBgoqhkiG9w0BCRYBoIIDXASCA1gwggNUMIICPKADAgECAhBQpWSN5vK+pExY7iCTjMhhMA0GCSqGSIb3DQEBCwUAMCgxJjAkBgNVBAMMHWt0bnN2bS13aW4yMDE2LmVuemlhbnRlY2guY29tMB4XDTIyMDMxNTEyMjAwM1oXDTMyMDMxNTEyMjk1OFowKDEmMCQGA1UEAwwda3Ruc3ZtLXdpbjIwMTYuZW56aWFudGVjaC5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCh2WEjlnlY37yMtBhNY/2q/Mgx7hSJMpb9sK4HY/RufB0olyVwA4sKG0+ER9wnC+brkT8CDamnzeC+x5OynZ8QaP7m0tQSLCJrfJ9EapUSgD/TZv7Y+qXnVhI5sSpKXMt0g8SCQEzvS5dsLylw6VENlhvEUSFlfjcZbrCsHQgqEahaPlxz2MG35UUkBSwarTK243wtDvSXiBhmAeWQvNDJqpUlLxKNmvAWSzjfpOdEM+iRHf3Nph2wqSSOS61XUJ55fC0UIAMjzGlEYpJrd73PJTyly5ZQGErDwgyLW/Qti65jgRLg8cMNDqBSTwQwo00SvM54EFOmrQP9nq/SrlkXAgMBAAGjejB4MA4GA1UdDwEB/wQEAwIBtjAdBgNVHSUEFjAUBggrBgEFBQcDAgYIKwYBBQUHAwEwKAYDVR0RBCEwH4Ida3Ruc3ZtLXdpbjIwMTYuZW56aWFudGVjaC5jb20wHQYDVR0OBBYEFD6G+I03qqd9Rd1UCSMy8WxzthG7MA0GCSqGSIb3DQEBCwUAA4IBAQBN5NrClbxY4AdOVSbD319s9ApGwzhA7VH2r73Qi07UtQslLUWHjN6D78ZU/rlqYRsF4yOI3Zxcp7KV9rfOVigJPNUPU9wQe0aPnPUy4qEGd0HJpXmmj8t17l/+gtV6I0Vs0de+OY1PkjfcvFLMOfjAzbG2VxPCm0kL1Jd86b60t/iiaE2l0fxn7UfVetpRZLNZV1X9fwB+raUqN2ILhsS7bFwj3PDpzMw/9qLj/hiE6+9QksSpDhkIJDjU48GiGtkidRoATK+paO0xso3nPLNi5s+CY5NprFeqizymTzOX8DJcjtINTU2CL41k7G0r/stv1YgBQDB7Rwg6bxyTfN68MQAwggOrBgsqhkiG9w0BDAoBA6CCA4MwggN/BgoqhkiG9w0BCRYBoIIDbwSCA2swggNnMIICT6ADAgECAhAaVZcv8KdtjUbjDGvLd3toMA0GCSqGSIb3DQEBCwUAMCgxJjAkBgNVBAMMHWt0bnN2bS13aW4yMDE2LmVuemlhbnRlY2guY29tMB4XDTIyMDMxNTEyMjAwM1oXDTMyMDMxNTEyMzAwM1owIDEeMBwGA1UEAwwVaDY4aGNnLnF1aWNrLmphbWYubmV0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAvBD1C4tR8vWZeSDdQ6AhynzMB47plvkqrXnmhcavlsDnu8Zfanr6gjUND0NK2Ufm0BBhH86kIcYMwehLYVNNfC3RTCT+QLo3wIn7VxUnsAPTqD23QjNwYnDTBQDkBrQIrFYaPc0RxO0MYexg/EqgEiAF1nJAZ3tndev1LBSEO5iN+8patoyV7jE3JlgF9qN0T0XCELrRpEi/pxKaVpAupXp38NBWVAJ6yqWuTCP2gcvnvo8KHHUTpJhwUcxr1aKUjX0LBnJ/mStQ8Cfckr7sLaHXyt4ei5uiQID69d/6JNoqpfoWW0EcHW8V3fiLX5fzsMBGjmRa/R8//zVM/ebpSwIDAQABo4GUMIGRMA4GA1UdDwEB/wQEAwIEsDAdBgNVHSUEFjAUBggrBgEFBQcDAgYIKwYBBQUHAwEwIAYDVR0RBBkwF4IVaDY4aGNnLnF1aWNrLmphbWYubmV0MB8GA1UdIwQYMBaAFD6G+I03qqd9Rd1UCSMy8WxzthG7MB0GA1UdDgQWBBT1Gk6lWWBdrF1z7n/FMgxT5Hb5YjANBgkqhkiG9w0BAQsFAAOCAQEAj0UtZ118booksRr7kDg47IhlhSlkhZVnZfkRUHY2QSYBkHNyilcb9rWJIAzrSI5q+RV+FDXDEc0at9CmH2yIb+dYSojxj1ebSCloZb5QiHfAZTFN5+AicESWb0PMGiiz1HeU8Bm2bjHIRx4OLKSm4agMck/6iBDJhduiidrEZkmz8MRFr04GE/9MAg3JG149JeCSS54seKx7tBx+dJjzHJg2HeqZtOKjaKLOnstquEVhwgGXIqH51lQd5SOfYJH1cQyi6xe7SBZ5YYYF1iubhMUqvYnbugskm35nYWk9XObw4QRnfTQNIuW6p1cz2Nk+yaDheraycaxbBGYaXMgIJzEVMBMGCSqGSIb3DQEJFTEGBAQBAAAAMDswHzAHBgUrDgMCGgQUA/Hryi7gjlbKpKpGVlTvAnjevyAEFFhGKjlcFPkz5+bUOnz1OcWq/3zPAgIH0A==","items":{"type":"string","format":"byte"}},"password":{"maxLength":255,"minLength":1,"type":"string","format":"password","nullable":true,"writeOnly":true,"example":"password-example"}}},"CertificateDetails":{"type":"object","properties":{"subject":{"type":"string","default":""},"serialNumber":{"type":"string","default":""}}},"CertificateIdentityV2":{"type":"object","properties":{"filename":{"type":"string","default":"null"},"keystorePassword":{"type":"string","format":"password","writeOnly":true,"default":""},"identityKeystore":{"pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$","type":"string","description":"The base 64 encoded certificate.","format":"byte","writeOnly":true,"example":"WlhoaGJYQnNaU0J2WmlCaElHSmhjMlUyTkNCbGJtTnZaR1ZrSUhaaGJHbGtJSEF4TWk0Z2EyVjVjM1J2Y21VZ1ptbHNaUT09"},"md5Sum":{"type":"string","description":"The md5 checksum of the certificate file. Intended to be used in verification the cert being used to sign QuickAdd packages.","readOnly":true,"default":""}},"nullable":true},"CertificateKey":{"type":"object","properties":{"id":{"type":"string","example":"1"},"valid":{"type":"boolean","example":true}}},"CertificateListCommand":{"allOf":[{"$ref":"#/components/schemas/MdmCommandBase"},{"type":"object"}]},"CertificateRecord":{"type":"object","properties":{"subjectX500Principal":{"type":"string","example":"CN=Jamf JSS Built-in Certificate Authority"},"issuerX500Principal":{"type":"string","example":"CN=Jamf JSS Built-in Certificate Authority"},"serialNumber":{"type":"string","example":"00bc43bea0"},"version":{"type":"integer","example":3},"notAfter":{"type":"integer","example":1927739379},"notBefore":{"type":"integer","example":1612120179},"signature":{"$ref":"#/components/schemas/Signature"},"keyUsage":{"type":"array","example":["digitalSignature","keyEncipherment","keyCertSign","cRLSign"],"items":{"type":"string"}},"keyUsageExtended":{"type":"array","example":["1.3.6.1.5.5.7.3.1"],"items":{"type":"string"}},"sha1Fingerprint":{"type":"string","example":"448a7cc4d899d6a1821258133c24c023a5f558d9"},"sha256Fingerprint":{"type":"string","example":"660958e14891c67491822687d9ac0e3574562664458111ad875b680995ca472b"}}},"CertificateResponse":{"type":"object","properties":{"filename":{"maxLength":255,"type":"string","description":"Client certificate filename with .p12 extension.","readOnly":true,"example":"example.p12"},"serialNumber":{"type":"string","readOnly":true,"example":"123456789456123"},"subject":{"type":"string","readOnly":true,"example":"CN=SubjectName, OU=OrganizationalUnit, O=Organization, L=Location, ST=State, C=Country"},"issuer":{"type":"string","readOnly":true,"example":"IssuerName"},"expirationDate":{"type":"string","format":"date-time","readOnly":true,"example":"2018-10-15T16:39:56Z"}}},"ChangePassword":{"required":["currentPassword","newPassword"],"type":"object","properties":{"currentPassword":{"type":"string","format":"password","nullable":false,"writeOnly":true,"example":"oldPassword"},"newPassword":{"type":"string","format":"password","nullable":false,"writeOnly":true,"example":"updatedPassword"}}},"ClassicLdapMappings":{"required":["userGroupObjectMapGroupNameTo","userGroupObjectMapIdTo","userGroupObjectMapUuidTo","userObjectMapBuildingTo","userObjectMapDepartmentTo","userObjectMapEmailTo","userObjectMapIdTo","userObjectMapPhoneTo","userObjectMapPositionTo","userObjectMapRealNameTo","userObjectMapRoomTo","userObjectMapUsernameTo","userObjectMapUuidTo"],"type":"object","properties":{"userObjectMapIdTo":{"type":"string","example":"mail"},"userObjectMapUsernameTo":{"type":"string","example":"uid"},"userObjectMapRealNameTo":{"type":"string","example":"displayName"},"userObjectMapEmailTo":{"type":"string","example":"mail"},"userObjectMapDepartmentTo":{"type":"string","example":"departmentNumber"},"userObjectMapBuildingTo":{"type":"string","default":""},"userObjectMapRoomTo":{"type":"string","default":""},"userObjectMapPhoneTo":{"type":"string","default":""},"userObjectMapPositionTo":{"type":"string","example":"title"},"userObjectMapUuidTo":{"type":"string","example":"uid"},"userGroupObjectMapIdTo":{"type":"string","example":"name"},"userGroupObjectMapGroupNameTo":{"type":"string","example":"name"},"userGroupObjectMapUuidTo":{"type":"string","example":"uid"}},"description":"Classic Ldap mappings configuration"},"ClearPasscodeCommand":{"allOf":[{"$ref":"#/components/schemas/MdmCommandBase"},{"required":["unlockToken"],"type":"object","properties":{"unlockToken":{"type":"string","example":"VU5MT0NLVE9LRU4="}}}]},"ClearRestrictionsPasswordCommand":{"allOf":[{"$ref":"#/components/schemas/MdmCommandBase"},{"type":"object"}]},"ClientCheckInV3":{"type":"object","properties":{"checkInFrequency":{"type":"integer","description":"Suggested values are 5, 15, 30, or 60. Web interface will not display correctly if not one of those. Minimum is 5, maximum is 60.","format":"int32","default":15},"createHooks":{"type":"boolean","default":false},"hookLog":{"type":"boolean","default":false},"hookPolicies":{"type":"boolean","default":false},"createStartupScript":{"type":"boolean","default":false},"startupLog":{"type":"boolean","default":false},"startupPolicies":{"type":"boolean","default":false},"startupSsh":{"type":"boolean","default":false},"enableLocalConfigurationProfiles":{"type":"boolean","default":false}}},"CloudDistributionPoint":{"allOf":[{"$ref":"#/components/schemas/CloudDistributionPointTestConnection"},{"required":["cdnType","password","username"],"type":"object","properties":{"inventoryId":{"type":"string","description":"The unique identifier (inventoryId) that links the cloud distribution point to its inventory data. By default, its value is 0, and it increments by +1 based on the existing inventory ID present in the table for each new cloud distribution point configuration. If the cdnType is set to NONE in the next configuration, the ID resets and starts from 1.","readOnly":true,"default":"0"},"cdnType":{"type":"string","description":"Specifies the content delivery network (CDN) used to distribute content for the cloud distribution point.","enum":["NONE","JAMF_CLOUD","RACKSPACE_CLOUD_FILES","AMAZON_S3","AKAMAI"],"default":"NONE"},"master":{"type":"boolean","description":"Use as principal distribution point. Use as the authoritative source for all files.<br/> Possible values are:<br/> false <br/> true","example":false,"default":false},"username":{"type":"string","description":"The username or access key used for authenticating with the selected content delivery network (CDN). \nThis field is required when the **cdnType** is set to **Rackspace Cloud Files(RACKSPACE_CLOUD_FILES)**, **Amazon Web Services(AMAZON_S3)**, or **Akamai(AKAMAI)**, as it is used to authenticate and authorize access to the respective cloud services.\n- For **Rackspace Cloud Files(RACKSPACE_CLOUD_FILES)**, this is typically the username associated with your Rackspace cloud account.\n- For **Amazon Web Services(AMAZON_S3)**, this corresponds to the **Access Key ID** used to interact with Amazon Web Services(AMAZON_S3) resources.\n- For **Akamai(AKAMAI)**, this is the username used for API authentication to access Akamai's content delivery services.\nIf the **cdnType** is **None**, this field is not applicable.\n","example":"Admin"},"password":{"type":"string","description":"The password or authentication key used for connecting to the selected content delivery network (CDN). \nThis field is required when the **cdnType** is set to **Rackspace Cloud Files(RACKSPACE_CLOUD_FILES)**, **Amazon Web Services(AMAZON_S3)**, or **Akamai(AKAMAI)**, and is used to authenticate and authorize access to the respective cloud services.\n- For **Rackspace Cloud Files(RACKSPACE_CLOUD_FILES)**, this refers to the **API Key** that is used in conjunction with the username for authenticating API requests.\n- For **Amazon Web Services(AMAZON_S3)**, this corresponds to the **Secret Access Key** associated with your AWS account, used to securely sign requests to AWS services.\n- For **Akamai(AKAMAI)**, this is the **password** used for API authentication to access Akamai's content delivery services.\nIf the **cdnType** is **None**, this field is not applicable.\n","format":"password","writeOnly":true,"example":"secretKey123"},"directory":{"type":"string","description":"The directory or path for content delivery in Akamai. This field is required when the **cdnType** is set to **Akamai(AKAMAI)** and specifies where content is stored within Akamai's system.","example":"123456"},"cdnUrl":{"type":"string","description":"The CDN URL for the cloud distribution point. The URL format varies depending on the selected CDN provider:\n- **Rackspace Cloud Files(RACKSPACE_CLOUD_FILES)**\n- **Amazon Web Services(AMAZON_S3)** \n- **Akamai(AKAMAI)**\n\nThe **cdnUrl** should point to the content distribution location where software or other content is stored and made available for distribution.\n","readOnly":true,"example":"https://example-cdn-url.com/content-path"},"uploadUrl":{"type":"string","description":"The URL used to upload files to Akamai's NetStorage. This field is required when the **cdnType** is set to **Akamai(AKAMAI)**. \nIt specifies where content should be uploaded to Akamai’s cloud storage before being distributed via their CDN. The upload typically uses FTP or SFTP.\n","example":"ftp://mycompany.upload.akamai.com"},"downloadUrl":{"type":"string","description":"The URL used to access and download content from Akamai's EdgeSuite. This field is required when the **cdnType** is set to **Akamai(AKAMAI)**. \nIt specifies the endpoint from which files are retrieved by devices or users.\n","example":"https://download.mycompany.com"},"secondaryAuthRequired":{"type":"boolean","description":"Enable Remote Authentication.Authorize requests for files stored on the distribution point. This field is required when the **cdnType** is set to **Akamai(AKAMAI)**.<br/> Possible values are:<br/> false <br/> true","example":false,"default":false},"secondaryAuthStatusCode":{"type":"integer","description":"Secondary Auth Status Code. Configure the HTTP response code that will be returned by Jamf Pro during remote authentication. This field is required when the **cdnType** is set to **Akamai(AKAMAI)** and **secondaryAuthRequired** is true.","default":200},"secondaryAuthTimeToLive":{"minimum":1,"type":"integer","description":"Secondary Auth Time To Live. Number of seconds before the authorization token expires. This field is required when the **cdnType** is set to **Akamai(AKAMAI)** and **secondaryAuthRequired** is true.","default":3600},"requireSignedUrls":{"type":"boolean","description":"Amazon Sign Url. It restrict access to requests that use a signed URL. This field is required when the **cdnType** is set to **Amazon Web Services(AMAZON_S3)**.<br/> Possible values are:<br/> false <br/> true","example":false,"default":false},"keyPairId":{"type":"string","description":"The CloudFront Access Key ID (keyPairId) is part of the credentials used to generate signed URLs for secure access to content in a CloudFront distribution.\nWhen using AWS, this key is paired with the CloudFront Secret Access Key to create the signed URL, ensuring that only authorized users can access specific content within a specified timeframe.\nThis field is required when the **cdnType** is set to **Amazon Web Services(AMAZON_S3)** and **requireSignedUrls** is true.\n","example":"K1R8C5EXAMPLE"},"expirationSeconds":{"minimum":1,"type":"integer","description":"Signed URL Expiration. Number of seconds before the signed URL expires, This field is required when the **cdnType** is set to **Amazon Web Services(AMAZON_S3)** and **requireSignedUrls** is true.","default":3600},"privateKey":{"type":"string","description":"The CloudFront Private Key file is required when the **cdnType** is set to **Amazon Web Services(AMAZON_S3)** and **requireSignedUrls**\nparameter is enabled. This private key is used for signing URLs for restricted access to CloudFront-distributed content. \nThe private key allows secure URL generation for signed URLs, ensuring that only authorized users can access certain content.\nThe key must be uploaded in one of the following formats:\n- **.pem**: A Privacy-Enhanced Mail (PEM) file containing the private key in base64 encoded format.\n- **.der**: A Distinguished Encoding Rules (DER) encoded file, which is a binary format for the private key.\nThe uploaded file should be kept secure, as it provides the ability to generate signed URLs with access to protected content.\n","format":"byte"}}}]},"CloudDistributionPointInventoryFileInfo":{"required":["fileName","fileObjectId","status","type"],"type":"object","properties":{"id":{"type":"string","description":"A unique identifier for the cloud distribution point inventory file table.","readOnly":true,"example":"1"},"inventoryId":{"type":"string","description":"A unique identifier for the cloud distribution point inventory file and cloud distribution point tables.This ID is used to reference a specific inventory resource within the system.","readOnly":true,"example":"1"},"type":{"type":"string","description":"The type of the inventory file. This field indicates whether the file is related to a package, mobile device app, or an ebook.","example":"PACKAGE","enum":["NONE","PACKAGE","EBOOK","MOBILE_DEVICE_APP","SCRIPT"]},"fileName":{"type":"string","description":"The name of the inventory file. This could be the name of a package, a mobile device app, or an ebook file, depending on the file type. The name should match the actual file or package name as stored in the cloud distribution system.","example":"SettingPackage"},"fileObjectId":{"type":"string","description":"A unique identifier for each file type (package, ebook, or mobile device app). This ID is used to construct the URL for accessing or navigating to the specific resource related to the file type.","example":"1"},"category":{"type":"string","description":"The category assigned to the inventory file (package, ebook, or mobile device app) during creation. This helps group and organize files based on their type or purpose, such as security software or productivity tools.","example":"Category1"},"status":{"type":"string","description":"The current status of the inventory file, indicating the progress or outcome of the file's upload process.It reflects whether the file is ready for use, still being processed, or has encountered an error.","example":"READY","enum":["READY","PENDING","ERROR"]}}},"CloudDistributionPointInventoryFilesResults":{"required":["totalCount"],"type":"object","properties":{"totalCount":{"type":"integer","example":1},"results":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/CloudDistributionPointInventoryFileInfo"}}}},"CloudDistributionPointTestConnection":{"required":["hasConnectionSucceeded","message"],"type":"object","properties":{"hasConnectionSucceeded":{"type":"boolean","description":"Indicates whether the connection to the cloud distribution point was successful. \nIf `true`, the connection was successful. If `false`, the connection failed.<br/>\nPossible values are:<br/>\nfalse <br/>\ntrue\n","readOnly":true,"default":false},"message":{"type":"string","description":"A message detailing the result of the connection test. This could be a success message\nor an error message if the connection failed.\n","readOnly":true,"example":"Cannot contact JCDS"}}},"CloudDistributionPointUploadCapability":{"type":"object","properties":{"principalDistributionTechnology":{"type":"boolean","nullable":false,"example":false,"default":false},"directUploadCapable":{"type":"boolean","nullable":false,"example":false,"default":false}}},"CloudIdPCommon":{"required":["displayName","id","providerName"],"type":"object","properties":{"id":{"type":"string","example":"1001"},"displayName":{"type":"string","example":"Cloud Identity Provider"},"providerName":{"type":"string","example":"PROVIDER","enum":["GOOGLE","AZURE"]}},"description":"A Cloud Identity Provider information"},"CloudIdPCommonRequest":{"required":["displayName","providerName"],"type":"object","properties":{"displayName":{"type":"string","example":"Cloud Identity Provider"},"providerName":{"type":"string","example":"PROVIDER","enum":["GOOGLE","AZURE"]}},"description":"A Cloud Identity Provider information for request"},"CloudIdPCommonResponse":{"type":"object","properties":{"id":{"minimum":1001,"type":"string","example":"1001"},"displayName":{"type":"string","example":"Cloud Identity Provider"},"enabled":{"type":"boolean","example":true},"providerName":{"type":"string","example":"PROVIDER","enum":["GOOGLE","AZURE"]},"providerDescription":{"type":"string","example":"Entra ID"}},"description":"A Cloud Identity Provider information for responses"},"CloudLdapConnectionPoolStatistics":{"type":"object","properties":{"numConnectionsClosedDefunct":{"type":"integer","format":"int64","example":1},"numConnectionsClosedExpired":{"type":"integer","format":"int64","example":1},"numConnectionsClosedUnneeded":{"type":"integer","format":"int64","example":1},"numFailedCheckouts":{"type":"integer","format":"int64","example":1},"numFailedConnectionAttempts":{"type":"integer","format":"int64","example":1},"numReleasedValid":{"type":"integer","format":"int64","example":1},"numSuccessfulCheckouts":{"type":"integer","format":"int64","example":1},"numSuccessfulCheckoutsNewConnection":{"type":"integer","format":"int64","example":1},"numSuccessfulConnectionAttempts":{"type":"integer","format":"int64","example":1},"maximumAvailableConnections":{"type":"integer","format":"int64","example":1},"numSuccessfulCheckoutsWithoutWaiting":{"type":"integer","format":"int64","example":1},"numSuccessfulCheckoutsAfterWaiting":{"type":"integer","format":"int64","example":1},"numAvailableConnections":{"type":"integer","format":"int64","example":1}},"description":"Ldap Cloud Identity Provider conection pool statistics"},"CloudLdapConnectionStatus":{"type":"object","properties":{"status":{"type":"string","example":"Successfully connected"}},"description":"Status of tested Cloud Ldap connection"},"CloudLdapKeystore":{"type":"object","properties":{"type":{"type":"string","example":"PKCS12"},"expirationDate":{"type":"string","format":"date-time","example":"2030-02-21T12:05:47.244Z"},"subject":{"type":"string","example":"ST=California, C=US, OU=GSuite, CN=LDAP Client, L=Mountain View, O=Google Inc."},"fileName":{"type":"string","example":"keystore.p12"}},"description":"Response with keystore information"},"CloudLdapKeystoreFile":{"required":["fileBytes","fileName","password"],"type":"object","properties":{"password":{"type":"string","format":"password","writeOnly":true,"example":"***"},"fileBytes":{"pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$","type":"string","format":"byte","example":"WlhoaGJYQnNaU0J2WmlCaElHSmhjMlUyTkNCbGJtTnZaR1ZrSUhaaGJHbGtJSEF4TWk0Z2EyVjVjM1J2Y21VZ1ptbHNaUT09"},"fileName":{"type":"string","example":"keystore.p12"}},"description":"Request with the Base64-encoded keystore file"},"CloudLdapMappingsRequest":{"required":["groupMappings","membershipMappings","userMappings"],"type":"object","properties":{"userMappings":{"$ref":"#/components/schemas/UserMappings"},"groupMappings":{"$ref":"#/components/schemas/GroupMappings"},"membershipMappings":{"$ref":"#/components/schemas/MembershipMappings"}},"description":"Mappings configurations request for Ldap Cloud Identity Provider configuration"},"CloudLdapMappingsResponse":{"type":"object","properties":{"userMappings":{"$ref":"#/components/schemas/UserMappings"},"groupMappings":{"$ref":"#/components/schemas/GroupMappings"},"membershipMappings":{"$ref":"#/components/schemas/MembershipMappings"}},"description":"Mappings configuration response for Ldap Cloud Identity Provider configuration"},"CloudLdapServerRequest":{"required":["connectionTimeout","connectionType","domainName","enabled","keystore","port","searchTimeout","serverUrl","useWildcards"],"type":"object","properties":{"serverUrl":{"type":"string","example":"ldap.google.com"},"enabled":{"type":"boolean","example":true},"domainName":{"type":"string","example":"jamf.com"},"port":{"maximum":65535,"minimum":1,"type":"integer","example":636},"keystore":{"$ref":"#/components/schemas/CloudLdapKeystoreFile"},"connectionTimeout":{"maximum":600,"minimum":5,"type":"integer","example":15},"searchTimeout":{"maximum":600,"minimum":5,"type":"integer","example":60},"useWildcards":{"type":"boolean","example":true},"connectionType":{"type":"string","example":"LDAPS","enum":["LDAPS","START_TLS"]},"membershipCalculationOptimizationEnabled":{"type":"boolean","example":true}},"description":"A Cloud Identity Provider LDAP server configuration for requests"},"CloudLdapServerResponse":{"type":"object","properties":{"id":{"type":"string","example":"1001"},"enabled":{"type":"boolean","example":true},"serverUrl":{"type":"string","example":"ldap.google.com"},"domainName":{"type":"string","example":"jamf.com"},"port":{"maximum":65535,"minimum":1,"type":"integer","example":636},"keystore":{"$ref":"#/components/schemas/CloudLdapKeystore"},"connectionTimeout":{"minimum":5,"type":"integer","example":15},"searchTimeout":{"minimum":5,"type":"integer","example":60},"useWildcards":{"type":"boolean","example":true},"connectionType":{"type":"string","example":"LDAPS","enum":["LDAPS","START_TLS"]},"membershipCalculationOptimizationEnabled":{"type":"boolean","example":true}},"description":"A Cloud Identity Provider LDAP server configuration for responses"},"CloudLdapServerUpdate":{"required":["connectionTimeout","connectionType","domainName","enabled","port","providerName","searchTimeout","serverUrl","useWildcards"],"type":"object","properties":{"serverUrl":{"type":"string","example":"ldap.google.com"},"enabled":{"type":"boolean","example":true},"domainName":{"type":"string","example":"jamf.com"},"port":{"maximum":65535,"minimum":1,"type":"integer","example":636},"keystore":{"$ref":"#/components/schemas/CloudLdapKeystoreFile"},"connectionTimeout":{"minimum":1,"type":"integer","example":15},"searchTimeout":{"minimum":1,"type":"integer","example":60},"useWildcards":{"type":"boolean","example":true},"connectionType":{"type":"string","example":"LDAPS","enum":["LDAPS","START_TLS"]},"membershipCalculationOptimizationEnabled":{"type":"boolean","example":true}},"description":"A Cloud Identity Provider LDAP server configuration for updates"},"CloudResponse":{"type":"object","properties":{"cloudInstance":{"type":"boolean","nullable":false,"example":true},"rampInstance":{"type":"boolean","nullable":false,"example":true},"fedRampInstance":{"type":"boolean","description":"Information whether this instance is a FedRAMP instance","nullable":false,"example":false},"govCloudInstance":{"type":"boolean","nullable":false,"example":true},"managedServiceProviderInstance":{"type":"boolean","description":"Information whether this instance is managed by managed service provider","nullable":false,"example":true},"highComplianceInstance":{"type":"boolean","description":"Information whether this instance is a High Compliance instance","nullable":false,"example":false},"fipsEnabled":{"type":"boolean","description":"Information whether this instance has FIPS enabled","nullable":false,"example":false}}},"ComplianceVendorDeviceInformation":{"type":"object","properties":{"deviceIds":{"type":"array","description":"Vendor's device IDs. Currently provided only for Intune.","example":["device-id-1","device-id-2"],"items":{"type":"string"}}},"description":"Additional, compliance vendor specific device details."},"ComputerApplication":{"type":"object","properties":{"name":{"type":"string","example":"Microsoft Word"},"path":{"type":"string","example":"/usr/local/app"},"version":{"type":"string","example":"1.0.0"},"macAppStore":{"type":"boolean","example":true},"sizeMegabytes":{"type":"integer","example":25},"bundleId":{"type":"string","example":"1"},"updateAvailable":{"type":"boolean","example":false},"externalVersionId":{"type":"string","description":"The app's external version ID. It can be used in the iTunes Search API to decide if the app needs to be updated","example":"1"}}},"ComputerApplicationCreate":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Microsoft Word"},"path":{"type":"string","nullable":true,"example":"/usr/local/app"},"version":{"type":"string","nullable":true,"example":"1.0.0"}}},"ComputerApplicationV3":{"type":"object","properties":{"name":{"type":"string","example":"Microsoft Word"},"path":{"type":"string","example":"/usr/local/app"},"version":{"type":"string","example":"1.0.0"},"cfBundleShortVersionString":{"type":"string","nullable":false,"example":"1.0.0"},"cfBundleVersion":{"type":"string","nullable":false,"example":"1.0.0"},"macAppStore":{"type":"boolean","example":true},"sizeMegabytes":{"type":"integer","example":25},"bundleId":{"type":"string","example":"1"},"updateAvailable":{"type":"boolean","example":false},"externalVersionId":{"type":"string","description":"The app's external version ID. It can be used in the iTunes Search API to decide if the app needs to be updated","example":"1"}}},"ComputerAttachment":{"type":"object","properties":{"id":{"type":"string","example":"1"},"name":{"type":"string","example":"Attachment.pdf"},"fileType":{"type":"string","example":"application/pdf"},"sizeBytes":{"type":"integer","description":"File size in bytes","format":"int64","example":1024}}},"ComputerCertificate":{"type":"object","properties":{"commonName":{"type":"string","example":"jamf.com"},"identity":{"type":"boolean","example":true},"expirationDate":{"type":"string","format":"date-time","example":"2030-10-31T18:04:13Z"},"username":{"type":"string","example":"test"},"lifecycleStatus":{"type":"string","example":"ACTIVE","enum":["ACTIVE","INACTIVE"]},"certificateStatus":{"type":"string","example":"ISSUED","enum":["EXPIRING","EXPIRED","REVOKED","PENDING_REVOKE","ISSUED"]},"subjectName":{"type":"string","example":"CN=jamf.com"},"serialNumber":{"type":"string","example":"40f3d9fb"},"sha1Fingerprint":{"type":"string","example":"ed361458724d06082b2314acdb82e1f586f085f5"},"issuedDate":{"type":"string","example":"2022-05-23T14:54:10Z"}}},"ComputerCertificateCreate":{"type":"object","properties":{"commonName":{"type":"string","nullable":true,"example":"jamf.com"},"identity":{"type":"boolean","nullable":true,"example":true},"username":{"type":"string","nullable":true,"example":"test"}}},"ComputerConfigurationProfile":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"1"},"username":{"type":"string","readOnly":true,"example":"username"},"lastInstalled":{"type":"string","format":"date-time","example":"2018-10-31T18:04:13Z"},"removable":{"type":"boolean","readOnly":true,"example":true},"displayName":{"type":"string","readOnly":true,"example":"Displayed profile"},"profileIdentifier":{"type":"string","readOnly":true,"example":"0ae590fe-9b30-11ea-bb37-0242ac130002"},"uuid":{"type":"string","nullable":true,"readOnly":true,"example":"0ae590fe-9b30-11ea-bb37-0242ac130002"}}},"ComputerConfigurationProfileCreate":{"type":"object","properties":{"id":{"type":"string","nullable":true,"example":"1"},"username":{"type":"string","nullable":true,"example":"username"},"lastInstalled":{"type":"string","format":"date-time","nullable":true,"example":"2018-10-31T18:04:13Z"},"removable":{"type":"boolean","nullable":true,"example":true},"displayName":{"type":"string","nullable":true,"example":"Displayed profile"},"profileIdentifier":{"type":"string","nullable":true,"example":"0ae590fe-9b30-11ea-bb37-0242ac130002"}}},"ComputerContentCaching":{"type":"object","properties":{"computerContentCachingInformationId":{"type":"string","readOnly":true,"example":"1"},"parents":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/ComputerContentCachingParent"}},"alerts":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/ComputerContentCachingAlert"}},"activated":{"type":"boolean","readOnly":true,"example":false},"active":{"type":"boolean","readOnly":true,"example":false},"actualCacheBytesUsed":{"type":"integer","format":"int64","readOnly":true,"example":0},"cacheDetails":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/ComputerContentCachingCacheDetail"}},"cacheBytesFree":{"type":"integer","format":"int64","readOnly":true,"example":23353884672},"cacheBytesLimit":{"type":"integer","format":"int64","readOnly":true,"example":0},"cacheStatus":{"type":"string","readOnly":true,"example":"OK"},"cacheBytesUsed":{"type":"integer","format":"int64","readOnly":true,"example":0},"dataMigrationCompleted":{"type":"boolean","readOnly":true,"example":false},"dataMigrationProgressPercentage":{"type":"integer","readOnly":true,"example":0},"dataMigrationError":{"$ref":"#/components/schemas/ComputerContentCachingDataMigrationError"},"maxCachePressureLast1HourPercentage":{"type":"integer","readOnly":true,"example":0},"personalCacheBytesFree":{"type":"integer","format":"int64","readOnly":true,"example":23353884672},"personalCacheBytesLimit":{"type":"integer","format":"int64","readOnly":true,"example":0},"personalCacheBytesUsed":{"type":"integer","format":"int64","readOnly":true,"example":0},"port":{"type":"integer","format":"int64","readOnly":true,"example":0},"publicAddress":{"type":"string","readOnly":true,"example":"SomeAddress"},"registrationError":{"type":"string","readOnly":true,"example":"NOT_ACTIVATED"},"registrationResponseCode":{"type":"integer","format":"int64","readOnly":true,"example":403},"registrationStarted":{"type":"string","format":"date-time","readOnly":true,"example":"2018-10-31T18:04:13Z"},"registrationStatus":{"type":"string","readOnly":true,"example":"CONTENT_CACHING_FAILED","enum":["CONTENT_CACHING_FAILED","CONTENT_CACHING_PENDING","CONTENT_CACHING_SUCCEEDED"]},"restrictedMedia":{"type":"boolean","readOnly":true,"example":false},"serverGuid":{"type":"string","readOnly":true,"example":"CD1E1291-4AF9-4468-B5D5-0F780C13DB2F"},"startupStatus":{"type":"string","readOnly":true,"example":"FAILED"},"tetheratorStatus":{"type":"string","readOnly":true,"example":"CONTENT_CACHING_DISABLED","enum":["CONTENT_CACHING_UNKNOWN","CONTENT_CACHING_DISABLED","CONTENT_CACHING_ENABLED"]},"totalBytesAreSince":{"type":"string","format":"date-time","readOnly":true,"example":"2018-10-31T18:04:13Z"},"totalBytesDropped":{"type":"integer","format":"int64","readOnly":true,"example":0},"totalBytesImported":{"type":"integer","format":"int64","readOnly":true,"example":0},"totalBytesReturnedToChildren":{"type":"integer","format":"int64","readOnly":true,"example":0},"totalBytesReturnedToClients":{"type":"integer","format":"int64","readOnly":true,"example":0},"totalBytesReturnedToPeers":{"type":"integer","format":"int64","readOnly":true,"example":0},"totalBytesStoredFromOrigin":{"type":"integer","format":"int64","readOnly":true,"example":0},"totalBytesStoredFromParents":{"type":"integer","format":"int64","readOnly":true,"example":0},"totalBytesStoredFromPeers":{"type":"integer","format":"int64","readOnly":true,"example":0}}},"ComputerContentCachingAlert":{"type":"object","properties":{"cacheBytesLimit":{"type":"integer","format":"int64","readOnly":true,"example":0},"className":{"type":"string","readOnly":true,"example":"SomeClass"},"pathPreventingAccess":{"type":"string","readOnly":true,"example":"/some/path"},"postDate":{"type":"string","format":"date-time","readOnly":true,"example":"2018-10-31T18:04:13Z"},"reservedVolumeBytes":{"type":"integer","format":"int64","readOnly":true,"example":0},"resource":{"type":"string","readOnly":true,"example":"SomeResource"}}},"ComputerContentCachingCacheDetail":{"type":"object","properties":{"computerContentCachingCacheDetailsId":{"type":"string","readOnly":true,"example":"1"},"categoryName":{"type":"string","readOnly":true,"example":"SomeCategory"},"diskSpaceBytesUsed":{"type":"integer","format":"int64","readOnly":true,"example":0}}},"ComputerContentCachingDataMigrationError":{"type":"object","properties":{"code":{"type":"integer","format":"int64","readOnly":true,"example":0},"domain":{"type":"string","readOnly":true,"example":"SomeDomain"},"userInfo":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/ComputerContentCachingDataMigrationErrorUserInfo"}}}},"ComputerContentCachingDataMigrationErrorUserInfo":{"type":"object","properties":{"key":{"type":"string","readOnly":true,"example":"foo"},"value":{"type":"string","readOnly":true,"example":"bar"}}},"ComputerContentCachingParent":{"type":"object","properties":{"contentCachingParentId":{"type":"string","readOnly":true,"example":"1"},"address":{"type":"string","readOnly":true,"example":"SomeAddress"},"alerts":{"$ref":"#/components/schemas/ComputerContentCachingParentAlert"},"details":{"$ref":"#/components/schemas/ComputerContentCachingParentDetails"},"guid":{"type":"string","readOnly":true,"example":"CD1E1291-4AF9-4468-B5D5-0F780C13DB2F"},"healthy":{"type":"boolean","readOnly":true,"example":true},"port":{"type":"integer","format":"int64","readOnly":true,"example":0},"version":{"type":"string","readOnly":true,"example":"1"}}},"ComputerContentCachingParentAlert":{"type":"object","properties":{"contentCachingParentAlertId":{"type":"string","readOnly":true,"example":"1"},"addresses":{"type":"array","readOnly":true,"example":[],"items":{"type":"string"}},"className":{"type":"string","readOnly":true,"example":"SomeClass"},"postDate":{"type":"string","format":"date-time","readOnly":true,"example":"2018-10-31T18:04:13Z"}}},"ComputerContentCachingParentCapabilities":{"type":"object","properties":{"contentCachingParentCapabilitiesId":{"type":"string","readOnly":true,"example":"1"},"imports":{"type":"boolean","readOnly":true,"example":true},"namespaces":{"type":"boolean","readOnly":true,"example":true},"personalContent":{"type":"boolean","readOnly":true,"example":true},"queryParameters":{"type":"boolean","readOnly":true,"example":true},"sharedContent":{"type":"boolean","readOnly":true,"example":true},"prioritization":{"type":"boolean","readOnly":true,"example":true}}},"ComputerContentCachingParentDetails":{"type":"object","properties":{"contentCachingParentDetailsId":{"type":"string","readOnly":true,"example":"1"},"acPower":{"type":"boolean","readOnly":true,"example":true},"cacheSizeBytes":{"type":"integer","format":"int64","readOnly":true,"example":0},"capabilities":{"$ref":"#/components/schemas/ComputerContentCachingParentCapabilities"},"portable":{"type":"boolean","readOnly":true,"example":true},"localNetwork":{"type":"array","items":{"$ref":"#/components/schemas/ComputerContentCachingParentLocalNetwork"}}}},"ComputerContentCachingParentLocalNetwork":{"type":"object","properties":{"contentCachingParentLocalNetworkId":{"type":"string","readOnly":true,"example":"1"},"speed":{"type":"integer","format":"int64","readOnly":true,"example":5000},"wired":{"type":"boolean","readOnly":true,"example":true}}},"ComputerDisk":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"170"},"device":{"type":"string","readOnly":true,"example":"disk0"},"model":{"type":"string","readOnly":true,"example":"APPLE HDD TOSHIBA MK5065GSXF"},"revision":{"type":"string","readOnly":true,"example":"5"},"serialNumber":{"type":"string","readOnly":true,"example":"a8598f013366"},"sizeMegabytes":{"type":"integer","description":"Disk Size in MB.","format":"int64","readOnly":true,"example":262144},"smartStatus":{"type":"string","description":"S.M.A.R.T Status","readOnly":true,"example":"OK"},"type":{"type":"string","description":"Connection type attribute.","readOnly":true,"example":"false"},"partitions":{"type":"array","items":{"$ref":"#/components/schemas/ComputerPartition"}}}},"ComputerDiskCreate":{"type":"object","properties":{"device":{"type":"string","nullable":true,"example":"disk0"},"model":{"type":"string","nullable":true,"example":"APPLE HDD TOSHIBA MK5065GSXF"},"revision":{"type":"string","nullable":true,"example":"5"},"serialNumber":{"type":"string","nullable":true,"example":"a8598f013366"},"sizeMegabytes":{"type":"integer","description":"Disk Size in MB.","format":"int64","nullable":true,"example":262144},"smartStatus":{"type":"string","description":"S.M.A.R.T Status","nullable":true,"example":"OK"},"type":{"type":"string","description":"Connection type attribute.","nullable":true,"example":"false"},"partitions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ComputerPartitionCreate"}}}},"ComputerDiskEncryption":{"type":"object","properties":{"bootPartitionEncryptionDetails":{"$ref":"#/components/schemas/ComputerPartitionEncryption"},"individualRecoveryKeyValidityStatus":{"type":"string","example":"VALID","enum":["VALID","INVALID","UNKNOWN","NOT_APPLICABLE"]},"institutionalRecoveryKeyPresent":{"type":"boolean","example":true},"diskEncryptionConfigurationName":{"type":"string","example":"Test configuration"},"fileVault2Enabled":{"type":"boolean","readOnly":true,"example":true},"fileVault2EnabledUserNames":{"type":"array","example":["admin"],"items":{"type":"string"}},"fileVault2EligibilityMessage":{"type":"string","example":"Not a boot partition"}}},"ComputerExtensionAttribute":{"type":"object","properties":{"definitionId":{"type":"string","description":"An identifier of extension attribute definition.","nullable":false,"example":"23"},"name":{"type":"string","description":"A human-readable name by which attribute can be referred to.","nullable":false,"readOnly":true,"example":"Some Attribute"},"description":{"type":"string","description":"An additional explanation of exact attribute meaning, possible values, etc.","nullable":true,"readOnly":true,"example":"Some Attribute defines how much Foo impacts Bar."},"enabled":{"type":"boolean","nullable":false,"readOnly":true,"example":true},"multiValue":{"type":"boolean","nullable":false,"readOnly":true,"example":true},"values":{"type":"array","description":"A value of extension attribute, in some rare cases there may be multiple values present, hence the array.\n","nullable":true,"readOnly":false,"example":["foo","bar"],"items":{"type":"string"}},"dataType":{"type":"string","description":"A data type of extension attribute.","nullable":true,"readOnly":true,"example":"STRING","enum":["STRING","INTEGER","DATE_TIME"]},"options":{"type":"array","description":"A closed list of possible values (applies to `popup` input type).\n","nullable":true,"readOnly":true,"example":["foo","bar"],"items":{"type":"string"}},"inputType":{"type":"string","description":"The input method. `text` is most common and means simply free text, `popup` i a closed list of values from\nwhich one or many can be selected and `script` value is calculated and can never be set directly.\n","nullable":true,"readOnly":true,"example":"TEXT","enum":["TEXT","POPUP","SCRIPT","LDAP"]}}},"ComputerExtensionAttributeSearchResults":{"required":["totalCount"],"type":"object","properties":{"totalCount":{"type":"integer","example":1},"results":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/ComputerExtensionAttributes"}}}},"ComputerExtensionAttributeTemplates":{"required":["templateCategoryName","templateName"],"type":"object","properties":{"templateId":{"type":"string","description":"Unique Id for Computer Extension Attribute Template.","readOnly":true,"example":"1"},"templateName":{"type":"string","description":"Template display name of the extension attribute.","example":"ClamXav - Virus Definition Date"},"templateCategoryName":{"type":"string","description":"Template category name of the extension attribute.","example":"AntiVirus"}}},"ComputerExtensionAttributes":{"allOf":[{"$ref":"#/components/schemas/ExtensionAttributes"},{"required":["inputType","inventoryDisplayType"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Enabled by default, but for inputType Script we can disable it as well. <br/> Possible values are:<br/> false <br/> true","example":true,"default":true},"inventoryDisplayType":{"type":"string","description":"Category in which to display the extension attribute in Jamf Pro.","example":"GENERAL","enum":["GENERAL","HARDWARE","OPERATING_SYSTEM","USER_AND_LOCATION","PURCHASING","EXTENSION_ATTRIBUTES"],"default":"GENERAL"},"inputType":{"type":"string","description":"Extension attributes collect inventory data by using an input type.The type of the Input used to populate the extension attribute.","enum":["SCRIPT","TEXT","POPUP","DIRECTORY_SERVICE_ATTRIBUTE_MAPPING"],"default":"TEXT"},"scriptContents":{"type":"string","description":"When we run this script it returns a data value each time a computer submits inventory to Jamf Pro. Provide scriptContents only when inputType is 'SCRIPT'.","nullable":true,"example":"scriptContent"},"popupMenuChoices":{"minItems":0,"type":"array","description":"When added with list of choices while creating computer extension attributes these Pop-up menu can be displayed in inventory information. User can choose a value from the pop-up menu list when enrolling a computer any time using Jamf Pro. Provide popupMenuChoices only when inputType is 'POPUP'.","example":["Test","Popup"],"items":{"type":"string","description":"Popup Menu choices."}},"ldapAttributeMapping":{"type":"string","description":"Directory Service attribute use to populate the extension attribute. <br/> Required when inputType is \"DIRECTORY_SERVICE_ATTRIBUTE_MAPPING\"","example":"ldapAttributeMapping"},"ldapExtensionAttributeAllowed":{"type":"boolean","description":"Collect multiple values for this extension attribute. ldapExtensionAttributeAllowed is disabled by default, only for inputType 'DIRECTORY_SERVICE_ATTRIBUTE_MAPPING' it can be enabled. It's value cannot be modified during edit operation.<br/> Possible values are:<br/> false <br/> true <br/>","example":false,"default":false},"manageExistingData":{"type":"string","description":"It is used to specify to either delete or retain the extension attributes values when inputType is Script and enabled is false.","example":"RETAIN","enum":["RETAIN","DELETE"]}}}]},"ComputerFont":{"type":"object","properties":{"name":{"type":"string","example":"font name"},"version":{"type":"string","example":"1.02"},"path":{"type":"string","example":"/Applications/"}}},"ComputerFontCreate":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"font name"},"version":{"type":"string","nullable":true,"example":"1.02"},"path":{"type":"string","nullable":true,"example":"/Applications/"}}},"ComputerGeneral":{"type":"object","properties":{"name":{"minLength":1,"type":"string","example":"Boalime"},"lastIpAddress":{"type":"string","example":"247.185.82.186"},"lastReportedIp":{"type":"string","description":"Last reported IPv4 address (Deprecated. Use lastReportedIpV4 instead.)","example":"247.185.82.186","deprecated":true},"lastReportedIpV4":{"type":"string","description":"Last reported IPv4 address","example":"247.185.82.186"},"lastReportedIpV6":{"type":"string","example":"2001:0db8:85a3:0000:0000:8a2e:0370:7335"},"jamfBinaryVersion":{"type":"string","example":"9.27"},"platform":{"type":"string","example":"Mac"},"barcode1":{"type":"string","example":"5 12345 678900"},"barcode2":{"type":"string","example":"5 12345 678900"},"assetTag":{"type":"string","example":"304822"},"remoteManagement":{"$ref":"#/components/schemas/ComputerRemoteManagement"},"supervised":{"type":"boolean","example":true},"mdmCapable":{"$ref":"#/components/schemas/ComputerMdmCapability"},"reportDate":{"type":"string","format":"date-time","example":"2018-10-31T18:04:13Z"},"lastContactTime":{"type":"string","format":"date-time","example":"2018-10-31T18:04:13Z"},"lastCloudBackupDate":{"type":"string","format":"date-time","example":"2018-10-31T18:04:13Z"},"lastEnrolledDate":{"type":"string","format":"date-time","example":"2018-10-31T18:04:13Z"},"mdmProfileExpiration":{"type":"string","format":"date-time","example":"2018-10-31T18:04:13Z"},"initialEntryDate":{"type":"string","format":"date","example":"2018-10-31"},"distributionPoint":{"type":"string","example":"distribution point name"},"enrollmentMethod":{"$ref":"#/components/schemas/EnrollmentMethod"},"site":{"$ref":"#/components/schemas/ComputerSite"},"itunesStoreAccountActive":{"type":"boolean","example":true},"enrolledViaAutomatedDeviceEnrollment":{"type":"boolean","example":true},"userApprovedMdm":{"type":"boolean","example":true},"declarativeDeviceManagementEnabled":{"type":"boolean","example":true},"appleEnrollmentType":{"type":"string","description":"The enrollment type reported by Apple.","example":"supervised","enum":["none","supervised","device","user","unknown"]},"awaitingConfiguration":{"type":"boolean","description":"Whether the device is awaiting configuration.","example":false},"extensionAttributes":{"type":"array","items":{"$ref":"#/components/schemas/ComputerExtensionAttribute"}},"managementId":{"type":"string","readOnly":true,"example":"73226fb6-61df-4c10-9552-eb9bc353d507"},"lastLoggedInUsernameSelfService":{"type":"string","nullable":true,"example":"admin"},"lastLoggedInUsernameSelfServiceTimestamp":{"type":"string","format":"date-time","nullable":true,"example":"2018-10-31T18:04:13Z"},"lastLoggedInUsernameBinary":{"type":"string","nullable":true,"example":"admin"},"lastLoggedInUsernameBinaryTimestamp":{"type":"string","format":"date-time","nullable":true,"example":"2018-10-31T18:04:13Z"},"lastLoggedInUsernameMdm":{"type":"string","nullable":true,"example":"admin"},"lastLoggedInUsernameMdmTimestamp":{"type":"string","format":"date-time","nullable":true,"example":"2018-10-31T18:04:13Z"}}},"ComputerGeneralCreate":{"required":["name"],"type":"object","properties":{"name":{"minLength":1,"type":"string","example":"Boalime"},"lastIpAddress":{"type":"string","example":"247.185.82.186"},"lastReportedIp":{"type":"string","example":"247.185.82.186"},"jamfBinaryVersion":{"type":"string","example":"9.27"},"platform":{"type":"string","example":"MAC","enum":["WINDOWS","MAC","NONE"]},"barcode1":{"type":"string","example":"5 12345 678900"},"barcode2":{"type":"string","example":"5 12345 678900"},"assetTag":{"type":"string","example":"304822"},"remoteManagement":{"$ref":"#/components/schemas/ComputerRemoteManagementCreate"},"supervised":{"type":"boolean","example":true},"mdmCapable":{"type":"boolean","example":true},"reportDate":{"type":"string","format":"date-time","example":"2018-10-31T18:04:13Z"},"lastContactTime":{"type":"string","format":"date-time","example":"2018-10-31T18:04:13Z"},"lastCloudBackupDate":{"type":"string","format":"date-time","example":"2018-10-31T18:04:13Z"},"lastEnrolledDate":{"type":"string","format":"date-time","example":"2018-10-31T18:04:13Z"},"distributionPointId":{"type":"string","example":"1"},"siteId":{"type":"string","example":"1"},"itunesStoreAccountActive":{"type":"boolean","example":true},"enrolledViaAutomatedDeviceEnrollment":{"type":"boolean","example":true},"userApprovedMdm":{"type":"boolean","example":true},"declarativeDeviceManagementEnabled":{"type":"boolean","example":true}}},"ComputerGeneralCreateV4":{"required":["name"],"type":"object","properties":{"name":{"minLength":1,"type":"string","example":"Boalime"},"lastIpAddress":{"type":"string","example":"247.185.82.186"},"jamfBinaryVersion":{"type":"string","example":"9.27"},"platform":{"type":"string","example":"MAC","enum":["WINDOWS","MAC","NONE"]},"barcode1":{"type":"string","example":"5 12345 678900"},"barcode2":{"type":"string","example":"5 12345 678900"},"assetTag":{"type":"string","example":"304822"},"remoteManagement":{"$ref":"#/components/schemas/ComputerRemoteManagementCreate"},"supervised":{"type":"boolean","example":true},"mdmCapable":{"type":"boolean","example":true},"reportDate":{"type":"string","format":"date-time","example":"2018-10-31T18:04:13Z"},"lastCheckIn":{"type":"string","format":"date-time","example":"2018-10-31T18:04:13Z"},"lastContact":{"type":"string","description":"The most recent time the device communicated with Jamf Pro via any channel\n(binary check-in, MDM ack, or DDM status report).\n","format":"date-time","example":"2018-10-31T18:04:13Z"},"lastCloudBackupDate":{"type":"string","format":"date-time","example":"2018-10-31T18:04:13Z"},"lastEnrolledDate":{"type":"string","format":"date-time","example":"2018-10-31T18:04:13Z"},"distributionPointId":{"type":"string","example":"1"},"siteId":{"type":"string","example":"1"},"itunesStoreAccountActive":{"type":"boolean","example":true},"enrolledViaAutomatedDeviceEnrollment":{"type":"boolean","example":true},"userApprovedMdm":{"type":"boolean","example":true},"declarativeDeviceManagementEnabled":{"type":"boolean","example":true}}},"ComputerGeneralUpdate":{"type":"object","properties":{"name":{"type":"string","example":"Boalime"},"lastIpAddress":{"type":"string","example":"247.185.82.186"},"barcode1":{"type":"string","example":"5 12345 678900"},"barcode2":{"type":"string","example":"5 12345 678900"},"assetTag":{"type":"string","example":"304822"},"managed":{"type":"boolean","example":true},"siteId":{"type":"string","example":"1"},"extensionAttributes":{"type":"array","items":{"$ref":"#/components/schemas/ComputerExtensionAttribute"}}}},"ComputerGeneralV4":{"type":"object","properties":{"name":{"minLength":1,"type":"string","example":"Boalime"},"lastIpAddress":{"type":"string","example":"247.185.82.186"},"lastReportedIpV4":{"type":"string","description":"Last reported IPv4 address","example":"247.185.82.186"},"lastReportedIpV6":{"type":"string","example":"2001:0db8:85a3:0000:0000:8a2e:0370:7335"},"jamfBinaryVersion":{"type":"string","example":"9.27"},"platform":{"type":"string","example":"Mac"},"barcode1":{"type":"string","example":"5 12345 678900"},"barcode2":{"type":"string","example":"5 12345 678900"},"assetTag":{"type":"string","example":"304822"},"remoteManagement":{"$ref":"#/components/schemas/ComputerRemoteManagement"},"supervised":{"type":"boolean","example":true},"mdmCapable":{"$ref":"#/components/schemas/ComputerMdmCapability"},"reportDate":{"type":"string","format":"date-time","example":"2018-10-31T18:04:13Z"},"lastCheckIn":{"type":"string","format":"date-time","example":"2018-10-31T18:04:13Z"},"lastContact":{"type":"string","format":"date-time","example":"2018-10-31T18:04:13Z"},"lastCloudBackupDate":{"type":"string","format":"date-time","example":"2018-10-31T18:04:13Z"},"lastEnrolledDate":{"type":"string","format":"date-time","example":"2018-10-31T18:04:13Z"},"mdmProfileExpiration":{"type":"string","format":"date-time","example":"2018-10-31T18:04:13Z"},"initialEntryDate":{"type":"string","format":"date","example":"2018-10-31"},"distributionPoint":{"type":"string","example":"distribution point name"},"enrollmentMethod":{"$ref":"#/components/schemas/EnrollmentMethod"},"site":{"$ref":"#/components/schemas/ComputerSite"},"itunesStoreAccountActive":{"type":"boolean","example":true},"enrolledViaAutomatedDeviceEnrollment":{"type":"boolean","example":true},"userApprovedMdm":{"type":"boolean","example":true},"declarativeDeviceManagementEnabled":{"type":"boolean","example":true},"appleEnrollmentType":{"type":"string","description":"The enrollment type reported by Apple.","example":"supervised","enum":["none","supervised","device","user","unknown"]},"awaitingConfiguration":{"type":"boolean","description":"Whether the device is awaiting configuration.","example":false},"extensionAttributes":{"type":"array","items":{"$ref":"#/components/schemas/ComputerExtensionAttribute"}},"managementId":{"type":"string","readOnly":true,"example":"73226fb6-61df-4c10-9552-eb9bc353d507"},"lastLoggedInUsernameSelfService":{"type":"string","nullable":true,"example":"admin"},"lastLoggedInUsernameSelfServiceTimestamp":{"type":"string","format":"date-time","nullable":true,"example":"2018-10-31T18:04:13Z"},"lastLoggedInUsernameBinary":{"type":"string","nullable":true,"example":"admin"},"lastLoggedInUsernameBinaryTimestamp":{"type":"string","format":"date-time","nullable":true,"example":"2018-10-31T18:04:13Z"},"lastLoggedInUsernameMdm":{"type":"string","nullable":true,"example":"admin"},"lastLoggedInUsernameMdmTimestamp":{"type":"string","format":"date-time","nullable":true,"example":"2018-10-31T18:04:13Z"}}},"ComputerGroup":{"type":"object","properties":{"id":{"minLength":1,"type":"string","example":"1"},"name":{"type":"string","example":"All Managed Computers"},"description":{"type":"string","example":"A group containing all managed computers"},"smartGroup":{"type":"boolean","example":true}}},"ComputerHardware":{"type":"object","properties":{"make":{"type":"string","readOnly":true,"example":"Apple"},"model":{"type":"string","readOnly":true,"example":"13-inch MacBook Pro (Mid 2012)"},"modelIdentifier":{"type":"string","readOnly":true,"example":"MacBookPro9,2"},"serialNumber":{"type":"string","readOnly":true,"example":"C02ZC2QYLVDL"},"processorSpeedMhz":{"type":"integer","description":"Processor Speed in MHz.","format":"int64","readOnly":true,"example":2100},"processorCount":{"type":"integer","readOnly":true,"example":2},"coreCount":{"type":"integer","readOnly":true,"example":2},"processorType":{"type":"string","readOnly":true,"example":"Intel Core i5"},"processorArchitecture":{"type":"string","readOnly":true,"example":"i386"},"busSpeedMhz":{"type":"integer","format":"int64","readOnly":true,"example":2133},"cacheSizeKilobytes":{"type":"integer","description":"Cache Size in KB.","format":"int64","readOnly":true,"example":3072},"networkAdapterType":{"type":"string","example":"Foo"},"macAddress":{"type":"string","example":"6A:2C:4B:B7:65:B5"},"altNetworkAdapterType":{"type":"string","example":"Bar"},"altMacAddress":{"type":"string","example":"82:45:58:44:dc:01"},"totalRamMegabytes":{"type":"integer","description":"Total RAM Size in MB.","format":"int64","readOnly":true,"example":4096},"openRamSlots":{"type":"integer","description":"Available RAM slots.","readOnly":true,"example":0},"batteryCapacityPercent":{"maximum":100,"minimum":0,"type":"integer","description":"Remaining percentage of battery power.","readOnly":true,"example":85},"batteryHealth":{"type":"string","description":"- NON_GENUINE: The battery isn’t a genuine Apple battery.\n- NORMAL: The battery is operating normally.\n- SERVICE_RECOMMENDED: The system recommends battery service.\n- UNKNOWN: The system couldn’t determine battery health information.\n- UNSUPPORTED: The device doesn’t support battery health reporting.\n","readOnly":true,"enum":["NON_GENUINE","NORMAL","SERVICE_RECOMMENDED","UNKNOWN","UNSUPPORTED"],"default":"UNKNOWN"},"smcVersion":{"type":"string","readOnly":true,"example":"2.2f38"},"nicSpeed":{"type":"string","readOnly":true,"example":"N/A"},"opticalDrive":{"type":"string","readOnly":true,"example":"MATSHITA DVD-R UJ-8A8"},"bootRom":{"type":"string","readOnly":true,"example":"MBP91.00D3.B08"},"bleCapable":{"type":"boolean","readOnly":true,"example":false},"supportsIosAppInstalls":{"type":"boolean","readOnly":true,"example":false},"appleSilicon":{"type":"boolean","readOnly":true,"example":false},"provisioningUdid":{"type":"string","readOnly":true,"example":"00000AAA888-IH866799UUJD991"},"extensionAttributes":{"type":"array","items":{"$ref":"#/components/schemas/ComputerExtensionAttribute"}}}},"ComputerHardwareCreate":{"type":"object","properties":{"make":{"type":"string","example":"Apple"},"model":{"type":"string","example":"13-inch MacBook Pro (Mid 2012)"},"modelIdentifier":{"type":"string","example":"MacBookPro9,2"},"serialNumber":{"type":"string","example":"C02ZC2QYLVDL"},"processorSpeedMhz":{"type":"integer","description":"Processor Speed in MHz.","format":"int64","example":2100},"processorCount":{"type":"integer","example":2},"coreCount":{"type":"integer","example":2},"processorType":{"type":"string","example":"Intel Core i5"},"processorArchitecture":{"type":"string","example":"i386"},"busSpeedMhz":{"type":"integer","format":"int64","example":2133},"cacheSizeKilobytes":{"type":"integer","description":"Cache Size in KB.","format":"int64","example":3072},"networkAdapterType":{"type":"string","example":"Foo"},"macAddress":{"type":"string","example":"6A:2C:4B:B7:65:B5"},"altNetworkAdapterType":{"type":"string","example":"Bar"},"altMacAddress":{"type":"string","example":"82:45:58:44:dc:01"},"totalRamMegabytes":{"type":"integer","description":"Total RAM Size in MB.","format":"int64","example":4096},"openRamSlots":{"type":"integer","description":"Available RAM slots.","example":0},"batteryCapacityPercent":{"maximum":100,"minimum":0,"type":"integer","description":"Remaining percentage of battery power.","example":85},"batteryHealth":{"type":"string","description":"- NON_GENUINE: The battery isn’t a genuine Apple battery.\n- NORMAL: The battery is operating normally.\n- SERVICE_RECOMMENDED: The system recommends battery service.\n- UNKNOWN: The system couldn’t determine battery health information.\n- UNSUPPORTED: The device doesn’t support battery health reporting.\n","enum":["NON_GENUINE","NORMAL","SERVICE_RECOMMENDED","UNKNOWN","UNSUPPORTED"],"default":"UNKNOWN"},"smcVersion":{"type":"string","example":"2.2f38"},"nicSpeed":{"type":"string","example":"N/A"},"opticalDrive":{"type":"string","example":"MATSHITA DVD-R UJ-8A8"},"bootRom":{"type":"string","example":"MBP91.00D3.B08"},"bleCapable":{"type":"boolean","example":false},"supportsIosAppInstalls":{"type":"boolean","example":false},"appleSilicon":{"type":"boolean","example":false}}},"ComputerHardwareUpdate":{"type":"object","properties":{"networkAdapterType":{"type":"string","example":"Foo"},"macAddress":{"type":"string","example":"6A:2C:4B:B7:65:B5"},"altNetworkAdapterType":{"type":"string","example":"Bar"},"altMacAddress":{"type":"string","example":"82:45:58:44:dc:01"},"extensionAttributes":{"type":"array","items":{"$ref":"#/components/schemas/ComputerExtensionAttribute"}}}},"ComputerIbeacon":{"type":"object","properties":{"name":{"type":"string","example":"room A"}}},"ComputerInventory":{"type":"object","properties":{"id":{"minLength":1,"type":"string","readOnly":true,"example":"1"},"udid":{"type":"string","example":"123"},"general":{"$ref":"#/components/schemas/ComputerGeneral"},"diskEncryption":{"$ref":"#/components/schemas/ComputerDiskEncryption"},"purchasing":{"$ref":"#/components/schemas/ComputerPurchase"},"applications":{"type":"array","items":{"$ref":"#/components/schemas/ComputerApplication"}},"storage":{"$ref":"#/components/schemas/ComputerStorage"},"userAndLocation":{"$ref":"#/components/schemas/ComputerUserAndLocation"},"configurationProfiles":{"type":"array","items":{"$ref":"#/components/schemas/ComputerConfigurationProfile"}},"printers":{"type":"array","items":{"$ref":"#/components/schemas/ComputerPrinter"}},"services":{"type":"array","items":{"$ref":"#/components/schemas/ComputerService"}},"hardware":{"$ref":"#/components/schemas/ComputerHardware"},"localUserAccounts":{"type":"array","items":{"$ref":"#/components/schemas/ComputerLocalUserAccount"}},"certificates":{"type":"array","items":{"$ref":"#/components/schemas/ComputerCertificate"}},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ComputerAttachment"}},"plugins":{"type":"array","items":{"type":"object"}},"packageReceipts":{"$ref":"#/components/schemas/ComputerPackageReceipts"},"fonts":{"type":"array","items":{"$ref":"#/components/schemas/ComputerFont"}},"security":{"$ref":"#/components/schemas/ComputerSecurity"},"operatingSystem":{"$ref":"#/components/schemas/ComputerOperatingSystem"},"licensedSoftware":{"type":"array","items":{"$ref":"#/components/schemas/ComputerLicensedSoftware"}},"ibeacons":{"type":"array","items":{"$ref":"#/components/schemas/ComputerIbeacon"}},"softwareUpdates":{"type":"array","items":{"$ref":"#/components/schemas/ComputerSoftwareUpdate"}},"extensionAttributes":{"type":"array","items":{"$ref":"#/components/schemas/ComputerExtensionAttribute"}},"contentCaching":{"$ref":"#/components/schemas/ComputerContentCaching"},"groupMemberships":{"type":"array","items":{"$ref":"#/components/schemas/GroupMembership"}}}},"ComputerInventoryCollectionPreferences":{"type":"object","properties":{"monitorApplicationUsage":{"type":"boolean","example":true,"default":false},"includeFonts":{"type":"boolean","readOnly":true,"example":true,"default":false},"includePlugins":{"type":"boolean","example":true,"default":false},"includePackages":{"type":"boolean","example":true,"default":false},"includeSoftwareUpdates":{"type":"boolean","example":true,"default":false},"includeSoftwareId":{"type":"boolean","example":true,"default":false},"includeAccounts":{"type":"boolean","example":true,"default":false},"calculateSizes":{"type":"boolean","example":false,"default":false},"includeHiddenAccounts":{"type":"boolean","example":true,"default":false},"includePrinters":{"type":"boolean","example":true,"default":false},"includeServices":{"type":"boolean","example":true,"default":false},"collectSyncedMobileDeviceInfo":{"type":"boolean","example":false,"default":false},"updateLdapInfoOnComputerInventorySubmissions":{"type":"boolean","example":false,"default":false},"monitorBeacons":{"type":"boolean","example":true,"default":false},"allowChangingUserAndLocation":{"type":"boolean","example":true,"default":true},"useUnixUserPaths":{"type":"boolean","example":true,"default":true},"collectUnmanagedCertificates":{"type":"boolean","example":true,"default":true}}},"ComputerInventoryCollectionPreferencesV2":{"type":"object","properties":{"monitorApplicationUsage":{"type":"boolean","nullable":false,"example":true,"default":false},"includePackages":{"type":"boolean","example":true,"default":false},"includeSoftwareUpdates":{"type":"boolean","example":true,"default":false},"includeSoftwareId":{"type":"boolean","example":true,"default":false},"includeAccounts":{"type":"boolean","example":true,"default":false},"calculateSizes":{"type":"boolean","example":false,"default":false},"includeHiddenAccounts":{"type":"boolean","example":true,"default":false},"includePrinters":{"type":"boolean","example":true,"default":false},"includeServices":{"type":"boolean","example":true,"default":false},"collectSyncedMobileDeviceInfo":{"type":"boolean","example":false,"default":false},"updateLdapInfoOnComputerInventorySubmissions":{"type":"boolean","example":false,"default":false},"monitorBeacons":{"type":"boolean","example":true,"default":false},"allowChangingUserAndLocation":{"type":"boolean","example":true,"default":true},"useUnixUserPaths":{"type":"boolean","example":true,"default":true},"collectUnmanagedCertificates":{"type":"boolean","example":true,"default":true}}},"ComputerInventoryCollectionSettings":{"type":"object","properties":{"computerInventoryCollectionPreferences":{"$ref":"#/components/schemas/ComputerInventoryCollectionPreferences"},"applicationPaths":{"type":"array","items":{"$ref":"#/components/schemas/AppPath"}},"fontPaths":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/FontPath"}},"pluginPaths":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/PluginPath"}}}},"ComputerInventoryCollectionSettingsV2":{"type":"object","properties":{"computerInventoryCollectionPreferences":{"$ref":"#/components/schemas/ComputerInventoryCollectionPreferencesV2"},"applicationPaths":{"type":"array","nullable":false,"items":{"$ref":"#/components/schemas/AppPath"}}}},"ComputerInventoryCreateRequest":{"type":"object","properties":{"udid":{"type":"string","nullable":true,"example":"45436edf-864e-4364-982a-330b01d39e65"},"general":{"$ref":"#/components/schemas/ComputerGeneralCreate"},"applications":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ComputerApplicationCreate"}},"storage":{"$ref":"#/components/schemas/ComputerStorageCreate"},"configurationProfiles":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ComputerConfigurationProfileCreate"}},"printers":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ComputerPrinterCreate"}},"services":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ComputerServiceCreate"}},"localUserAccounts":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ComputerLocalUserAccountCreate"}},"certificates":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ComputerCertificateCreate"}},"plugins":{"type":"array","nullable":true,"example":[],"items":{"type":"object"}},"packageReceipts":{"$ref":"#/components/schemas/ComputerPackageReceiptsCreate"},"fonts":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ComputerFontCreate"}},"security":{"$ref":"#/components/schemas/ComputerSecurityCreate"},"softwareUpdates":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ComputerSoftwareUpdateCreate"}},"purchasing":{"$ref":"#/components/schemas/ComputerPurchaseCreate"},"userAndLocation":{"$ref":"#/components/schemas/ComputerUserAndLocationCreate"},"hardware":{"$ref":"#/components/schemas/ComputerHardwareCreate"},"operatingSystem":{"$ref":"#/components/schemas/ComputerOperatingSystemCreate"}}},"ComputerInventoryCreateRequestV2":{"type":"object","properties":{"udid":{"type":"string","nullable":true,"example":"45436edf-864e-4364-982a-330b01d39e65"},"general":{"$ref":"#/components/schemas/ComputerGeneralCreate"},"applications":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ComputerApplicationCreate"}},"storage":{"$ref":"#/components/schemas/ComputerStorageCreate"},"security":{"$ref":"#/components/schemas/ComputerSecurityCreate"},"configurationProfiles":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ComputerConfigurationProfileCreate"}},"printers":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ComputerPrinterCreate"}},"services":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ComputerServiceCreate"}},"localUserAccounts":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ComputerLocalUserAccountCreate"}},"certificates":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ComputerCertificateCreate"}},"packageReceipts":{"$ref":"#/components/schemas/ComputerPackageReceiptsCreate"},"softwareUpdates":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ComputerSoftwareUpdateCreate"}},"purchasing":{"$ref":"#/components/schemas/ComputerPurchaseCreate"},"userAndLocation":{"$ref":"#/components/schemas/ComputerUserAndLocationCreate"},"hardware":{"$ref":"#/components/schemas/ComputerHardwareCreate"},"operatingSystem":{"$ref":"#/components/schemas/ComputerOperatingSystemCreate"}}},"ComputerInventoryCreateRequestV4":{"type":"object","properties":{"udid":{"type":"string","nullable":true,"example":"45436edf-864e-4364-982a-330b01d39e65"},"general":{"$ref":"#/components/schemas/ComputerGeneralCreateV4"},"applications":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ComputerApplicationCreate"}},"storage":{"$ref":"#/components/schemas/ComputerStorageCreate"},"security":{"$ref":"#/components/schemas/ComputerSecurityCreate"},"configurationProfiles":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ComputerConfigurationProfileCreate"}},"services":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ComputerServiceCreate"}},"hardware":{"$ref":"#/components/schemas/ComputerHardwareCreate"},"localUserAccounts":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ComputerLocalUserAccountCreate"}},"certificates":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ComputerCertificateCreate"}},"packageReceipts":{"$ref":"#/components/schemas/ComputerPackageReceiptsCreate"},"userAndLocation":{"$ref":"#/components/schemas/ComputerUserAndLocationCreate"},"purchasing":{"$ref":"#/components/schemas/ComputerPurchaseCreate"},"operatingSystem":{"$ref":"#/components/schemas/ComputerOperatingSystemCreate"},"softwareUpdates":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ComputerSoftwareUpdateCreate"}},"printers":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ComputerPrinterCreate"}}}},"ComputerInventoryDeviceLockPinResponse":{"type":"object","properties":{"pin":{"maxLength":6,"minLength":6,"type":"string","readOnly":true,"example":"123456"}}},"ComputerInventoryFileVault":{"type":"object","properties":{"computerId":{"type":"string","readOnly":true,"example":"1"},"name":{"type":"string","example":"Boalime"},"personalRecoveryKey":{"type":"string","example":"Z4A6-ONF8-KUHD-AVTG-C3ER-6A8G"},"bootPartitionEncryptionDetails":{"$ref":"#/components/schemas/ComputerPartitionEncryption"},"individualRecoveryKeyValidityStatus":{"type":"string","example":"VALID","enum":["VALID","INVALID","UNKNOWN","NOT_APPLICABLE"]},"institutionalRecoveryKeyPresent":{"type":"boolean","example":true},"diskEncryptionConfigurationName":{"type":"string","example":"Test configuration"}}},"ComputerInventoryFileVaultSearchResults":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":3},"results":{"type":"array","items":{"$ref":"#/components/schemas/ComputerInventoryFileVault"}}}},"ComputerInventoryRecoveryLockPasswordResponse":{"type":"object","properties":{"recoveryLockPassword":{"type":"string","format":"password","readOnly":true,"example":"password123"}}},"ComputerInventorySearchResults":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":3},"results":{"type":"array","items":{"$ref":"#/components/schemas/ComputerInventory"}}}},"ComputerInventorySearchResultsV2":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":3},"results":{"type":"array","items":{"$ref":"#/components/schemas/ComputerInventoryV2"}}}},"ComputerInventorySearchResultsV3":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":3},"results":{"type":"array","items":{"$ref":"#/components/schemas/ComputerInventoryV3"}}}},"ComputerInventorySearchResultsV4":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":3},"results":{"type":"array","items":{"$ref":"#/components/schemas/ComputerInventoryV4"}}}},"ComputerInventoryUpdateRequest":{"type":"object","properties":{"udid":{"type":"string","example":"45436edf-864e-4364-982a-330b01d39e65"},"general":{"$ref":"#/components/schemas/ComputerGeneralUpdate"},"purchasing":{"$ref":"#/components/schemas/ComputerPurchase"},"userAndLocation":{"$ref":"#/components/schemas/ComputerUserAndLocation"},"hardware":{"$ref":"#/components/schemas/ComputerHardwareUpdate"},"operatingSystem":{"$ref":"#/components/schemas/ComputerOperatingSystemUpdate"},"extensionAttributes":{"type":"array","items":{"$ref":"#/components/schemas/ComputerExtensionAttribute"}}}},"ComputerInventoryV2":{"type":"object","properties":{"id":{"minLength":1,"type":"string","readOnly":true,"example":"1"},"udid":{"type":"string","example":"123"},"general":{"$ref":"#/components/schemas/ComputerGeneral"},"diskEncryption":{"$ref":"#/components/schemas/ComputerDiskEncryption"},"purchasing":{"$ref":"#/components/schemas/ComputerPurchase"},"applications":{"type":"array","items":{"$ref":"#/components/schemas/ComputerApplication"}},"storage":{"$ref":"#/components/schemas/ComputerStorage"},"userAndLocation":{"$ref":"#/components/schemas/ComputerUserAndLocation"},"configurationProfiles":{"type":"array","items":{"$ref":"#/components/schemas/ComputerConfigurationProfile"}},"printers":{"type":"array","items":{"$ref":"#/components/schemas/ComputerPrinter"}},"services":{"type":"array","items":{"$ref":"#/components/schemas/ComputerService"}},"hardware":{"$ref":"#/components/schemas/ComputerHardware"},"localUserAccounts":{"type":"array","items":{"$ref":"#/components/schemas/ComputerLocalUserAccount"}},"certificates":{"type":"array","items":{"$ref":"#/components/schemas/ComputerCertificate"}},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ComputerAttachment"}},"packageReceipts":{"$ref":"#/components/schemas/ComputerPackageReceipts"},"security":{"$ref":"#/components/schemas/ComputerSecurity"},"operatingSystem":{"$ref":"#/components/schemas/ComputerOperatingSystem"},"licensedSoftware":{"type":"array","items":{"$ref":"#/components/schemas/ComputerLicensedSoftware"}},"ibeacons":{"type":"array","items":{"$ref":"#/components/schemas/ComputerIbeacon"}},"softwareUpdates":{"type":"array","items":{"$ref":"#/components/schemas/ComputerSoftwareUpdate"}},"extensionAttributes":{"type":"array","items":{"$ref":"#/components/schemas/ComputerExtensionAttribute"}},"contentCaching":{"$ref":"#/components/schemas/ComputerContentCaching"},"groupMemberships":{"type":"array","items":{"$ref":"#/components/schemas/GroupMembership"}}}},"ComputerInventoryV3":{"type":"object","properties":{"id":{"minLength":1,"type":"string","readOnly":true,"example":"1"},"udid":{"type":"string","example":"123"},"general":{"$ref":"#/components/schemas/ComputerGeneral"},"diskEncryption":{"$ref":"#/components/schemas/ComputerDiskEncryption"},"purchasing":{"$ref":"#/components/schemas/ComputerPurchase"},"applications":{"type":"array","items":{"$ref":"#/components/schemas/ComputerApplicationV3"}},"storage":{"$ref":"#/components/schemas/ComputerStorage"},"userAndLocation":{"$ref":"#/components/schemas/ComputerUserAndLocation"},"configurationProfiles":{"type":"array","items":{"$ref":"#/components/schemas/ComputerConfigurationProfile"}},"printers":{"type":"array","items":{"$ref":"#/components/schemas/ComputerPrinter"}},"services":{"type":"array","items":{"$ref":"#/components/schemas/ComputerService"}},"hardware":{"$ref":"#/components/schemas/ComputerHardware"},"localUserAccounts":{"type":"array","items":{"$ref":"#/components/schemas/ComputerLocalUserAccount"}},"certificates":{"type":"array","items":{"$ref":"#/components/schemas/ComputerCertificate"}},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ComputerAttachment"}},"packageReceipts":{"$ref":"#/components/schemas/ComputerPackageReceipts"},"security":{"$ref":"#/components/schemas/ComputerSecurity"},"operatingSystem":{"$ref":"#/components/schemas/ComputerOperatingSystem"},"licensedSoftware":{"type":"array","items":{"$ref":"#/components/schemas/ComputerLicensedSoftware"}},"ibeacons":{"type":"array","items":{"$ref":"#/components/schemas/ComputerIbeacon"}},"softwareUpdates":{"type":"array","items":{"$ref":"#/components/schemas/ComputerSoftwareUpdate"}},"extensionAttributes":{"type":"array","items":{"$ref":"#/components/schemas/ComputerExtensionAttribute"}},"contentCaching":{"$ref":"#/components/schemas/ComputerContentCaching"},"groupMemberships":{"type":"array","items":{"$ref":"#/components/schemas/GroupMembership"}}}},"ComputerInventoryV4":{"type":"object","properties":{"id":{"minLength":1,"type":"string","readOnly":true,"example":"1"},"udid":{"type":"string","example":"123"},"general":{"$ref":"#/components/schemas/ComputerGeneralV4"},"diskEncryption":{"$ref":"#/components/schemas/ComputerDiskEncryption"},"purchasing":{"$ref":"#/components/schemas/ComputerPurchase"},"applications":{"type":"array","items":{"$ref":"#/components/schemas/ComputerApplicationV3"}},"storage":{"$ref":"#/components/schemas/ComputerStorage"},"userAndLocation":{"$ref":"#/components/schemas/ComputerUserAndLocation"},"configurationProfiles":{"type":"array","items":{"$ref":"#/components/schemas/ComputerConfigurationProfile"}},"printers":{"type":"array","items":{"$ref":"#/components/schemas/ComputerPrinter"}},"services":{"type":"array","items":{"$ref":"#/components/schemas/ComputerService"}},"hardware":{"$ref":"#/components/schemas/ComputerHardware"},"localUserAccounts":{"type":"array","items":{"$ref":"#/components/schemas/ComputerLocalUserAccount"}},"certificates":{"type":"array","items":{"$ref":"#/components/schemas/ComputerCertificate"}},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ComputerAttachment"}},"packageReceipts":{"$ref":"#/components/schemas/ComputerPackageReceipts"},"security":{"$ref":"#/components/schemas/ComputerSecurity"},"operatingSystem":{"$ref":"#/components/schemas/ComputerOperatingSystem"},"licensedSoftware":{"type":"array","items":{"$ref":"#/components/schemas/ComputerLicensedSoftware"}},"ibeacons":{"type":"array","items":{"$ref":"#/components/schemas/ComputerIbeacon"}},"softwareUpdates":{"type":"array","items":{"$ref":"#/components/schemas/ComputerSoftwareUpdate"}},"extensionAttributes":{"type":"array","items":{"$ref":"#/components/schemas/ComputerExtensionAttribute"}},"contentCaching":{"$ref":"#/components/schemas/ComputerContentCaching"},"groupMemberships":{"type":"array","items":{"$ref":"#/components/schemas/GroupMembership"}}}},"ComputerLicensedSoftware":{"type":"object","properties":{"id":{"type":"string","example":"1"},"name":{"type":"string","example":"Microsoft Word"}}},"ComputerLocalUserAccount":{"type":"object","properties":{"uid":{"type":"string","example":"501"},"userGuid":{"type":"string","readOnly":true,"example":"844F1177-0CF5-40C6-901F-38EDD9969C1C"},"username":{"type":"string","example":"jamf"},"fullName":{"type":"string","example":"John Jamf"},"admin":{"type":"boolean","example":true},"homeDirectory":{"type":"string","example":"/Users/jamf"},"homeDirectorySizeMb":{"type":"integer","description":"Home directory size in MB.","format":"int64","readOnly":true,"example":131072},"fileVault2Enabled":{"type":"boolean","example":true},"userAccountType":{"type":"string","example":"LOCAL","enum":["LOCAL","MOBILE","UNKNOWN"]},"passwordMinLength":{"type":"integer","example":4},"passwordMaxAge":{"type":"integer","example":5},"passwordMinComplexCharacters":{"type":"integer","example":5},"passwordHistoryDepth":{"type":"integer","example":5},"passwordRequireAlphanumeric":{"type":"boolean","example":true},"computerAzureActiveDirectoryId":{"type":"string","example":"1"},"userAzureActiveDirectoryId":{"type":"string","example":"1"},"azureActiveDirectoryId":{"type":"string","example":"ACTIVATED","enum":["ACTIVATED","DEACTIVATED","UNRESPONSIVE","UNKNOWN"]}}},"ComputerLocalUserAccountCreate":{"type":"object","properties":{"uid":{"type":"string","nullable":true,"example":"501"},"userGuid":{"type":"string","nullable":true,"example":"844F1177-0CF5-40C6-901F-38EDD9969C1C"},"username":{"type":"string","nullable":true,"example":"jamf"},"fullName":{"type":"string","nullable":true,"example":"John Jamf"},"admin":{"type":"boolean","nullable":true,"example":true},"homeDirectory":{"type":"string","nullable":true,"example":"/Users/jamf"},"homeDirectorySizeMb":{"type":"integer","description":"Home directory size in MB.","format":"int64","nullable":true,"example":131072},"fileVault2Enabled":{"type":"boolean","nullable":true,"example":true},"userAccountType":{"type":"string","nullable":true,"example":"LOCAL","enum":["LOCAL","MOBILE","UNKNOWN"]},"passwordMinLength":{"type":"integer","nullable":true,"example":4},"passwordMaxAge":{"type":"integer","nullable":true,"example":5},"passwordMinComplexCharacters":{"type":"integer","nullable":true,"example":5},"passwordHistoryDepth":{"type":"integer","nullable":true,"example":5},"passwordRequireAlphanumeric":{"type":"boolean","nullable":true,"example":true},"computerAzureActiveDirectoryId":{"type":"string","nullable":true,"example":"1"},"userAzureActiveDirectoryId":{"type":"string","nullable":true,"example":"1"}}},"ComputerLocation":{"type":"object","properties":{"username":{"type":"string","example":"admin"},"position":{"type":"string","example":"IT Team Lead"},"room":{"type":"string","example":"4th Floor - Quad 3"}}},"ComputerMdmCapability":{"type":"object","properties":{"capable":{"type":"boolean","example":true},"capableUsers":{"type":"array","description":"Deprecated. Use userManagementInfo instead.","example":["admin","rootadmin"],"deprecated":true,"items":{"type":"string"}},"userManagementInfo":{"type":"array","items":{"$ref":"#/components/schemas/ComputerUserManagementInfo"}}}},"ComputerOperatingSystem":{"type":"object","properties":{"name":{"type":"string","readOnly":true,"example":"Mac OS X"},"version":{"type":"string","readOnly":true,"example":"10.9.5"},"build":{"type":"string","readOnly":true,"example":"13A603"},"supplementalBuildVersion":{"type":"string","description":"Collected for macOS 13.0 or later","readOnly":true,"example":"13A953"},"rapidSecurityResponse":{"type":"string","description":"Collected for macOS 13.0 or later","readOnly":true,"example":"(a)"},"activeDirectoryStatus":{"type":"string","readOnly":true,"example":"Not Bound"},"fileVault2Status":{"type":"string","example":"ALL_ENCRYPTED","enum":["NOT_APPLICABLE","NOT_ENCRYPTED","BOOT_ENCRYPTED","SOME_ENCRYPTED","ALL_ENCRYPTED"]},"softwareUpdateDeviceId":{"type":"string","readOnly":true,"example":"J132AP"},"extensionAttributes":{"type":"array","items":{"$ref":"#/components/schemas/ComputerExtensionAttribute"}}}},"ComputerOperatingSystemCreate":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Mac OS X"},"version":{"type":"string","nullable":true,"example":"10.9.5"},"build":{"type":"string","nullable":true,"example":"13A603"},"supplementalBuildVersion":{"type":"string","nullable":true,"example":"13A953"},"rapidSecurityResponse":{"type":"string","nullable":true,"example":"(a)"},"activeDirectoryStatus":{"type":"string","nullable":true,"example":"Not Bound"},"softwareUpdateDeviceId":{"type":"string","nullable":true,"example":"J132AP"}}},"ComputerOperatingSystemUpdate":{"type":"object","properties":{"extensionAttributes":{"type":"array","items":{"$ref":"#/components/schemas/ComputerExtensionAttribute"}}}},"ComputerOverview":{"type":"object","properties":{"id":{"minLength":1,"type":"string","example":"7"},"location":{"$ref":"#/components/schemas/ComputerLocation"},"name":{"type":"string","example":"Zach's hand me down MacBook Pro"},"udid":{"type":"string","example":"6E47EF55-5318-494F-A09E-70F613E0AFD1"},"serialNumber":{"type":"string","example":"C02L29ECF8J1"},"lastContactDate":{"type":"string","example":"2000-04-25T21:09:31.661Z"},"lastReportDate":{"type":"string","example":"2000-04-25T21:09:31.661Z"},"lastEnrolledDate":{"type":"string","example":"2000-04-25T21:09:31.661Z"},"operatingSystemVersion":{"type":"string","example":"10.9.5"},"operatingSystemBuild":{"type":"string","example":"TK421"},"operatingSystemSupplementalBuildVersion":{"type":"string","description":"Collected for macOS 13.0 or later","example":"TK953"},"operatingSystemRapidSecurityResponse":{"type":"string","description":"Collected for macOS 13.0 or later","example":"(a)"},"ipAddress":{"type":"string","example":"93.184.216.34"},"macAddress":{"type":"string","example":"F3:7C:6F:2C:B6:76"},"assetTag":{"type":"string","example":"A123BC"},"modelIdentifier":{"type":"string","example":"MNYF2XX/A"},"mdmAccessRights":{"type":"integer","example":1},"isManaged":{"type":"boolean","example":true},"managementId":{"type":"string","readOnly":true,"example":"73226fb6-61df-4c10-9552-eb9bc353d507"}}},"ComputerPackageReceipts":{"type":"object","properties":{"installedByJamfPro":{"type":"array","items":{"type":"string","example":"com.jamf.protect.JamfProtect"}},"installedByInstallerSwu":{"type":"array","items":{"type":"string","example":"com.apple.pkg.Core"}},"cached":{"type":"array","items":{"type":"string","example":"com.jamf.protect.JamfProtect"}}},"description":"All package receipts are listed by their package name"},"ComputerPackageReceiptsCreate":{"type":"object","properties":{"installedByJamfPro":{"type":"array","nullable":true,"items":{"type":"string","example":"com.jamf.protect.JamfProtect"}},"installedByInstallerSwu":{"type":"array","nullable":true,"items":{"type":"string","example":"com.apple.pkg.Core"}},"cached":{"type":"array","nullable":true,"items":{"type":"string","example":"com.jamf.protect.JamfProtect"}}},"description":"All package receipts are listed by their package name"},"ComputerPartition":{"type":"object","properties":{"name":{"type":"string","readOnly":true,"example":"Foo"},"sizeMegabytes":{"type":"integer","description":"Partition Size in MB.","format":"int64","readOnly":true,"example":262144},"availableMegabytes":{"type":"integer","description":"Available space in MB.","format":"int64","readOnly":true,"example":131072},"partitionType":{"type":"string","readOnly":true,"example":"BOOT","enum":["BOOT","RECOVERY","OTHER"]},"percentUsed":{"maximum":100,"minimum":0,"type":"integer","description":"Percentage of space used.","readOnly":true,"example":25},"fileVault2State":{"$ref":"#/components/schemas/ComputerPartitionFileVault2State"},"fileVault2ProgressPercent":{"type":"integer","description":"Percentage progress of current FileVault 2 operation.","nullable":true,"example":45},"lvmManaged":{"type":"boolean","readOnly":true,"example":true}}},"ComputerPartitionCreate":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Foo"},"sizeMegabytes":{"type":"integer","description":"Partition Size in MB.","format":"int64","nullable":true,"example":262144},"availableMegabytes":{"type":"integer","description":"Available space in MB.","format":"int64","nullable":true,"example":131072},"partitionType":{"type":"string","nullable":true,"example":"BOOT","enum":["BOOT","RECOVERY","OTHER"]},"percentUsed":{"maximum":100,"minimum":0,"type":"integer","description":"Percentage of space used.","nullable":true,"example":25},"fileVault2State":{"$ref":"#/components/schemas/ComputerPartitionFileVault2State"},"fileVault2ProgressPercent":{"type":"integer","description":"Percentage progress of current FileVault 2 operation.","nullable":true,"example":45},"lvmManaged":{"type":"boolean","nullable":true,"example":true}}},"ComputerPartitionEncryption":{"type":"object","properties":{"partitionName":{"type":"string","example":"main"},"partitionFileVault2State":{"$ref":"#/components/schemas/ComputerPartitionFileVault2State"},"partitionFileVault2Percent":{"type":"integer","example":100}}},"ComputerPartitionFileVault2State":{"type":"string","example":"ENCRYPTING","enum":["UNKNOWN","UNENCRYPTED","INELIGIBLE","DECRYPTED","DECRYPTING","ENCRYPTED","ENCRYPTING","RESTART_NEEDED","OPTIMIZING","DECRYPTING_PAUSED","ENCRYPTING_PAUSED"]},"ComputerPrestageSearchResultsV3":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":1},"results":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/GetComputerPrestageV3"}}}},"ComputerPrestageV3":{"allOf":[{"$ref":"#/components/schemas/DeviceEnrollmentPrestageV2"},{"required":["customPackageDistributionPointId","customPackageIds","installProfilesDuringSetup","prestageInstalledProfileIds"],"type":"object","properties":{"installProfilesDuringSetup":{"type":"boolean","nullable":false,"example":true},"prestageInstalledProfileIds":{"type":"array","items":{"type":"string","example":"1"}},"customPackageIds":{"type":"array","items":{"type":"string","example":"1"}},"customPackageDistributionPointId":{"type":"string","example":"1"},"enableRecoveryLock":{"type":"boolean","nullable":false,"example":true},"recoveryLockPasswordType":{"type":"string","nullable":false,"example":"MANUAL","enum":["MANUAL","RANDOM"]},"rotateRecoveryLockPassword":{"type":"boolean","nullable":false,"example":true},"prestageMinimumOsTargetVersionType":{"type":"string","nullable":false,"example":"MINIMUM_OS_LATEST_VERSION","enum":["NO_ENFORCEMENT","MINIMUM_OS_LATEST_VERSION","MINIMUM_OS_LATEST_MAJOR_VERSION","MINIMUM_OS_LATEST_MINOR_VERSION","MINIMUM_OS_SPECIFIC_VERSION"]},"minimumOsSpecificVersion":{"minLength":0,"type":"string","nullable":false,"example":"17.1"},"pssoEnabled":{"type":"boolean","description":"Indicates whether Platform SSO (PSSO) is enabled for this computer prestage, regardless of Device first or Identity first workflows. When enabled, the PSSO application will be deployed to devices during the setup process to facilitate single sign-on (SSO) for users.","example":true,"default":false},"platformSsoAppBundleId":{"type":"string","description":"The bundle identifier for the Platform SSO (PSSO) application Device first workflow. This identifier is used to specify which PSSO app should be deployed to devices during the setup process.","example":"com.okta.mobile"},"profileUrl":{"type":"string","description":"The URL to the configuration profile for the Platform SSO (PSSO) application Identity first workflow. This URL is used when deploying the PSSO app to devices during the setup process. Users should use either profileUrl or populate pssoConfigProfileId, but not both.","nullable":true,"example":"https://mdmserver.example.com/psso.mobileconfig"},"pssoConfigProfileId":{"type":"string","description":"The identifier for the configuration profile associated with the Platform SSO (PSSO) application Identity first workflow. This ID is used to specify which configuration profile should be applied to devices during the setup process when PSSO is enabled. Users should use either pssoConfigProfileId or populate profileUrl, but not both.","nullable":true,"example":"1"},"manifestUrl":{"type":"string","description":"The URL to the manifest file for the Platform SSO (PSSO) application Identity first workflow. This URL is used when deploying the PSSO app to devices during the setup process.","nullable":true,"example":"https://mdmserver.example.com/psso-app.plist"}}}]},"ComputerPrinter":{"type":"object","properties":{"name":{"type":"string","example":"My Printer"},"type":{"type":"string","example":"XYZ 1122"},"uri":{"type":"string","example":"ipp://10.0.0.5"},"location":{"type":"string","example":"7th floor"}}},"ComputerPrinterCreate":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"My Printer"},"type":{"type":"string","nullable":true,"example":"XYZ 1122"},"uri":{"type":"string","nullable":true,"example":"ipp://10.0.0.5"},"location":{"type":"string","nullable":true,"example":"7th floor"}}},"ComputerPurchase":{"type":"object","properties":{"leased":{"type":"boolean","example":true},"purchased":{"type":"boolean","example":true},"poNumber":{"type":"string","example":"53-1"},"poDate":{"type":"string","format":"date","example":"2019-01-01"},"vendor":{"type":"string","example":"Example Vendor"},"warrantyDate":{"type":"string","format":"date","example":"2019-01-01"},"appleCareId":{"type":"string","example":"abcd"},"leaseDate":{"type":"string","format":"date","example":"2019-01-01"},"purchasePrice":{"type":"string","example":"$500"},"lifeExpectancy":{"type":"integer","example":5},"purchasingAccount":{"type":"string","example":"admin"},"purchasingContact":{"type":"string","example":"true"},"extensionAttributes":{"type":"array","items":{"$ref":"#/components/schemas/ComputerExtensionAttribute"}}}},"ComputerPurchaseCreate":{"type":"object","properties":{"leased":{"type":"boolean","nullable":true,"example":true},"purchased":{"type":"boolean","nullable":true,"example":true},"poNumber":{"type":"string","nullable":true,"example":"53-1"},"poDate":{"type":"string","format":"date","nullable":true,"example":"2019-01-01"},"vendor":{"type":"string","nullable":true,"example":"Example Vendor"},"warrantyDate":{"type":"string","format":"date","nullable":true,"example":"2019-01-01"},"appleCareId":{"type":"string","nullable":true,"example":"abcd"},"leaseDate":{"type":"string","format":"date","nullable":true,"example":"2019-01-01"},"purchasePrice":{"type":"string","nullable":true,"example":"$500"},"lifeExpectancy":{"type":"integer","nullable":true,"example":5},"purchasingAccount":{"type":"string","nullable":true,"example":"admin"},"purchasingContact":{"type":"string","nullable":true,"example":"true"}}},"ComputerRemoteManagement":{"type":"object","properties":{"managed":{"type":"boolean","example":true},"managementUsername":{"type":"string","description":"This field always returns null, please use /local-admin-password/ endpoint instead.","example":"rootname","deprecated":true}}},"ComputerRemoteManagementCreate":{"type":"object","properties":{"managed":{"type":"boolean","nullable":true,"example":true}}},"ComputerSection":{"type":"string","example":"general","enum":["GENERAL","DISK_ENCRYPTION","PURCHASING","APPLICATIONS","STORAGE","USER_AND_LOCATION","CONFIGURATION_PROFILES","PRINTERS","SERVICES","HARDWARE","LOCAL_USER_ACCOUNTS","CERTIFICATES","ATTACHMENTS","PLUGINS","PACKAGE_RECEIPTS","FONTS","SECURITY","OPERATING_SYSTEM","LICENSED_SOFTWARE","IBEACONS","SOFTWARE_UPDATES","EXTENSION_ATTRIBUTES","CONTENT_CACHING","GROUP_MEMBERSHIPS"]},"ComputerSectionV2":{"type":"string","example":"general","enum":["GENERAL","DISK_ENCRYPTION","PURCHASING","APPLICATIONS","STORAGE","USER_AND_LOCATION","CONFIGURATION_PROFILES","PRINTERS","SERVICES","HARDWARE","LOCAL_USER_ACCOUNTS","CERTIFICATES","ATTACHMENTS","PACKAGE_RECEIPTS","SECURITY","OPERATING_SYSTEM","LICENSED_SOFTWARE","IBEACONS","SOFTWARE_UPDATES","EXTENSION_ATTRIBUTES","CONTENT_CACHING","GROUP_MEMBERSHIPS"]},"ComputerSectionV3":{"type":"string","example":"general","enum":["GENERAL","DISK_ENCRYPTION","PURCHASING","APPLICATIONS","STORAGE","USER_AND_LOCATION","CONFIGURATION_PROFILES","PRINTERS","SERVICES","HARDWARE","LOCAL_USER_ACCOUNTS","CERTIFICATES","ATTACHMENTS","PACKAGE_RECEIPTS","SECURITY","OPERATING_SYSTEM","LICENSED_SOFTWARE","IBEACONS","SOFTWARE_UPDATES","EXTENSION_ATTRIBUTES","CONTENT_CACHING","GROUP_MEMBERSHIPS"]},"ComputerSectionV4":{"type":"string","example":"general","enum":["GENERAL","DISK_ENCRYPTION","PURCHASING","APPLICATIONS","STORAGE","USER_AND_LOCATION","CONFIGURATION_PROFILES","PRINTERS","SERVICES","HARDWARE","LOCAL_USER_ACCOUNTS","CERTIFICATES","ATTACHMENTS","PACKAGE_RECEIPTS","SECURITY","OPERATING_SYSTEM","LICENSED_SOFTWARE","IBEACONS","SOFTWARE_UPDATES","EXTENSION_ATTRIBUTES","CONTENT_CACHING","GROUP_MEMBERSHIPS"]},"ComputerSecurity":{"type":"object","properties":{"sipStatus":{"type":"string","example":"ENABLED","enum":["NOT_COLLECTED","NOT_AVAILABLE","DISABLED","ENABLED"]},"gatekeeperStatus":{"type":"string","example":"APP_STORE_AND_IDENTIFIED_DEVELOPERS","enum":["NOT_COLLECTED","DISABLED","APP_STORE_AND_IDENTIFIED_DEVELOPERS","APP_STORE"]},"xprotectVersion":{"type":"string","example":"1.2.3"},"autoLoginDisabled":{"type":"boolean","example":false},"remoteDesktopEnabled":{"type":"boolean","description":"Collected for macOS 10.14.4 or later","example":true},"activationLockEnabled":{"type":"boolean","description":"Collected for macOS 10.15.0 or later","example":true},"recoveryLockEnabled":{"type":"boolean","example":true},"firewallEnabled":{"type":"boolean","example":true},"secureBootLevel":{"type":"string","description":"Collected for macOS 10.15.0 or later","example":"FULL_SECURITY","enum":["NO_SECURITY","MEDIUM_SECURITY","FULL_SECURITY","NOT_SUPPORTED","UNKNOWN"]},"externalBootLevel":{"type":"string","description":"Collected for macOS 10.15.0 or later","example":"ALLOW_BOOTING_FROM_EXTERNAL_MEDIA","enum":["ALLOW_BOOTING_FROM_EXTERNAL_MEDIA","DISALLOW_BOOTING_FROM_EXTERNAL_MEDIA","NOT_SUPPORTED","UNKNOWN"]},"bootstrapTokenAllowed":{"type":"boolean","description":"Collected for macOS 11 or later","example":true},"bootstrapTokenEscrowedStatus":{"type":"string","description":"Collected for macOS 11 or later","example":"ESCROWED","enum":["ESCROWED","NOT_ESCROWED","NOT_SUPPORTED"]},"lastAttestationAttempt":{"type":"string","readOnly":true,"example":"1970-01-01T00:00:00Z"},"lastSuccessfulAttestation":{"type":"string","readOnly":true,"example":"1970-01-01T00:00:00Z"},"attestationStatus":{"type":"string","readOnly":true,"example":"PENDING","enum":["PENDING","SUCCESS","CERTIFICATE_INVALID","DEVICE_PROPERTIES_MISMATCH","MDA_UNSUPPORTED_DUE_TO_HARDWARE","MDA_UNSUPPORTED_DUE_TO_SOFTWARE"]},"lockdownModeEnabled":{"type":"boolean","description":"Whether Lockdown Mode is enabled.","example":false}}},"ComputerSecurityCreate":{"type":"object","properties":{"sipStatus":{"type":"string","nullable":true,"example":"ENABLED","enum":["NOT_COLLECTED","NOT_AVAILABLE","DISABLED","ENABLED"]},"gatekeeperStatus":{"type":"string","nullable":true,"example":"APP_STORE_AND_IDENTIFIED_DEVELOPERS","enum":["NOT_COLLECTED","DISABLED","APP_STORE_AND_IDENTIFIED_DEVELOPERS","APP_STORE"]},"xprotectVersion":{"type":"string","nullable":true,"example":"1.2.3"},"activationLockEnabled":{"type":"boolean","nullable":true,"example":true},"recoveryLockEnabled":{"type":"boolean","nullable":true,"example":true},"firewallEnabled":{"type":"boolean","nullable":true,"example":true},"secureBootLevel":{"type":"string","nullable":true,"example":"FULL_SECURITY","enum":["NO_SECURITY","MEDIUM_SECURITY","FULL_SECURITY","NOT_SUPPORTED","UNKNOWN"]},"externalBootLevel":{"type":"string","nullable":true,"example":"ALLOW_BOOTING_FROM_EXTERNAL_MEDIA","enum":["ALLOW_BOOTING_FROM_EXTERNAL_MEDIA","DISALLOW_BOOTING_FROM_EXTERNAL_MEDIA","NOT_SUPPORTED","UNKNOWN"]}}},"ComputerService":{"type":"object","properties":{"name":{"type":"string","example":"SomeService"}}},"ComputerServiceCreate":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"SomeService"}}},"ComputerSite":{"type":"object","properties":{"id":{"type":"string","nullable":false,"example":"1"},"name":{"type":"string","nullable":false,"example":"Eau Claire"}}},"ComputerSmartGroupCriteriaV2":{"required":["andOr","name","priority","searchType","value"],"type":"object","properties":{"name":{"maxLength":255,"type":"string","description":"The field to search on (e.g., Operating System Version, Computer Name, etc.)","example":"Model"},"priority":{"type":"integer","description":"The priority order of this criterion (must start at 0 and increment by 1 per new criteria)","example":0},"andOr":{"type":"string","description":"Whether this criterion should be ANDed or ORed with the previous criterion. Must be exactly \"AND\" or \"OR\" (case-insensitive input accepted, stored as lowercase).","example":"and","enum":["and","or"]},"searchType":{"type":"string","description":"The type of search to perform (e.g., is, is not, like, greater than or equal, etc.)","example":"greater than or equal"},"value":{"maxLength":255,"type":"string","description":"The value to search for","example":"14.0"},"openingParen":{"type":"boolean","description":"Whether to add an opening parenthesis before this criterion","example":false},"closingParen":{"type":"boolean","description":"Whether to add a closing parenthesis after this criterion","example":false}}},"ComputerSoftwareUpdate":{"type":"object","properties":{"name":{"type":"string","example":"BEdit"},"version":{"type":"string","example":"1.15.2"},"packageName":{"type":"string","example":"com.apple.pkg.AdditionalEssentials"}}},"ComputerSoftwareUpdateCreate":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"BEdit"},"version":{"type":"string","nullable":true,"example":"1.15.2"},"packageName":{"type":"string","nullable":true,"example":"com.apple.pkg.AdditionalEssentials"}}},"ComputerStorage":{"type":"object","properties":{"bootDriveAvailableSpaceMegabytes":{"type":"integer","format":"int64","readOnly":true,"example":3072},"disks":{"type":"array","items":{"$ref":"#/components/schemas/ComputerDisk"}}}},"ComputerStorageCreate":{"type":"object","properties":{"disks":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ComputerDiskCreate"}}}},"ComputerUserAndLocation":{"type":"object","properties":{"username":{"type":"string","example":"Madison Anderson"},"realname":{"type":"string","example":"13-inch MacBook"},"email":{"type":"string","example":"email@com.pl"},"position":{"type":"string","example":"IT Team Lead"},"phone":{"type":"string","example":"123-456-789"},"departmentId":{"type":"string","example":"1"},"buildingId":{"type":"string","example":"1"},"room":{"type":"string","example":"5"},"extensionAttributes":{"type":"array","items":{"$ref":"#/components/schemas/ComputerExtensionAttribute"}}}},"ComputerUserAndLocationCreate":{"type":"object","properties":{"username":{"type":"string","nullable":true,"example":"Madison Anderson"},"realname":{"type":"string","nullable":true,"example":"13-inch MacBook"},"email":{"type":"string","nullable":true,"example":"email@com.pl"},"position":{"type":"string","nullable":true,"example":"IT Team Lead"},"phone":{"type":"string","nullable":true,"example":"123-456-789"},"departmentId":{"type":"string","nullable":true,"example":"1"},"buildingId":{"type":"string","nullable":true,"example":"1"},"room":{"type":"string","nullable":true,"example":"5"}}},"ComputerUserManagementInfo":{"required":["capableUser","managementId"],"type":"object","properties":{"capableUser":{"type":"string","example":"admin"},"managementId":{"type":"string","example":"123e4567-e89b-12d3-a456-426614174000"}},"example":[{"capableUser":"admin","managementId":"123e4567-e89b-42d3-a456-426614174000"},{"capableUser":"rootadmin","managementId":"123e4567-e89b-42d3-a456-426614174001"}]},"ComputersSearchResults":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":3},"results":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/ComputerOverview"}}}},"ConfigurationProfile":{"type":"object","properties":{"displayName":{"type":"string","example":"Test WiFi"},"version":{"type":"string","example":"1"},"uuid":{"type":"string","example":"D29DD9FB-0D5B-422F-A3A2-ABBC5848E949"},"identifier":{"type":"string","example":"ac2-server4.D0EFAC2D-326C-4BB6-87E6-2BCB88490AAA"}}},"ConfigurationSearchResults":{"type":"object","properties":{"totalCount":{"type":"integer","example":1},"results":{"type":"array","items":{"$ref":"#/components/schemas/CloudIdPCommonResponse"}}},"description":"A list with Cloud Identity Providers informations about configurations"},"ConnectionConfigurationCandidateRequest":{"required":["displayName","enabled","scriptToken","sessionTimeout","siteId"],"type":"object","properties":{"siteId":{"type":"string","description":"An identifier of a site which Team Viewer Remote Administration will be configured on","example":"1"},"displayName":{"maxLength":255,"minLength":1,"type":"string","description":"Name for Team Viewer Connection Configuration","example":"teamViewerConfiguration"},"scriptToken":{"maxLength":255,"minLength":1,"type":"string","description":"Token which is used for connecting to Team Viewer","example":"12847340-nPAX96bsaADH4Gz6K6i2"},"enabled":{"type":"boolean","description":"Defines the intent to enable or disable Team Viewer connection","example":true},"sessionTimeout":{"maximum":1440,"minimum":1,"type":"integer","description":"Number of minutes before the session expires","example":15}},"description":"Request that creates configuration and initialize connection between Jamf Pro and Team Viewer"},"ConnectionConfigurationResponse":{"required":["displayName","enabled","id","sessionTimeout","siteId"],"type":"object","properties":{"id":{"type":"string","description":"An identifier of connection configuration for Team Viewer Remote Administration","example":"1"},"siteId":{"type":"string","description":"An identifier of a site which Team Viewer Remote Administration is configured on","example":"1"},"displayName":{"type":"string","description":"Name for Team Viewer Connection Configuration","example":"teamViewerConfiguration"},"enabled":{"type":"boolean","description":"Describes if Team Viewer connection is enabled or disabled","example":true},"sessionTimeout":{"maximum":1440,"minimum":1,"type":"integer","description":"Number of minutes before the session expires","nullable":true,"example":15}},"description":"Response that contains information about connection configuration for Team Viewer"},"ConnectionConfigurationStatusResponse":{"required":["connectionVerificationResult"],"type":"object","properties":{"connectionVerificationResult":{"type":"string","description":"connection configuration status for Team Viewer","example":"VALID"}},"description":"Response that contains connection configuration status for Team Viewer"},"ConnectionConfigurationUpdateRequest":{"type":"object","properties":{"displayName":{"maxLength":255,"type":"string","description":"Name for Team Viewer Connection Configuration","example":"teamViewerConfiguration"},"enabled":{"type":"boolean","description":"Defines the intent to enable or disable Team Viewer connection","example":true},"sessionTimeout":{"maximum":1440,"minimum":1,"type":"integer","description":"Number of minutes before the session expires","example":15},"token":{"maxLength":255,"type":"string","description":"Script token for Team Viewer Connection Configuration","example":"12843140-nPAX96bsaADH4Gz6K6i2"}},"description":"Request that updates configuration connection between Jamf Pro and Team Viewer"},"Country":{"type":"object","properties":{"code":{"type":"string","example":"US"},"name":{"type":"string","example":"United States"}}},"CountryCodes":{"type":"object","properties":{"countryCodes":{"type":"array","items":{"$ref":"#/components/schemas/Country"}}}},"CreatePath":{"required":["path","scope"],"type":"object","properties":{"scope":{"type":"string","example":"APP","enum":["APP","FONT","PLUGIN"]},"path":{"type":"string","example":"/Example/Path/"}}},"CreatePathV2":{"required":["path","scope"],"type":"object","properties":{"scope":{"type":"string","example":"APP","enum":["APP"]},"path":{"type":"string","example":"/Example/Path/"}}},"Credentials":{"type":"object","properties":{"accessKeyID":{"type":"string","format":"password","nullable":false,"example":"TESTYBLF477T5THW6BNN"},"expiration":{"type":"integer","format":"int64","nullable":false,"example":1678386302},"secretAccessKey":{"type":"string","format":"password","nullable":false,"example":"tEstNvpw2AC9mggf08/Yw7krkPfYxWNoByGClLr7"},"sessionToken":{"type":"string","nullable":false,"example":"TEsTb3JpZ2luX2VjEKr//////////wEaCXVzLWVhc3QtMSJHMEUCIQCwp+L32PlSQjeb/Pimk3AUPv3SADpSQv22pK2YqpOjhAIgDfrMNA9asxymToN9ntJrXn9i0bbOhkPAmewDBJ9RqCsqrQIIYxADGgw1NTI2NTM4ODEzMTkiDCmmPWNQKIMfmVIXNSqKAlWem+7n2ApbcAlPxtl5l8mQJz5wqPaUuBlwhuG9Fn7dPUeaHA6ZZjrEegjJOvMkATPEfoD/2o272WXegzC+VVuadrRP+x+pmSnkikqNVz43t6csUTZC61GXsEcsfgRcLHauRoR6vq9aVPRYXckztGjmFb4GpICbR/wc94nJZ6Yw1YZ63UrmEdnJIKSvy/tAoFhJuufy/JOFQEuyW/N38bg+d/xLMNfhMMUSfOE9TOFlI9gOvyOPQVBocckknPD+HWj+nin1SSIy+mH6wMoZNYdRe/J8d5lmjgeiL7l/FmdMmbB7vDdPGCe5hPvJwGpGv6FRnk31NZNFNP//csVTVszGiUmRuY3R2hPUMO6sqKAGOp0BvZ5WAPpip/YMfvCzkzLI0EHlLwHHenor0IenM75eCW+pGqJreU/VIbadRyzncUL4zIa3DBKxgIP/h5uFoSm0ZGdQSAovXtHRQwDBNhdksvqsxQsExn8BjjLh6tFVkBGb4IXY9sS5K7tIwnqOtcT1FEYxQ08RqkJAaP08eCIYbBrWW71S2bNUfIv6KFOG77pz88vw9vHOjxVRjTrfCQ=="},"region":{"type":"string","nullable":false,"example":"us-east-1"},"bucketName":{"type":"string","nullable":false,"example":"sbox-test-bucket"},"path":{"type":"string","nullable":false,"example":"tmp/fc041b05-516e-4bde-9882-a08b1cc5473c/"},"uuid":{"type":"string","nullable":false,"example":"fc041b05-516e-4bde-9882-a08b1cc5473c"}}},"CsaTenantIdInfo":{"type":"object","properties":{"tenantId":{"type":"string","description":"The tenant ID","nullable":true,"readOnly":true,"example":"123"}}},"CsaToken":{"type":"object","properties":{"tenantId":{"type":"string","description":"The tenant ID","nullable":true,"example":"12345678"},"subject":{"type":"string","description":"Salesforce CRM account ID","example":"001C000000wkzDLIAY"},"refreshExpiration":{"type":"integer","format":"int64","example":1584544108},"scopes":{"type":"array","example":["read mobile_device","write mobile_device"],"items":{"type":"string"}},"legacyJamfSalesforceIds":{"type":"array","example":["001C000000wkzXXXXX","001C000000wkzYYYYY"],"items":{"type":"string"}}}},"CurrentAccount":{"type":"object","properties":{"id":{"minimum":1,"type":"integer","example":1},"username":{"type":"string","example":"admin"},"realName":{"type":"string","example":"IT Bob"},"email":{"type":"string","example":"ITBob@Jamf.com"},"preferences":{"$ref":"#/components/schemas/AccountPreferences"},"isMultiSiteAdmin":{"type":"boolean","example":true},"accessLevel":{"type":"string","example":"FullAccess","enum":["FullAccess","SiteAccess","GroupBasedAccess"]},"privilegeSet":{"type":"string","example":"CUSTOM","enum":["ADMINISTRATOR","AUDITOR","ENROLLMENT","CUSTOM"]},"privileges":{"type":"array","example":["Read SSO Settings","Delete eBooks"],"items":{"type":"string"}},"groupIds":{"type":"array","example":[1,3],"items":{"type":"integer"}},"currentSiteId":{"type":"integer","example":1}}},"CurrentAuthorization":{"type":"object","properties":{"account":{"$ref":"#/components/schemas/CurrentAccount"},"sites":{"type":"array","items":{"$ref":"#/components/schemas/V1SiteBase"}},"authenticationType":{"$ref":"#/components/schemas/AuthenticationType"}}},"DashboardApiError":{"type":"object","properties":{"httpStatusCode":{"type":"integer","nullable":false,"example":500,"default":500},"id":{"type":"string","nullable":false,"example":"3","default":""},"description":{"type":"string","nullable":false,"example":"Could not collect dashboard data for licensed software","default":""}}},"DashboardItem":{"type":"object","properties":{"id":{"type":"string","example":"1"},"title":{"type":"string","nullable":true,"example":"Patch Report"},"subtitle":{"type":"string","nullable":true,"example":"Adobe Patch Policy"},"info":{"type":"string","description":"Additional information such as identifiers for a specific policy within a software patch","nullable":true,"example":"3"},"enabled":{"type":"boolean","description":"Logical to decide whether widget should be enabled or disabled; i.e. Policy","default":true},"metrics":{"type":"array","items":{"title":"DashboardMetric","type":"object","properties":{"value":{"type":"string","description":"Usually a number associated with the tag; i.e. 23 Pending Computers","example":"2"},"enabled":{"type":"boolean","description":"Logical to decide whether metric should be enabled or disabled; i.e. Policy can be at Retrying-Disabled status","default":true},"tag":{"type":"string","example":"Completed","enum":["Completed","Remaining","Site License","No Licenses","Over","Failed","Retrying","Retrying-disabled","Pending","Expiring","Active","Inactive","Computers","Devices","Users","In Use","N/A","Latest Version","Other Versions"]}}}},"details":{"type":"array","items":{"title":"DashboardDetail","type":"object","properties":{"label":{"type":"string","example":"10.2.001.4"},"value":{"type":"string","example":"24"}},"description":"Additional details that will be found in a legend of the widgets on the dashboard"}},"error":{"$ref":"#/components/schemas/DashboardApiError"}}},"DashboardObject":{"required":["enabled","objectId","objectType"],"type":"object","properties":{"objectId":{"type":"string","example":"1"},"objectType":{"type":"string","example":"TYPE_IOS_CONFIGURATION_PROFILE","enum":["TYPE_IOS_CONFIGURATION_PROFILE","TYPE_MACOS_CONFIGURATION_PROFILE","TYPE_USER_GROUP","TYPE_LICENSED_SOFTWARE","TYPE_PATCH_SOFTWARE_TITLE_CONFIGURATION","TYPE_PATCH_POLICY","TYPE_POLICY","TYPE_COMPUTER_GROUP","TYPE_MOBILE_DEVICE_GROUP","TYPE_DIGICERT_PKI_MANAGER_SETTINGS"]},"enabled":{"type":"boolean","example":true}},"description":"Dashboard object consisting of object type, object's ID, and whether it should display on the Jamf Pro dashboard","nullable":false},"DashboardSetup":{"type":"object","properties":{"setupTaskOptions":{"type":"object","properties":{"setupTask":{"type":"string","example":"TYPE_SSL_SETUP_TASK","enum":["TYPE_LDAP_SERVER_SETUP_TASK","TYPE_PUSH_NOTIFICATION_SETTINGS_SETUP_TASK","TYPE_SMTP_SERVER_SETUP_TASK","TYPE_SSL_SETUP_TASK"]}},"additionalProperties":{"$ref":"#/components/schemas/DashboardSetupTask"},"example":{"TYPE_SSL_SETUP_TASK":{"available":true,"error":{"httpStatusCode":"500","description":"Null pointer exception example error","id":""}}}},"featureOptions":{"type":"object","properties":{"feature":{"type":"string","example":"TYPE_POLICY","enum":["TYPE_IOS_CONFIGURATION_PROFILE","TYPE_MACOS_CONFIGURATION_PROFILE","TYPE_USER_GROUP","TYPE_LICENSED_SOFTWARE","TYPE_PATCH_SOFTWARE_TITLE_CONFIGURATION","TYPE_PATCH_POLICY","TYPE_POLICY","TYPE_COMPUTER_GROUP","TYPE_MOBILE_DEVICE_GROUP","TYPE_DIGICERT_PKI_MANAGER_SETTINGS"]}},"additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/DashboardItem"}},"example":{"TYPE_PATCH_SOFTWARE_TITLE_CONFIGURATION":[{"id":"1","title":"Patch Report","subtitle":"Adobe Patch Policy","info":"3","enabled":true,"metrics":[{"value":"2","enabled":true,"tag":"Completed"}],"details":[{"label":"10.2.001.4","value":"24"}],"error":{"httpStatusCode":"500","description":"Null pointer exception example error","id":"3"}}]}}},"description":"Response object that has lists of information for widgets, and what setup tasks to display."},"DashboardSetupTask":{"type":"object","properties":{"available":{"type":"boolean","nullable":false,"example":true,"default":false},"error":{"$ref":"#/components/schemas/DashboardApiError"}}},"DataRoamingSetting":{"type":"string","example":"ENABLE_DATA_ROAMING","enum":["ENABLE_DATA_ROAMING","DISABLE_DATA_ROAMING"]},"DatabasePassword":{"required":["password"],"type":"object","properties":{"password":{"minLength":1,"type":"string","format":"password","writeOnly":true,"example":"12345"}}},"DayOfWeek":{"type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]},"DeclarativeManagementCommand":{"allOf":[{"$ref":"#/components/schemas/MdmCommandBase"},{"type":"object","properties":{"data":{"type":"string","description":"Base64 encoded data to be sent with the command","example":"TWFkZSB5YSBsb29r"}}}]},"DefaultApplications":{"type":"object","properties":{"webBrowser":{"type":"string","nullable":true,"example":"com.example.browser"},"calling":{"type":"string","nullable":true,"example":"com.example.phone"},"messaging":{"type":"string","nullable":true,"example":"com.example.messages"}}},"DeleteUserCommand":{"allOf":[{"$ref":"#/components/schemas/MdmCommandBase"},{"type":"object","properties":{"userName":{"type":"string","example":"user123"},"forceDeletion":{"type":"boolean","example":true},"deleteAllUsers":{"type":"boolean","example":true}}}]},"Department":{"required":["name"],"type":"object","properties":{"id":{"minLength":1,"type":"string","readOnly":true,"example":"1"},"name":{"maxLength":225,"minLength":1,"type":"string","example":"Department of Redundancy Department"}}},"DepartmentsSearchResults":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":3},"results":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/Department"}}}},"DependencyObjectResults":{"type":"object","properties":{"totalCount":{"type":"integer","example":1},"results":{"minItems":0,"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Unique Id for Dependency Object.","example":1},"objectId":{"type":"integer","description":"Object Type Id of the dependency object.","example":1},"nameLocalization":{"type":"string","description":"Name of localization which display dependent object.","example":"SMART_COMPUTER_GROUPS"},"identifiableName":{"type":"string","description":"Name of the dependent object.","example":"identifiableName"},"hyperlink":{"type":"string","description":"Link to dependent object or to page with list of dependent objects.","example":"/smartMobileDeviceGroups.html"}}}}}},"DeploymentTask":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"82"},"computerId":{"type":"string","readOnly":true,"example":"111"},"computerName":{"type":"string","readOnly":true,"example":"Polka dot Stratocaster"},"version":{"type":"string","readOnly":true,"example":"2.3.4"},"updated":{"type":"string","format":"date-time","readOnly":true,"example":"2021-05-07T21:20:34.35Z"},"status":{"type":"string","description":"Status of this Jamf Connect deployment task. \"Command\" below refers to an `InstallEnterpriseApplication` command. Tasks that are not finished (i.e., `COMPLETE` or `GAVE_UP`) are evaluated once every thirty minutes, so the status value for a device may lag behind a successful Jamf Connect package install up to thirty minutes. * `COMMAND_QUEUED` - command has been queued * `NO_COMMAND` - command has not yet been queued * `PENDING_MANIFEST` - task is waiting to obtain a valid package manifest before a command can be queued * `COMPLETE` - command has been completed successfully * `GAVE_UP` - the command failed with an error or the device did not process it in a reasonable amount of time * `UNKNOWN` - unknown; tasks in this state will be evaluated\n","example":"COMPLETE","enum":["COMMAND_QUEUED","NO_COMMAND","PENDING_MANIFEST","COMPLETE","GAVE_UP","UNKNOWN"]}}},"DeploymentTaskSearchResults":{"type":"object","properties":{"totalCount":{"type":"integer","example":13},"results":{"type":"array","items":{"$ref":"#/components/schemas/DeploymentTask"}}}},"DetailsV2":{"type":"object","properties":{"model":{"type":"string","example":"iPad 5th Generation (Wi-Fi)"},"modelIdentifier":{"type":"string","example":"ipad6,11"},"modelNumber":{"type":"string","example":"MP2F2LL"},"supervised":{"type":"boolean","example":true},"batteryLevel":{"type":"integer","example":100},"batteryHealth":{"type":"string","description":"- NON_GENUINE: The battery isn’t a genuine Apple battery.\n- NORMAL: The battery is operating normally.\n- SERVICE_RECOMMENDED: The system recommends battery service.\n- UNKNOWN: The system couldn’t determine battery health information.\n- UNSUPPORTED: The device doesn’t support battery health reporting.\n","enum":["NON_GENUINE","NORMAL","SERVICE_RECOMMENDED","UNKNOWN","UNSUPPORTED"],"default":"UNKNOWN"},"lastBackupTimestamp":{"type":"string","format":"date-time","example":"2018-10-15T16:39:56Z"},"capacityMb":{"type":"integer","example":27503},"availableMb":{"type":"integer","example":26646},"percentageUsed":{"type":"integer","example":3},"shared":{"type":"boolean","example":false},"deviceLocatorServiceEnabled":{"type":"boolean","example":false},"doNotDisturbEnabled":{"type":"boolean","example":false},"cloudBackupEnabled":{"type":"boolean","example":false},"lastCloudBackupTimestamp":{"type":"string","format":"date-time","example":"2018-10-15T16:39:56.307Z"},"locationServicesEnabled":{"type":"boolean","example":false},"iTunesStoreAccountActive":{"type":"boolean","example":false},"bleCapable":{"type":"boolean","example":false},"unlockToken":{"type":"string","example":"VU5MT0NLVE9LRU4="},"returnToServiceEnabled":{"type":"boolean","description":"Whether Return to Service is enabled.","example":false},"systemHealth":{"$ref":"#/components/schemas/SystemHealthV2"},"computer":{"$ref":"#/components/schemas/IdAndNameV2"},"purchasing":{"$ref":"#/components/schemas/PurchasingV2"},"security":{"$ref":"#/components/schemas/SecurityV2"},"network":{"$ref":"#/components/schemas/NetworkV2"},"serviceSubscriptions":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceServiceSubscriptions"}},"applications":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceApplication"}},"certificates":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceCertificateV2"}},"ebooks":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceEbook"}},"mdmCapableUsers":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceMdmCapableUser"}},"configurationProfiles":{"type":"array","items":{"$ref":"#/components/schemas/ConfigurationProfile"}},"provisioningProfiles":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceProvisioningProfiles"}},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceAttachmentV2"}}},"description":"will be populated if the type is ios or visionos."},"DeviceCommonDetails":{"required":["clientManagementId"],"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the device common details record","example":"123"},"clientManagementId":{"type":"string","description":"The client management ID associated with this device","example":"550e8400-e29b-41d4-a716-446655440000"},"renewMdmProfileStartDate":{"type":"string","description":"Timestamp when MDM profile renewal started (ISO 8601 format)","format":"date-time","nullable":true,"example":"2021-12-31T16:00:00Z"},"mdmProfileNeedsRenewalDueToCaRenewed":{"type":"boolean","description":"Whether the MDM profile needs renewal due to CA renewal","example":false},"mdmProfileNeedsRenewalDueToDeviceIdentityCertExpiring":{"type":"boolean","description":"Whether the MDM profile needs renewal due to expiring device identity certificate","example":true},"mdmCheckinUrl":{"type":"string","description":"URL for MDM check-in","nullable":true,"example":"https://example.jamfcloud.com/mdm/CheckInURL"},"mdmServerUrl":{"type":"string","description":"URL for MDM server","nullable":true,"example":"https://example.jamfcloud.com/mdm/ServerURL"}}},"DeviceCommonDetailsRequest":{"required":["clientManagementId"],"type":"object","properties":{"clientManagementId":{"type":"string","description":"The client management ID associated with this device (required)","example":"550e8400-e29b-41d4-a716-446655440000"},"renewMdmProfileStartDate":{"type":"string","description":"Timestamp when MDM profile renewal started (ISO 8601 format)","format":"date-time","nullable":true,"example":"2021-12-31T16:00:00Z"},"mdmProfileNeedsRenewalDueToCaRenewed":{"type":"boolean","description":"Whether the MDM profile needs renewal due to CA renewal","nullable":true,"example":false},"mdmProfileNeedsRenewalDueToDeviceIdentityCertExpiring":{"type":"boolean","description":"Whether the MDM profile needs renewal due to expiring device identity certificate","nullable":true,"example":true},"mdmCheckinUrl":{"type":"string","description":"URL for MDM check-in","nullable":true,"example":"https://example.jamfcloud.com/mdm/CheckInURL"},"mdmServerUrl":{"type":"string","description":"URL for MDM server","nullable":true,"example":"https://example.jamfcloud.com/mdm/ServerURL"}}},"DeviceCommunicationSettings":{"type":"object","properties":{"autoRenewMobileDeviceMdmProfileWhenCaRenewed":{"type":"boolean","example":true},"autoRenewMobileDeviceMdmProfileWhenDeviceIdentityCertExpiring":{"type":"boolean","example":true},"autoRenewComputerMdmProfileWhenCaRenewed":{"type":"boolean","example":true},"autoRenewComputerMdmProfileWhenDeviceIdentityCertExpiring":{"type":"boolean","example":true},"mdmProfileMobileDeviceExpirationLimitInDays":{"type":"integer","enum":[90,120,180],"default":180},"mdmProfileComputerExpirationLimitInDays":{"type":"integer","enum":[90,120,180],"default":180}}},"DeviceComplianceInformation":{"type":"object","properties":{"deviceId":{"type":"string","description":"ID of the device","example":"1"},"applicable":{"type":"boolean","description":"If device is applicable for compliance calculation","example":true},"complianceState":{"type":"string","description":"Device compliance state. Possible values are:\n* `UNKNOWN` for unknow compliance state, this usually means that the compliance state is being calculated,\n* `NON_COMPLIANT` for non compliant state,\n* `COMPLIANT` for compliant state\n","example":"COMPLIANT","enum":["UNKNOWN","NON_COMPLIANT","COMPLIANT"]},"complianceVendor":{"type":"string","description":"Name of the compliance vendor","example":"Vendor A"},"complianceVendorDeviceInformation":{"$ref":"#/components/schemas/ComplianceVendorDeviceInformation"}},"description":"Device compliance information record"},"DeviceEnrollmentDevice":{"type":"object","properties":{"id":{"type":"string","example":"1"},"deviceEnrollmentProgramInstanceId":{"type":"string","example":"1"},"prestageId":{"type":"string","example":"1"},"serialNumber":{"type":"string","example":"R7QFDE2YCFN4"},"description":{"type":"string","example":"MBP 15.4"},"model":{"type":"string","example":"Macbook Pro 15 Retina"},"color":{"type":"string","example":"BLACK"},"assetTag":{"type":"string","example":"ACME-1234"},"profileStatus":{"type":"string","example":"ASSIGNED","enum":["EMPTY","ASSIGNED","PUSHED","REMOVED"]},"syncState":{"$ref":"#/components/schemas/AssignRemoveProfileResponseSyncState"},"profileAssignTime":{"type":"string","example":"2000-10-30T18:00:00-00:00"},"profilePushTime":{"type":"string","example":"2000-10-30T18:00:00-00:00"},"deviceAssignedDate":{"type":"string","example":"2000-10-30T18:00:00-00:00"}}},"DeviceEnrollmentDeviceSearchResults":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":1},"results":{"type":"array","items":{"$ref":"#/components/schemas/DeviceEnrollmentDevice"}}}},"DeviceEnrollmentDisownBody":{"type":"object","properties":{"devices":{"type":"array","example":["1a2s3d4f5g","0o9i8u7y6t"],"items":{"type":"string"}}}},"DeviceEnrollmentDisownResponse":{"type":"object","properties":{"devices":{"type":"object","additionalProperties":{"type":"string"},"example":{"a2s3d4f5":"SUCCESS","0o9i8u7y6t":"FAILED"}}}},"DeviceEnrollmentInstance":{"required":["name"],"type":"object","properties":{"id":{"minLength":1,"type":"string","readOnly":true,"example":"1"},"name":{"type":"string","example":"Example Device Enrollment Instance"},"supervisionIdentityId":{"type":"string","example":"1"},"siteId":{"type":"string","example":"-1"},"serverName":{"type":"string","readOnly":true,"example":"Acme ASM"},"serverUuid":{"type":"string","readOnly":true,"example":"BASD08C11F3C455"},"adminId":{"type":"string","readOnly":true,"example":"admin1234"},"orgName":{"type":"string","readOnly":true,"example":"Acme Enterprises"},"orgEmail":{"type":"string","readOnly":true,"example":"admin@test.com"},"orgPhone":{"type":"string","readOnly":true,"example":"555-0123"},"orgAddress":{"type":"string","readOnly":true,"example":"124 Conch Street, Bikini Bottom, Pacific Ocean"},"tokenExpirationDate":{"type":"string","readOnly":true,"example":"2000-10-30"}}},"DeviceEnrollmentInstanceSearchResults":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":1},"results":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/DeviceEnrollmentInstance"}}}},"DeviceEnrollmentInstanceSyncStatus":{"type":"object","properties":{"syncState":{"type":"string","example":"CONNECTION_ERROR"},"instanceId":{"type":"string","example":"1"},"timestamp":{"type":"string","example":"2019-04-17T14:08:06.706+0000"}}},"DeviceEnrollmentPrestageV2":{"required":["authenticationPrompt","autoAdvanceSetup","defaultPrestage","department","deviceEnrollmentProgramInstanceId","displayName","enableDeviceBasedActivationLock","enrollmentSiteId","keepExistingLocationInformation","keepExistingSiteMembership","locationInformation","mandatory","mdmRemovable","preventActivationLock","purchasingInformation","requireAuthentication","supportEmailAddress","supportPhoneNumber"],"type":"object","properties":{"displayName":{"type":"string","example":"Example Mobile Prestage Name"},"mandatory":{"type":"boolean","example":false},"mdmRemovable":{"type":"boolean","example":true},"supportPhoneNumber":{"type":"string","example":"5555555555"},"supportEmailAddress":{"type":"string","example":"example@example.com"},"department":{"type":"string","example":"Oxbow"},"defaultPrestage":{"type":"boolean","example":false},"enrollmentSiteId":{"type":"string","example":"-1"},"keepExistingSiteMembership":{"type":"boolean","example":true},"keepExistingLocationInformation":{"type":"boolean","example":true},"requireAuthentication":{"type":"boolean","example":true},"authenticationPrompt":{"type":"string","example":"LDAP authentication prompt"},"preventActivationLock":{"type":"boolean","example":true},"enableDeviceBasedActivationLock":{"type":"boolean","example":true},"deviceEnrollmentProgramInstanceId":{"type":"string","example":"5"},"skipSetupItems":{"type":"object","additionalProperties":{"type":"boolean"},"example":{"Location":true,"Privacy":false}},"locationInformation":{"$ref":"#/components/schemas/LocationInformationV2"},"purchasingInformation":{"$ref":"#/components/schemas/PrestagePurchasingInformationV2"},"anchorCertificates":{"type":"array","description":"The Base64 encoded PEM Certificate","items":{"type":"string","example":"xNE5HRgotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg=="}},"enrollmentCustomizationId":{"type":"string","example":"2"},"language":{"type":"string","example":"en"},"region":{"type":"string","example":"US"},"autoAdvanceSetup":{"type":"boolean","example":true}}},"DeviceEnrollmentPrestageV3":{"required":["authenticationPrompt","autoAdvanceSetup","defaultPrestage","department","deviceEnrollmentProgramInstanceId","displayName","enableDeviceBasedActivationLock","enrollmentSiteId","keepExistingLocationInformation","keepExistingSiteMembership","locationInformation","mandatory","mdmRemovable","preventActivationLock","purchasingInformation","requireAuthentication","supportEmailAddress","supportPhoneNumber"],"type":"object","properties":{"displayName":{"type":"string","example":"Example Mobile Prestage Name"},"mandatory":{"type":"boolean","example":false},"mdmRemovable":{"type":"boolean","example":true},"supportPhoneNumber":{"type":"string","example":"5555555555"},"supportEmailAddress":{"type":"string","example":"example@example.com"},"department":{"type":"string","example":"Oxbow"},"defaultPrestage":{"type":"boolean","example":false},"enrollmentSiteId":{"type":"string","example":"-1"},"keepExistingSiteMembership":{"type":"boolean","example":true},"keepExistingLocationInformation":{"type":"boolean","example":true},"requireAuthentication":{"type":"boolean","example":true},"authenticationPrompt":{"type":"string","example":"LDAP authentication prompt"},"preventActivationLock":{"type":"boolean","example":true},"enableDeviceBasedActivationLock":{"type":"boolean","example":true},"deviceEnrollmentProgramInstanceId":{"type":"string","example":"5"},"skipSetupItems":{"type":"object","additionalProperties":{"type":"boolean"},"example":{"Location":true,"Privacy":false}},"locationInformation":{"$ref":"#/components/schemas/LocationInformationV3"},"purchasingInformation":{"$ref":"#/components/schemas/PrestagePurchasingInformationV3"},"anchorCertificates":{"type":"array","description":"The Base64 encoded PEM Certificate","items":{"type":"string","example":"xNE5HRgotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg=="}},"enrollmentCustomizationId":{"type":"string","example":"2"},"language":{"type":"string","example":"en"},"region":{"type":"string","example":"US"},"autoAdvanceSetup":{"type":"boolean","example":true}}},"DeviceEnrollmentToken":{"type":"object","properties":{"tokenFileName":{"type":"string","description":"Optional name of the token to be saved, if no name is provided one will be auto-generated","example":"Acme MDM Token"},"encodedToken":{"pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$","type":"string","description":"The base 64 encoded token","format":"byte","example":"VTI5dFpTQnlZVzVrYjIwZ1ltbDBJRzltSUhSbGVIUWdkRzhnZFhObElHRnVaQ0J6WldVZ2FXWWdZVzU1YjI1bElHRmpkSFZoYkd4NUlIUnlhV1Z6SUhSdklHUmxZMjlrWlNCcGRBPT0="}}},"DeviceGroup":{"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"Group Platform ID","example":"699bc5b1-efb7-431a-b18f-b2ec5c435631"},"name":{"type":"string","example":"Test Group"}}},"DeviceInformationCommand":{"allOf":[{"$ref":"#/components/schemas/MdmCommandBase"},{"type":"object","properties":{"queries":{"minItems":1,"type":"array","example":["DeviceName","BatteryLevel","IsSupervised"],"items":{"type":"string","description":"List of queries specifying the information to collect from a device","externalDocs":{"description":"For a full list of possible queries see Apple's documentation","url":"https://developer.apple.com/documentation/devicemanagement/deviceinformationcommand/command/queries"}}}}}]},"DeviceLocationCommand":{"allOf":[{"$ref":"#/components/schemas/MdmCommandBase"},{"type":"object"}]},"DeviceLockCommand":{"allOf":[{"$ref":"#/components/schemas/MdmCommandBase"},{"type":"object","properties":{"message":{"type":"string","example":"message123"},"phoneNumber":{"type":"string","example":"(123) 456-7890"},"pin":{"type":"string","example":"pin123"}}}]},"DiagnosticSubmissionSetting":{"type":"string","example":"ENABLE_DIAGNOSTIC_SUBMISSION","enum":["ENABLE_DIAGNOSTIC_SUBMISSION","DISABLE_DIAGNOSTIC_SUBMISSION"]},"DigiCertSetting":{"type":"object","properties":{"caName":{"maxLength":255,"minLength":1,"type":"string","example":"Example Display Name"},"fqdn":{"maxLength":255,"minLength":1,"type":"string","example":"digicert.example.com"},"revocationEnabled":{"type":"boolean","example":true},"clientCert":{"$ref":"#/components/schemas/Certificate"}},"description":"DigiCert Trust Lifecycle Manager object to create, or update with a merge-patch strategy. Certificate data must be provided in full, or not at all for update with merge-patch strategy."},"DigiCertSettingResponse":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"1"},"caName":{"maxLength":255,"minLength":1,"type":"string","example":"Example Display Name"},"fqdn":{"maxLength":255,"minLength":1,"type":"string","example":"digicert.example.com"},"revocationEnabled":{"type":"boolean","example":true},"clientCert":{"$ref":"#/components/schemas/CertificateResponse"}},"description":"DigiCert Trust Lifecycle Manager response object."},"DigicertConnectionStatus":{"type":"object","properties":{"status":{"maxLength":255,"minLength":1,"type":"string","readOnly":true,"example":"Successfully connected"}}},"DigicertDependencies":{"type":"object","properties":{"totalCount":{"type":"integer","nullable":false,"example":1},"results":{"type":"array","items":{"$ref":"#/components/schemas/DigicertDependency"}}}},"DigicertDependency":{"type":"object","properties":{"configProfileId":{"type":"integer","nullable":false,"example":1},"configProfileName":{"type":"string","example":"name"},"configProfileType":{"type":"string","nullable":false,"readOnly":true,"example":"OSX_CONFIGURATION_PROFILE","enum":["OSX_CONFIGURATION_PROFILE","IOS_CONFIGURATION_PROFILE"]}}},"DisableLostModeCommand":{"allOf":[{"$ref":"#/components/schemas/MdmCommandBase"},{"type":"object"}]},"DisableRemoteDesktopCommand":{"allOf":[{"$ref":"#/components/schemas/MdmCommandBase"},{"type":"object","properties":{"commandType":{"nullable":false,"example":"DISABLE_REMOTE_DESKTOP"}}}]},"DistributionPoint":{"required":["fileSharingConnectionType","name","serverName"],"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"1"},"name":{"type":"string","example":"My distribution point"},"serverName":{"type":"string","example":"My Server"},"principal":{"type":"boolean","default":false},"backupDistributionPointId":{"type":"string","default":"-1"},"sshUsername":{"type":"string","example":"john.doe"},"sshPassword":{"type":"string","format":"password","writeOnly":true,"example":"password"},"localPathToShare":{"type":"string","example":"/"},"fileSharingConnectionType":{"type":"string","description":"Specify the type of connection , Either of  fileSharingConnectionType (or) https connection type needs to be enabled using httpsEnabled for a distribution point to be created.","example":"AFP","enum":["AFP","SMB","NONE"],"default":"NONE"},"shareName":{"type":"string","description":"Required if fileSharingConnectionType is either AFP (or) SMB","example":"My Share"},"workgroup":{"type":"string","example":"WORKGROUP1"},"port":{"type":"integer","description":"Required if fileSharingConnectionType is either AFP (or) SMB","default":139},"readWriteUsername":{"type":"string","description":"Required if fileSharingConnectionType is either AFP (or) SMB","example":"john.doe"},"readWritePassword":{"type":"string","description":"Required if fileSharingConnectionType is either AFP (or) SMB","format":"password","writeOnly":true,"example":"password"},"readOnlyUsername":{"type":"string","description":"Required if fileSharingConnectionType is either AFP (or) SMB","example":"john.doe"},"readOnlyPassword":{"type":"string","description":"Required if fileSharingConnectionType is either AFP (or) SMB","format":"password","writeOnly":true,"example":"password"},"httpsEnabled":{"type":"boolean","description":"Allow downloads over HTTPS - requires installation of a valid SSL certificate","default":false},"httpsPort":{"type":"integer","description":"Port number of the server - required if HTTPS enabled","default":443},"httpsContext":{"type":"string","description":"Path to the share (e.g. if the share is accessible at http://192.168.10.10/JamfShare, the context is \"JamfShare\") - required if HTTPS enabled","example":"JamfShare"},"httpsSecurityType":{"type":"string","description":"Type of authentication required to download files from the distribution point - required if HTTPS enabled","enum":["USERNAME_PASSWORD","NONE"],"default":"NONE"},"httpsUsername":{"type":"string","description":"Required if httpsSecurityType is USERNAME_PASSWORD","example":"admin"},"httpsPassword":{"type":"string","description":"Required if httpsSecurityType is USERNAME_PASSWORD","format":"password","writeOnly":true,"example":"password"},"enableLoadBalancing":{"type":"boolean","description":"This is used to configure load balancing on the backup distribution point. Cannot be enabled when the backup distribution point configured is cloud.","default":false}}},"DistributionPointSearchResults":{"type":"object","properties":{"totalCount":{"type":"integer","example":1},"results":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/DistributionPoint"}}}},"DockItem":{"required":["name","path","type"],"type":"object","properties":{"id":{"minimum":1,"type":"string","readOnly":true,"example":"1"},"name":{"type":"string","example":"DockItem Name"},"type":{"type":"string","example":"FILE","enum":["APP","FILE","FOLDER"]},"path":{"type":"string","example":"file://localhost/Applications/iTunes.app"},"contents":{"type":"string","readOnly":true,"example":"<dict><key>GUID</key><integer>-91117049</integer><key>tile-data</key><dict><key>file-data</key><dict><key>_CFURLString</key><string>file://localhost/Applications/iTunes.app</string><key>_CFURLStringType</key><integer>15</integer></dict><key>file-label</key><string>MyDockItem2</string></dict><key>tile-type</key><string>directory-tile</string></dict>"}}},"DownloadUrl":{"type":"object","properties":{"uri":{"type":"string","nullable":false,"example":"https://example.cloudfront.net/96213b8b-a3ab-487d?response-content-disposition=attachment%3B+filename%3D%226gb.pkg%22&Expires=1678908843&Signature=hLsNd2__&Key-Pair-Id=K32YV"}},"description":"The URL to download a file from."},"DssDeclaration":{"type":"object","properties":{"uuid":{"type":"string","nullable":false,"example":"72676372-af55-432f-acd8-12984522e472"},"payloadJson":{"type":"string","nullable":true,"example":"{}"},"type":{"type":"string","nullable":true,"readOnly":true,"example":"com.apple.configuration.management.status-subscriptions"},"group":{"type":"string","nullable":true,"example":"activation","enum":["ACTIVATION","ASSET","CONFIGURATION","MANAGEMENT"]}}},"DssDeclarations":{"type":"object","properties":{"declarations":{"type":"array","nullable":false,"items":{"$ref":"#/components/schemas/DssDeclaration"},"default":[]}}},"Ebook":{"type":"object","properties":{"id":{"type":"string","example":"1"},"name":{"type":"string","example":"The Neverending API"},"kind":{"type":"string","example":"IBOOKS","enum":["UNKNOWN","PDF","EPUB","IBOOKS"]},"url":{"type":"string","example":"https://jamf.com/ibooks/the_neverending_api.just_kidding"},"free":{"type":"boolean","example":true},"version":{"type":"string","example":"10.9.0"},"author":{"type":"string","example":"IT Bob"},"deployAsManaged":{"type":"boolean","description":"If true, it will be automatically installed","example":false},"installAutomatically":{"type":"boolean","example":false},"categoryId":{"type":"string","example":"-1"},"siteId":{"type":"string","example":"-1"}}},"EbookExclusions":{"type":"object","properties":{"computerIds":{"type":"array","items":{"type":"string","example":"-1"}},"computerGroupIds":{"type":"array","items":{"type":"string","example":"-1"}},"mobileDeviceIds":{"type":"array","items":{"type":"string","example":"-1"}},"mobileDeviceGroupIds":{"type":"array","items":{"type":"string","example":"-1"}},"buildingIds":{"type":"array","items":{"type":"string","example":"-1"}},"departmentIds":{"type":"array","items":{"type":"string","example":"-1"}},"userIds":{"type":"array","items":{"type":"string","example":"-1"}},"userGroupIds":{"type":"array","items":{"type":"string","example":"-1"}},"limitations":{"$ref":"#/components/schemas/EbookLimitations"}}},"EbookLimitations":{"type":"object","properties":{"networkSegments":{"type":"array","items":{"type":"string","example":"1"}},"users":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"admin"}}}},"userGroups":{"type":"array","items":{"type":"string","example":"1"}}}},"EbookScope":{"type":"object","properties":{"allComputers":{"type":"boolean","example":false},"allMobileDevices":{"type":"boolean","example":false},"allUsers":{"type":"boolean","example":false},"computerIds":{"type":"array","items":{"type":"string","example":"-1"}},"computerGroupIds":{"type":"array","items":{"type":"string","example":"-1"}},"mobileDeviceIds":{"type":"array","items":{"type":"string","example":"-1"}},"mobileDeviceGroupIds":{"type":"array","items":{"type":"string","example":"-1"}},"buildingIds":{"type":"array","items":{"type":"string","example":"-1"}},"departmentIds":{"type":"array","items":{"type":"string","example":"-1"}},"userIds":{"type":"array","items":{"type":"string","example":"-1"}},"userGroupIds":{"type":"array","items":{"type":"string","example":"-1"}},"classroomIds":{"type":"array","items":{"type":"string","example":"-1"}},"limitations":{"$ref":"#/components/schemas/EbookLimitations"},"exclusions":{"$ref":"#/components/schemas/EbookExclusions"}}},"EbookSearchResults":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":3},"results":{"type":"array","items":{"$ref":"#/components/schemas/Ebook"}}}},"EnableLostModeCommand":{"allOf":[{"$ref":"#/components/schemas/MdmCommandBase"},{"type":"object","properties":{"lostModeMessage":{"type":"string","description":"Text displayed on the Lock Screen. At least one of lostModeMessage or lostModePhone must be provided.\n","example":"This device has been reported lost."},"lostModePhone":{"type":"string","description":"Phone number displayed on the Lock Screen. At least one of lostModePhone or lostModeMessage must be provided.\n","example":"123-456-7890"},"lostModeFootnote":{"type":"string","description":"Text displayed at the bottom of the Lock Screen.","example":"Please return to the front desk."}},"description":"Enables Lost Mode on a supervised iOS device. At least one of lostModeMessage or lostModePhone must be provided.\n"}]},"EnablePushRequest":{"required":["managementId"],"type":"object","properties":{"managementId":{"type":"string","description":"Unique identifier for the device management record to enable push for","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"}},"description":"Request body to enable push notifications for a client"},"EnableRemoteDesktopCommand":{"allOf":[{"$ref":"#/components/schemas/MdmCommandBase"},{"type":"object","properties":{"commandType":{"nullable":false,"example":"ENABLE_REMOTE_DESKTOP"}}}]},"EnrollmentAccessGroupPreview":{"required":["groupId","ldapServerId","name"],"type":"object","properties":{"id":{"type":"string","description":"Autogenerated ID","readOnly":true,"example":"1"},"groupId":{"type":"string","description":"LDAP Group ID","example":"1"},"ldapServerId":{"type":"string","example":"1"},"name":{"type":"string","example":"Grade School Pupils"},"siteId":{"type":"string","example":"-1"},"enterpriseEnrollmentEnabled":{"type":"boolean","example":false},"personalEnrollmentEnabled":{"type":"boolean","example":false},"accountDrivenUserEnrollmentEnabled":{"type":"boolean","example":false},"requireEula":{"type":"boolean","example":false}}},"EnrollmentCustomizationBrandingSettings":{"required":["backgroundColor","buttonColor","buttonTextColor","iconUrl","textColor"],"type":"object","properties":{"textColor":{"type":"string","example":"0000FF"},"buttonColor":{"type":"string","example":"0000FF"},"buttonTextColor":{"type":"string","example":"0000FF"},"backgroundColor":{"type":"string","example":"0000FF"},"iconUrl":{"type":"string","example":"https://jamfUrl/api/v2/enrollment-customizations/images/1"}}},"EnrollmentCustomizationDependencies":{"type":"object","properties":{"dependencies":{"type":"array","items":{"$ref":"#/components/schemas/EnrollmentCustomizationDependency"}}}},"EnrollmentCustomizationDependency":{"type":"object","properties":{"name":{"type":"string","example":"Name"},"humanReadableName":{"type":"string","example":"Enrollment Customization"},"hyperlink":{"type":"string","example":"/enrollment-customization/id"}}},"EnrollmentCustomizationLdapGroupAccess":{"type":"object","properties":{"ldapServerId":{"type":"integer","example":1},"groupName":{"type":"string","example":"admins"}}},"EnrollmentCustomizationPanel":{"required":["displayName","rank"],"type":"object","properties":{"displayName":{"type":"string","example":"A Panel"},"rank":{"type":"integer","example":0}}},"EnrollmentCustomizationPanelLdapAuth":{"allOf":[{"$ref":"#/components/schemas/EnrollmentCustomizationPanel"},{"required":["backButtonText","continueButtonText","passwordLabel","title","usernameLabel"],"type":"object","properties":{"usernameLabel":{"type":"string","example":"Username"},"passwordLabel":{"type":"string","example":"Password"},"title":{"pattern":"\\S","type":"string","example":"My Ldap Panel"},"backButtonText":{"type":"string","example":"Back"},"continueButtonText":{"type":"string","example":"Continue"},"ldapGroupAccess":{"type":"array","items":{"$ref":"#/components/schemas/EnrollmentCustomizationLdapGroupAccess"}}}}]},"EnrollmentCustomizationPanelList":{"type":"object","properties":{"panels":{"type":"array","items":{"$ref":"#/components/schemas/GetEnrollmentCustomizationPanel"}}}},"EnrollmentCustomizationPanelSsoAuth":{"allOf":[{"$ref":"#/components/schemas/EnrollmentCustomizationPanel"},{"required":["groupEnrollmentAccessName","isGroupEnrollmentAccessEnabled","isUseJamfConnect","longNameAttribute","shortNameAttribute"],"type":"object","properties":{"isUseJamfConnect":{"type":"boolean","example":false},"longNameAttribute":{"type":"string","example":"long name"},"shortNameAttribute":{"type":"string","example":"name"},"isGroupEnrollmentAccessEnabled":{"type":"boolean","example":false},"groupEnrollmentAccessName":{"type":"string","example":"GroupNameA","default":""}}}]},"EnrollmentCustomizationPanelText":{"allOf":[{"$ref":"#/components/schemas/EnrollmentCustomizationPanel"},{"required":["backButtonText","body","continueButtonText","title"],"type":"object","properties":{"body":{"type":"string","example":"Welcome!"},"subtext":{"type":"string","example":"World!"},"title":{"type":"string","example":"My text panel"},"backButtonText":{"type":"string","example":"Back"},"continueButtonText":{"type":"string","example":"Continue"}}}]},"EnrollmentCustomizationSearchResultsV2":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":1},"results":{"type":"array","items":{"$ref":"#/components/schemas/EnrollmentCustomizationV2"}}}},"EnrollmentCustomizationV2":{"required":["description","displayName","enrollmentCustomizationBrandingSettings","siteId"],"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"1"},"siteId":{"type":"string","example":"2"},"displayName":{"type":"string","example":"Example"},"description":{"type":"string","example":"Example description"},"enrollmentCustomizationBrandingSettings":{"$ref":"#/components/schemas/EnrollmentCustomizationBrandingSettings"}}},"EnrollmentMethod":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"1"},"objectName":{"type":"string","readOnly":true,"example":"user@domain.com"},"objectType":{"type":"string","readOnly":true,"example":"User-initiated - no invitation"}}},"EnrollmentMethodPrestage":{"type":"object","properties":{"mobileDevicePrestageId":{"type":"string","example":"5"},"profileName":{"type":"string","example":"All Mobiles"}}},"EnrollmentProcessTextObject":{"type":"object","properties":{"languageCode":{"type":"string","example":"en"},"name":{"type":"string","example":"English"},"title":{"type":"string","example":"Enroll Your Device"},"loginDescription":{"type":"string","example":"Log in to enroll your device."},"username":{"type":"string","example":"admin"},"password":{"type":"string","example":"12345"},"loginButton":{"type":"string","example":"Log in"},"deviceClassDescription":{"type":"string","example":"Specify if this device is institutionally owned or personally owned."},"deviceClassPersonal":{"type":"string","example":"Personally Owned"},"deviceClassPersonalDescription":{"type":"string","example":"For personally owned devices, IT administrators **can**\n\n         *   Lock the device\n         *   Apply institutional settings\n         *   Install and remove institutional data\n         *   Install and remove institutional apps\n\n\n         For personally owned devices, IT administrators **cannot**\n\n         *   Wipe all data and settings from your device\n         *   Track the location of your device\n         *   Remove anything they did not install\n         *   Add/remove configuration profiles\n         *   Add/remove provisioning profiles\n"},"deviceClassEnterprise":{"type":"string","example":"Institutionally Owned"},"deviceClassEnterpriseDescription":{"type":"string","example":"For institutionally owned devices, IT administrators **can**\n\n         *   Wipe all data and settings from the device\n         *   Lock the device\n         *   Remove the passcode\n         *   Apply institutional settings\n         *   Install and remove institutional data\n         *   Install and remove institutional apps\n         *   Add/remove configuration profiles\n         *   Add/remove provisioning profiles\n\n         For institutionally owned devices, IT administrators **cannot**:\n\n         *   Remove anything they did not install\n"},"deviceClassButton":{"type":"string","example":"Enroll"},"personalEula":{"type":"string","example":"Personal Eula"},"enterpriseEula":{"type":"string","example":"Enterprise Eula"},"eulaButton":{"type":"string","example":"Accept"},"siteDescription":{"type":"string","example":"Select the site to use for enrolling this computer or mobile device."},"certificateText":{"type":"string","example":"To continue with enrollment, you need to install the CA certificate for your organization."},"certificateButton":{"type":"string","example":"Continue"},"certificateProfileName":{"type":"string","example":"CA Certificate"},"certificateProfileDescription":{"type":"string","example":"CA Certificate for mobile device management"},"personalText":{"type":"string","description":"**Deprecated as of 11.25.** This field always returns empty string in GET responses and ignores any input values in PUT requests.\n","readOnly":true,"deprecated":true,"default":""},"personalButton":{"type":"string","description":"**Deprecated as of 11.25.** This field always returns empty string in GET responses and ignores any input values in PUT requests.\n","readOnly":true,"deprecated":true,"default":""},"personalProfileName":{"type":"string","description":"**Deprecated as of 11.25.** This field always returns empty string in GET responses and ignores any input values in PUT requests.\n","readOnly":true,"deprecated":true,"default":""},"personalProfileDescription":{"type":"string","description":"**Deprecated as of 11.25.** This field always returns empty string in GET responses and ignores any input values in PUT requests.\n","readOnly":true,"deprecated":true,"default":""},"userEnrollmentText":{"type":"string","default":"Enter your Managed Apple id to install the MDM Profile."},"userEnrollmentButton":{"type":"string","default":"Continue"},"userEnrollmentProfileName":{"type":"string","default":"MDM Profile"},"userEnrollmentProfileDescription":{"type":"string","default":"MDM Profile for mobile device management"},"enterpriseText":{"type":"string","example":"To continue with enrollment, you need to install the MDM profile for your organization."},"enterpriseButton":{"type":"string","example":"Continue"},"enterpriseProfileName":{"type":"string","example":"MDM Profile"},"enterpriseProfileDescription":{"type":"string","example":"MDM Profile for mobile device management"},"enterprisePending":{"type":"string","example":"To continue with enrollment, install the CA Certificate and MDM Profile that were downloaded to your computer."},"quickAddText":{"type":"string","example":"Download and install this package."},"quickAddButton":{"type":"string","example":"Download"},"quickAddName":{"type":"string","default":"QuickAdd.pkg"},"quickAddPending":{"type":"string","example":"Install the downloaded QuickAdd.pkg."},"completeMessage":{"type":"string","example":"The enrollment process is complete."},"failedMessage":{"type":"string","example":"The enrollment process could not be completed. Contact your IT administrator."},"tryAgainButton":{"type":"string","example":"Try Again"},"checkNowButton":{"type":"string","example":"Proceed"},"checkEnrollmentMessage":{"type":"string","example":"Tap \"Proceed\" to view the enrollment status for this device."},"logoutButton":{"type":"string","example":"Log Out"}}},"EnrollmentSettingsV4":{"required":["managementUsername"],"type":"object","properties":{"installSingleProfile":{"type":"boolean","default":false},"signingMdmProfileEnabled":{"type":"boolean","default":false},"mdmSigningCertificate":{"$ref":"#/components/schemas/CertificateIdentityV2"},"restrictReenrollment":{"type":"boolean","default":false},"flushLocationInformation":{"type":"boolean","default":false},"flushLocationHistoryInformation":{"type":"boolean","default":false},"flushPolicyHistory":{"type":"boolean","default":false},"flushExtensionAttributes":{"type":"boolean","default":false},"flushSoftwareUpdatePlans":{"type":"boolean","default":false},"flushMdmCommandsOnReenroll":{"type":"string","enum":["DELETE_NOTHING","DELETE_ERRORS","DELETE_EVERYTHING_EXCEPT_ACKNOWLEDGED","DELETE_EVERYTHING"],"default":"DELETE_EVERYTHING_EXCEPT_ACKNOWLEDGED"},"macOsEnterpriseEnrollmentEnabled":{"type":"boolean","default":false},"managementUsername":{"type":"string","example":"radmin","default":""},"createManagementAccount":{"type":"boolean","default":true},"hideManagementAccount":{"type":"boolean","default":false},"allowSshOnlyManagementAccount":{"type":"boolean","default":false},"ensureSshRunning":{"type":"boolean","default":true},"launchSelfService":{"type":"boolean","default":false},"signQuickAdd":{"type":"boolean","default":false},"developerCertificateIdentity":{"$ref":"#/components/schemas/CertificateIdentityV2"},"developerCertificateIdentityDetails":{"$ref":"#/components/schemas/CertificateDetails"},"mdmSigningCertificateDetails":{"$ref":"#/components/schemas/CertificateDetails"},"iosEnterpriseEnrollmentEnabled":{"type":"boolean","default":true},"iosPersonalEnrollmentEnabled":{"type":"boolean","default":false},"personalDeviceEnrollmentType":{"type":"string","description":"**Deprecated as of 11.25.** This field always returns \"USERENROLLMENT\" in GET responses and ignores any input values in PUT requests.\n","readOnly":true,"deprecated":true,"default":"USERENROLLMENT"},"accountDrivenUserEnrollmentEnabled":{"type":"boolean","default":false},"accountDrivenDeviceIosEnrollmentEnabled":{"type":"boolean","default":false},"accountDrivenDeviceMacosEnrollmentEnabled":{"type":"boolean","default":false},"accountDrivenUserVisionosEnrollmentEnabled":{"type":"boolean","default":false},"accountDrivenDeviceVisionosEnrollmentEnabled":{"type":"boolean","default":false},"maidUsernameMergeEnabled":{"type":"boolean","default":false}}},"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":""}}},"EraseDeviceCommand":{"allOf":[{"$ref":"#/components/schemas/MdmCommandBase"},{"type":"object","properties":{"preserveDataPlan":{"type":"boolean","description":"If true, preserve the data plan on an iPhone or iPad with eSIM functionality, if one exists. This value is available in iOS 11 and later.","example":true,"default":false},"disallowProximitySetup":{"type":"boolean","description":"If true, disable Proximity Setup on the next reboot and skip the pane in Setup Assistant. This value is available in iOS 11 and later. Prior to iOS 14, don’t use this option with any other option.","example":true,"default":false},"pin":{"maxLength":6,"minLength":6,"type":"string","description":"The six-character PIN for Find My. This value is available in macOS 10.8 and later.","example":"123456"},"obliterationBehavior":{"type":"string","description":"This key defines the fallback behavior for erasing a device.","example":"Default","enum":["Default","DoNotObliterate","ObliterateWithWarning","Always"]},"returnToService":{"$ref":"#/components/schemas/ReturnToService"}}}]},"EraseDeviceComputerRequest":{"type":"object","properties":{"pin":{"maximum":6,"minimum":6,"type":"string","description":"The six-character PIN for Find My.","nullable":true,"example":"123456"}}},"EraseDeviceComputerResponse":{"required":["commandUuid","deviceId"],"type":"object","properties":{"deviceId":{"type":"string","description":"Id of the computer for which eraseDevice command was queued","example":"1234"},"commandUuid":{"type":"string","description":"Uuid of the queued eraseDevice command","example":"1234-5678-90ab-cdef-1234567890ab"}}},"EraseDeviceMobileDeviceRequest":{"type":"object","properties":{"preserveDataPlan":{"type":"boolean","description":"If 'true', preserve the data plan on an iPhone or iPad with eSIM functionality, if one exists.","nullable":false,"example":true,"default":false},"disallowProximitySetup":{"type":"boolean","description":"If 'true', disable Proximity Setup on the next reboot and skip the pane in Setup Assistant.","nullable":false,"example":true,"default":false},"clearActivationLock":{"type":"boolean","description":"Clear the activation lock on the device.","nullable":false,"example":true,"default":false},"returnToService":{"type":"boolean","description":"If 'true', the device will be returned to service after the erase is complete.","nullable":false,"example":true,"default":false}}},"EraseDeviceMobileDeviceResponse":{"required":["commandUuid","deviceId"],"type":"object","properties":{"deviceId":{"type":"string","description":"Id of the mobile device for which eraseDevice command was queued","example":"1234"},"commandUuid":{"type":"string","description":"Uuid of the queued eraseDevice command","example":"1234-5678-90ab-cdef-1234567890ab"}}},"ExportField":{"type":"object","properties":{"fieldName":{"type":"string","description":"English name of the field to be exported.","example":"id"},"fieldLabelOverride":{"type":"string","description":"Name which should be used for the label in the response - can be in any language. When null the fieldName itself will be used as the label.","nullable":true,"example":"identiteit"}},"description":"Field to be included in the export operation."},"ExportParameters":{"type":"object","properties":{"page":{"type":"integer","nullable":true,"example":0,"default":0},"pageSize":{"type":"integer","nullable":true,"example":100,"default":100},"sort":{"type":"array","description":"Sorting criteria in the format: [<property>[:asc/desc]. Default direction when not stated is ascending.","nullable":true,"example":["id:asc"],"items":{"type":"string"},"default":["id:desc"]},"filter":{"type":"string","nullable":true,"example":"id>=100"},"fields":{"type":"array","description":"Used to change default order or ignore some of the fields. When null or empty array, all fields will be exported.","nullable":true,"items":{"$ref":"#/components/schemas/ExportField"}}}},"ExtensionAttributeV2":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"1"},"name":{"type":"string","example":"Example EA"},"type":{"type":"string","example":"STRING","enum":["STRING","INTEGER","DATE"]},"value":{"type":"array","items":{"type":"string","example":"EA Value"}},"extensionAttributeCollectionAllowed":{"type":"boolean","example":false}}},"ExtensionAttributeValue":{"type":"object","properties":{"displayName":{"type":"string","nullable":false,"example":"EA Name"},"value":{"type":"string","nullable":true,"example":"EA Value"}}},"ExtensionAttributes":{"required":["dataType","name"],"type":"object","properties":{"id":{"type":"string","description":"Unique Id for Mobile Device Extension Attribute.","readOnly":true,"example":"1"},"name":{"type":"string","description":"Display name for the extension attribute.","example":"MobileDeviceExtensionAttribute"},"description":{"type":"string","description":"Description for the extension attribute.","example":"Mobile Device Extension Attribute"},"dataType":{"type":"string","description":"Type of data being collected.","enum":["INTEGER","STRING","DATE"],"default":"STRING"}}},"ExternalRecipient":{"required":["email","name"],"type":"object","properties":{"name":{"minLength":1,"type":"string","example":"Bob Exampleman"},"email":{"minLength":1,"type":"string","example":"bob@example.com"}}},"FedRampBrokerInitializeV1":{"required":["activationCode","configUuid","email","eulaAccepted","institutionName","jssUrl","username"],"type":"object","properties":{"activationCode":{"maxLength":39,"minLength":39,"type":"string","example":"VFAB-YDAB-DFAB-UDAB-DEAB-EFAB-ABAB-DEAB"},"institutionName":{"minLength":1,"type":"string","example":"Jamf"},"configUuid":{"pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string","description":"UUID selecting the tenant's OIDC broker config in the remote oidc-authentication-service","example":"11111111-2222-3333-4444-555555555555"},"eulaAccepted":{"type":"boolean","example":true},"username":{"minLength":1,"type":"string","description":"Federated user OIDC username to create","example":"admin"},"email":{"type":"string","description":"Federated user OIDC email to create","example":"ITBob@jamf.com"},"jssUrl":{"minLength":1,"type":"string","example":"https://jamf.jamfcloud.com"}},"description":"FedRAMP broker initialization data"},"FileAttachmentV2":{"type":"object","properties":{"id":{"type":"string","example":"1"},"name":{"type":"string","example":"receipt.pdf"}}},"FileAttachmentV3":{"type":"object","properties":{"id":{"type":"string","example":"1"},"name":{"type":"string","example":"receipt.pdf"}}},"FileData":{"type":"object","properties":{"fileName":{"type":"string","description":"The name of the file","nullable":false,"readOnly":true,"example":"test.txt"},"length":{"type":"integer","description":"The length in bytes","nullable":false,"readOnly":true,"example":1321654},"md5":{"type":"string","description":"The MD5 in hex","nullable":false,"readOnly":true,"example":"9e47d8266df642dc2c3cd73206189781"},"region":{"type":"string","description":"The region the file is hosted in","nullable":false,"readOnly":true,"example":"us-east-1"},"sha3":{"type":"string","description":"The SHA3_512 in hex","nullable":false,"readOnly":true,"example":"4b2c9436a4e3e330bad91eaa55b66591cd4823548a681eff970b9b949d96201f8c6862ba8308dac1fdf53b9f4356d287bd1062b4f4b89dc2205d9f15776fd58f"}},"description":"Metadata pertaining to the file."},"FileTransferItem":{"type":"object","properties":{"filePath":{"type":"string","nullable":false,"example":"/SomeFilePath/ToFile.xml"},"transferTimestamp":{"type":"string","format":"date-time","nullable":false,"example":"2023-11-07T10:25:27.49Z"},"fileTransferType":{"type":"string","nullable":false,"example":"DOWNLOAD","enum":["DOWNLOAD","UPLOAD"]}}},"FontPath":{"required":["id","path"],"type":"object","properties":{"id":{"type":"string","description":"A \"-1\" id indicates a built-in path that cannot be deleted or modified.","example":"2"},"path":{"type":"string","example":"/Example/Path/To/Font/"}}},"GetComputerPrestageV3":{"allOf":[{"$ref":"#/components/schemas/ComputerPrestageV3"},{"type":"object","properties":{"id":{"minLength":1,"type":"string","readOnly":true,"example":"1"},"profileUuid":{"type":"string","example":"29d-a8d8f-b8sdjndf-dsa9"},"siteId":{"type":"string","example":"5"},"versionLock":{"minimum":0,"type":"integer","example":0},"accountSettings":{"$ref":"#/components/schemas/AccountSettingsResponse"}}}]},"GetEnrollmentCustomizationPanel":{"allOf":[{"$ref":"#/components/schemas/EnrollmentCustomizationPanel"},{"type":"object","properties":{"id":{"type":"integer","example":2},"type":{"type":"string","example":"text"}}}]},"GetEnrollmentCustomizationPanelLdapAuth":{"allOf":[{"$ref":"#/components/schemas/EnrollmentCustomizationPanelLdapAuth"},{"type":"object","properties":{"id":{"type":"integer","example":2},"type":{"type":"string","example":"ldap"}}}]},"GetEnrollmentCustomizationPanelSsoAuth":{"allOf":[{"$ref":"#/components/schemas/EnrollmentCustomizationPanelSsoAuth"},{"type":"object","properties":{"id":{"type":"integer","example":2},"type":{"type":"string","example":"sso"}}}]},"GetEnrollmentCustomizationPanelText":{"allOf":[{"$ref":"#/components/schemas/EnrollmentCustomizationPanelText"},{"type":"object","properties":{"id":{"type":"integer","example":2},"type":{"type":"string","example":"text"}}}]},"GetMobileDevicePrestageV2":{"allOf":[{"$ref":"#/components/schemas/MobileDevicePrestageV2"},{"type":"object","properties":{"id":{"type":"string","example":"1"},"profileUuid":{"type":"string","example":"29d-a8d8f-b8sdjndf-dsa9"},"siteId":{"type":"string","example":"5"},"versionLock":{"type":"integer","example":0}}}]},"GetMobileDevicePrestageV3":{"allOf":[{"$ref":"#/components/schemas/MobileDevicePrestageV3"},{"type":"object","properties":{"id":{"type":"string","example":"1"},"profileUuid":{"type":"string","example":"29d-a8d8f-b8sdjndf-dsa9"},"siteId":{"type":"string","example":"5"},"versionLock":{"type":"integer","example":0}}}]},"GroupDtoV1":{"type":"object","properties":{"groupPlatformId":{"type":"string","readOnly":true,"example":"56585788-8937-4bdf-b986-458048b1c36c"},"groupJamfProId":{"type":"string","readOnly":true,"example":"1"},"groupName":{"type":"string","readOnly":true,"example":"New Group Name"},"groupDescription":{"type":"string","readOnly":true,"example":"New Group Description"},"groupType":{"type":"string","readOnly":true,"example":"MOBILE","enum":["MOBILE","COMPUTER"]},"smart":{"type":"boolean","readOnly":true,"example":true},"membershipCount":{"minimum":0,"type":"integer","readOnly":true,"example":3}}},"GroupMappings":{"required":["groupID","groupName","groupUuid","objectClassLimitation","objectClasses","searchBase","searchScope"],"type":"object","properties":{"objectClassLimitation":{"type":"string","example":"ANY_OBJECT_CLASSES","enum":["ANY_OBJECT_CLASSES","ALL_OBJECT_CLASSES"]},"objectClasses":{"type":"string","example":"groupOfNames"},"searchBase":{"type":"string","example":"ou=Groups"},"searchScope":{"type":"string","example":"ALL_SUBTREES","enum":["ALL_SUBTREES","FIRST_LEVEL_ONLY"]},"groupID":{"type":"string","example":"cn"},"groupName":{"type":"string","example":"cn"},"groupUuid":{"type":"string","example":"gidNumber"}},"description":"Cloud Identity Provider user group mappings configuration"},"GroupMembership":{"type":"object","properties":{"groupId":{"type":"string","example":"1"},"groupName":{"type":"string","example":"groupOne"},"groupDescription":{"type":"string","example":"groupOne description"},"smartGroup":{"type":"boolean","description":"Indicates that group is smart group","example":true}}},"GroupResetRequest":{"type":"object","properties":{"preserveDataPlan":{"type":"boolean","nullable":false,"example":true},"disallowProximitySetup":{"type":"boolean","nullable":false,"example":true},"clearActivationLock":{"type":"boolean","nullable":false,"example":true},"returnToService":{"type":"boolean","nullable":false,"example":true}}},"GroupSearchResult":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":2},"results":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/GroupDtoV1"}}}},"GroupTestSearch":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"cn=users,ou=Groups,dc=jamf,dc=com"},"id":{"type":"string","example":"users"},"uuid":{"type":"string","example":"121100023"},"serverId":{"type":"string","example":"1001"},"name":{"type":"string","example":"users"}}},"GroupTestSearchRequest":{"required":["groupname"],"type":"object","properties":{"groupname":{"type":"string","example":"users"}}},"GroupTestSearchResponse":{"type":"object","properties":{"totalCount":{"type":"integer","example":1},"results":{"type":"array","items":{"$ref":"#/components/schemas/GroupTestSearch"}}}},"GroupUpdateDtoV1":{"type":"object","properties":{"groupName":{"type":"string","example":"Updated Group Name"},"groupDescription":{"type":"string","example":"Updated Group Description"},"criteria":{"type":"array","items":{"$ref":"#/components/schemas/SmartGroupCriteria"}},"assignments":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/AssignmentDtoV1"}}}},"GroupUpdateDtoV2":{"type":"object","properties":{"groupName":{"type":"string","example":"Updated Group Name"},"groupDescription":{"type":"string","example":"Updated Group Description"},"criteria":{"type":"array","items":{"$ref":"#/components/schemas/UnifiedSmartGroupCriteriaV2"}},"assignments":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/AssignmentDtoV1"}}}},"GroupWithCriteriaDtoV1":{"type":"object","properties":{"groupPlatformId":{"type":"string","readOnly":true,"example":"56585788-8937-4bdf-b986-458048b1c36c"},"groupJamfProId":{"type":"string","readOnly":true,"example":"1"},"groupName":{"type":"string","readOnly":true,"example":"New Group Name"},"groupDescription":{"type":"string","readOnly":true,"example":"New Group Description"},"groupType":{"type":"string","readOnly":true,"example":"MOBILE","enum":["MOBILE","COMPUTER"]},"smart":{"type":"boolean","readOnly":true,"example":true},"membershipCount":{"minimum":0,"type":"integer","readOnly":true,"example":3},"criteria":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SmartGroupCriteria"}}}},"GsxConnection":{"required":["enabled","gsxKeystore","serviceAccountNo","token","username"],"type":"object","properties":{"enabled":{"type":"boolean","example":true,"default":false},"username":{"type":"string","example":"exampleEmail@example.com","default":" "},"serviceAccountNo":{"maxLength":10,"type":"string","example":"0000012345"},"shipToNo":{"maxLength":10,"type":"string","example":"0000012345"},"token":{"type":"string","writeOnly":true,"example":"34dsg23-5dsgs-3sdg-4ffs-435sdgs"},"gsxKeystore":{"$ref":"#/components/schemas/GsxKeystore"}}},"GsxConnectionUpdate":{"type":"object","properties":{"enabled":{"type":"boolean","example":true,"default":false},"username":{"type":"string","example":"exampleEmail@example.com","default":" "},"serviceAccountNo":{"maxLength":10,"type":"string","example":"0000012345"},"shipToNo":{"maxLength":10,"type":"string","example":"0000012345"},"token":{"type":"string","writeOnly":true,"example":"34dsg23-5dsgs-3sdg-4ffs-435sdgs"},"gsxKeystore":{"$ref":"#/components/schemas/GsxKeystore"}}},"GsxKeystore":{"required":["keystore","keystorePassword","name"],"type":"object","properties":{"name":{"type":"string","example":"certificate.p12","default":" "},"expirationEpoch":{"type":"integer","format":"int64","readOnly":true,"example":169195490000},"errorMessage":{"type":"string","readOnly":true,"example":"Certificate error"},"keystoreBytes":{"pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$","type":"string","description":"The base 64 encoded of the GSX Connection keystore.","format":"byte","writeOnly":true,"example":"WlhoaGJYQnNaU0J2WmlCaElHSmhjMlUyTkNCbGJtTnZaR1ZrSUhaaGJHbGtJSEF4TWk0Z2EyVjVjM1J2Y21VZ1ptbHNaUT09"},"keystorePassword":{"type":"string","format":"password","writeOnly":true,"example":"test1234"}}},"GsxTestResponse":{"required":["message","request","response"],"type":"object","properties":{"message":{"type":"string","example":"Unable to authenticate to GSX server"},"request":{"type":"string","example":"[Accept: application/json, Content-Type: application/json, X-Apple-SoldTo: 0000012345, X-Apple-ShipTo: 0000012345] GET https://api-partner-connect.apple.com/api/authenticate/check HTTP/1.1"},"response":{"type":"string","example":"OK"}}},"HealthStatus":{"required":["api","default","device","enrollment","ui"],"type":"object","properties":{"api":{"$ref":"#/components/schemas/HealthStatusStats"},"ui":{"$ref":"#/components/schemas/HealthStatusStats"},"enrollment":{"$ref":"#/components/schemas/HealthStatusStats"},"device":{"$ref":"#/components/schemas/HealthStatusStats"},"default":{"$ref":"#/components/schemas/HealthStatusStats"}},"nullable":false},"HealthStatusStats":{"type":"object","properties":{"thirtySeconds":{"type":"number","description":"Percentage of accepted requests out of total requests for the last 30 seconds","nullable":false,"readOnly":true,"example":0.75},"oneMinute":{"type":"number","description":"Percentage of accepted requests out of total requests for the last 1 minute","readOnly":true,"example":0.75},"fiveMinutes":{"type":"number","description":"Percentage of accepted requests out of total requests for the last 5 minutes","readOnly":true,"example":0.75},"fifteenMinutes":{"type":"number","description":"Percentage of accepted requests out of total requests for the last 15 minutes","readOnly":true,"example":0.75},"thirtyMinutes":{"type":"number","description":"Percentage of accepted requests out of total requests for the last 30 minutes","readOnly":true,"example":0.75}},"nullable":false,"readOnly":true},"HistorySearchResults":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":1},"results":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/ObjectHistory"}}}},"HistorySearchResultsV1":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":1},"results":{"type":"array","items":{"$ref":"#/components/schemas/ObjectHistoryV1"}}}},"HrefResponse":{"type":"object","properties":{"id":{"minLength":1,"type":"string","example":"1"},"href":{"type":"string","example":"https://yourJamfProUrl.jamf/api/v1/resource/1"}}},"IconResponse":{"type":"object","properties":{"url":{"type":"string","example":"https://stage-ics.services.jamfcloud.com/icon/hash_c315ef577b84505de1bfcb50b0c4b1c963da30b2a805f84b24ad09f282b7fad4"},"id":{"type":"integer","example":5}}},"IdAndNameV2":{"type":"object","properties":{"id":{"type":"string","example":"1"},"name":{"type":"string","example":"A name"}}},"Ids":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string","example":"1"}}}},"ImpactAlertNotificationSettingsV1":{"required":["deployableObjectsAlertEnabled","deployableObjectsConfirmationCodeEnabled","scopeableObjectsAlertEnabled","scopeableObjectsConfirmationCodeEnabled"],"type":"object","properties":{"scopeableObjectsAlertEnabled":{"type":"boolean","default":true},"scopeableObjectsConfirmationCodeEnabled":{"type":"boolean","default":false},"deployableObjectsAlertEnabled":{"type":"boolean","default":true},"deployableObjectsConfirmationCodeEnabled":{"type":"boolean","default":false}}},"InitializeV1":{"required":["activationCode","eulaAccepted","institutionName","jssUrl","password","username"],"type":"object","properties":{"activationCode":{"maxLength":39,"minLength":39,"type":"string","example":"VFAB-YDAB-DFAB-UDAB-DEAB-EFAB-ABAB-DEAB"},"institutionName":{"minLength":1,"type":"string","example":"Jamf"},"eulaAccepted":{"type":"boolean","example":false},"username":{"minLength":1,"type":"string","example":"admin"},"password":{"minLength":1,"type":"string","format":"password","writeOnly":true,"example":"12345"},"email":{"type":"string","example":"ITBob@jamf.com"},"jssUrl":{"minLength":1,"type":"string","example":"https://jamf.jamfcloud.com"}},"description":"Initial Jamf Pro setup data"},"InstallPackage":{"required":["manifest"],"type":"object","properties":{"manifest":{"$ref":"#/components/schemas/PackageManifest"},"installAsManaged":{"type":"boolean","example":false},"devices":{"type":"array","example":[1,2,3],"items":{"type":"integer"}},"groupId":{"type":"string","example":"1"}},"description":"Either devices or groupId must be provided"},"InstalledApplicationListCommand":{"allOf":[{"$ref":"#/components/schemas/MdmCommandBase"},{"type":"object","properties":{"identifiers":{"type":"array","description":"Array of application bundle identifiers to query. If not provided, all installed applications are returned.","nullable":true,"example":["com.example.app1","com.example.app2"],"items":{"minLength":1,"type":"string","nullable":false}},"managedAppsOnly":{"type":"boolean","description":"If true, only managed applications are returned. If false or not provided, all applications are returned.","nullable":true,"example":false},"items":{"type":"array","description":"Array of keys to include in the response for each application. If not provided, default keys are returned.","nullable":true,"example":["Identifier","Version","Name","BundleSize"],"items":{"type":"string","enum":["AdHocCodeSigned","AppStoreVendable","BetaApp","BundleSize","DeviceBasedVpp","DistributorIdentifier","DynamicSize","ExternalVersionIdentifier","HasUpdateAvailable","Identifier","Installing","AppClip","Validated","Name","ShortVersion","Version"]}}}}]},"InternalRecipient":{"required":["accountId"],"type":"object","properties":{"accountId":{"pattern":"^\\d+$","type":"string","example":"1"},"frequency":{"type":"string","example":"DAILY","enum":["DAILY"],"default":"DAILY"}}},"InventoryInformation":{"type":"object","properties":{"managedComputers":{"minimum":0,"type":"integer","description":"Number of managed computers in inventory.","readOnly":true,"example":1200},"unmanagedComputers":{"minimum":0,"type":"integer","description":"Number of unmanaged computers in inventory.","readOnly":true,"example":1100},"managedDevices":{"minimum":0,"type":"integer","description":"Number of managed devices in inventory.","readOnly":true,"example":1200},"unmanagedDevices":{"minimum":0,"type":"integer","description":"Number of unmanaged devices in inventory.","readOnly":true,"example":1100}},"description":"Jamf Pro Inventory statistics object. Aggregates managed/unmanaged devices and computers counters"},"InventoryListMobileDevice":{"type":"object","properties":{"mobileDeviceId":{"minLength":1,"type":"string","example":"1"},"udid":{"type":"string","example":"0dad565fb40b010a9e490440188063a378721069"},"airPlayPassword":{"type":"string","format":"password","example":"1234"},"appAnalyticsEnabled":{"type":"boolean","example":false},"assetTag":{"type":"string","example":"8675309"},"availableSpaceMb":{"type":"integer","example":26646},"batteryLevel":{"type":"integer","example":100},"batteryHealth":{"type":"string","description":"- NON_GENUINE: The battery isn't a genuine Apple battery.\n- NORMAL: The battery is operating normally.\n- SERVICE_RECOMMENDED: The system recommends battery service.\n- UNKNOWN: The system couldn't determine battery health information.\n- UNSUPPORTED: The device doesn't support battery health reporting.\n","enum":["NON_GENUINE","NORMAL","SERVICE_RECOMMENDED","UNKNOWN","UNSUPPORTED"],"default":"UNKNOWN"},"bluetoothLowEnergyCapable":{"type":"boolean","example":false},"bluetoothMacAddress":{"type":"string","example":"ee:00:7c:f0:e5:aa"},"capacityMb":{"type":"integer","example":27503},"lostModeEnabledDate":{"type":"string","format":"date-time","example":"2022-10-17T11:48:56.307Z"},"declarativeDeviceManagementEnabled":{"type":"boolean","example":false},"appleEnrollmentType":{"type":"string","description":"The enrollment type reported by Apple.","example":"supervised","enum":["none","supervised","device","user","unknown"]},"awaitingConfiguration":{"type":"boolean","description":"Whether the device is awaiting configuration.","example":false},"returnToServiceEnabled":{"type":"boolean","description":"Whether Return to Service is enabled.","example":false},"lockdownModeEnabled":{"type":"boolean","description":"Whether Lockdown Mode is enabled.","example":false},"deviceId":{"type":"string","example":"1"},"deviceLocatorServiceEnabled":{"type":"boolean","example":false},"deviceOwnershipType":{"type":"string","example":"institutional"},"devicePhoneNumber":{"type":"string","example":"555-555-5555"},"diagnosticAndUsageReportingEnabled":{"type":"boolean","example":false},"displayName":{"type":"string","example":"iPad"},"doNotDisturbEnabled":{"type":"boolean","example":false},"enrollmentSessionTokenValid":{"type":"boolean","example":false},"exchangeDeviceId":{"type":"string","example":"TH3YE2RI4D234IS2B6U6IGH95D"},"cloudBackupEnabled":{"type":"boolean","example":false},"osBuild":{"type":"string","example":"15F79"},"osSupplementalBuildVersion":{"type":"string","example":"22A103310o"},"osRapidSecurityResponse":{"type":"string","example":"(a)"},"osVersion":{"type":"string","example":"11.4"},"ipAddress":{"type":"string","example":"10.0.0.1"},"itunesStoreAccountActive":{"type":"boolean","example":false},"jamfParentPairings":{"type":"integer","example":1},"languages":{"type":"string","example":"Polish"},"lastBackupDate":{"type":"string","format":"date-time","example":"2022-10-17T11:48:56.307Z"},"lastContactDate":{"type":"string","format":"date-time","example":"2022-10-17T11:48:56.307Z"},"lastEnrolledDate":{"type":"string","format":"date-time","example":"2022-10-17T11:48:56.307Z"},"lastCloudBackupDate":{"type":"string","format":"date-time","example":"2022-10-17T11:48:56.307Z"},"lastInventoryUpdateDate":{"type":"string","format":"date-time","example":"2022-10-17T11:48:56.307Z"},"locales":{"type":"string","example":"null"},"locationServicesForSelfServiceMobileEnabled":{"type":"boolean","example":false},"lostModeEnabled":{"type":"boolean","example":false},"managed":{"type":"boolean","example":true},"managementId":{"type":"string","example":"73226fb6-61df-4c10-9552-eb9bc353d507"},"mdmProfileExpirationDate":{"type":"string","format":"date-time","example":"2022-10-17T11:48:56.307Z"},"model":{"type":"string","example":"iPad 7th Generation (Wi-Fi)"},"modelIdentifier":{"type":"string","example":"iPad7,11"},"modelNumber":{"type":"string","example":"MW742LL"},"modemFirmwareVersion":{"type":"string","example":"5.70.01"},"pairedDevices":{"type":"integer","example":1},"quotaSize":{"type":"integer","example":1024},"residentUsers":{"type":"integer","example":0},"serialNumber":{"type":"string","example":"5c28fdae"},"sharedIpad":{"type":"boolean","example":false},"supervised":{"type":"boolean","example":true},"tethered":{"type":"boolean","example":false},"timeZone":{"type":"string","example":"Europe/Warsaw"},"usedSpacePercentage":{"type":"integer","example":3},"wifiMacAddress":{"type":"string","example":"C4:84:66:92:78:00"},"building":{"type":"string","example":"Eau Claire"},"department":{"type":"string","example":"Support"},"emailAddress":{"type":"string","example":"support@jamf.com"},"fullName":{"type":"string","example":"John Smith"},"position":{"type":"string","example":"IT Team Lead"},"room":{"type":"string","example":"4th Floor - Quad 3"},"userPhoneNumber":{"type":"string","example":"555-555-5555"},"username":{"type":"string","example":"admin"},"appleCareId":{"type":"string","example":"9546567.0"},"leaseExpirationDate":{"type":"string","format":"date-time","example":"2022-10-17T11:48:56.307Z"},"lifeExpectancyYears":{"type":"integer","example":7},"poDate":{"type":"string","format":"date-time","example":"2022-10-17T11:48:56.307Z"},"poNumber":{"type":"string","example":"8675309"},"purchasePrice":{"type":"string","example":"$399"},"purchasedOrLeased":{"type":"boolean","example":true},"purchasingAccount":{"type":"string","example":"IT Budget"},"purchasingContact":{"type":"string","example":"Nick in IT"},"vendor":{"type":"string","example":"Apple"},"warrantyExpirationDate":{"type":"string","format":"date-time","example":"2022-10-17T11:48:56.307Z"},"activationLockEnabled":{"type":"boolean","example":true},"blockEncryptionCapable":{"type":"boolean","example":false},"dataProtection":{"type":"boolean","example":false},"fileEncryptionCapable":{"type":"boolean","example":false},"hardwareEncryptionSupported":{"type":"boolean","example":false},"jailbreakStatus":{"type":"string","example":"Compromised"},"passcodeCompliant":{"type":"boolean","example":true},"passcodeCompliantWithProfile":{"type":"boolean","example":true},"passcodeLockGracePeriodEnforcedSeconds":{"type":"integer","example":9819083},"passcodePresent":{"type":"boolean","example":true},"personalDeviceProfileCurrent":{"type":"boolean","description":"**Deprecated as of 11.25.** This field always returns false.\n","readOnly":true,"deprecated":true,"default":false},"carrierSettingsVersion":{"type":"string","example":"33.1"},"cellularTechnology":{"type":"string","example":"Both"},"currentCarrierNetwork":{"type":"string","example":"Verizon Wireless"},"currentMobileCountryCode":{"type":"string","example":"311"},"currentMobileNetworkCode":{"type":"string","example":"480"},"dataRoamingEnabled":{"type":"boolean","example":true},"eid":{"type":"string","example":"89049032007008882600085727376656"},"homeCarrierNetwork":{"type":"string","example":"Verizon"},"homeMobileCountryCode":{"type":"string","example":"US"},"homeMobileNetworkCode":{"type":"string","example":"480"},"iccid":{"type":"string","example":"8991101200003204514"},"imei":{"type":"string","example":"35 882334 083223 0"},"imei2":{"type":"string","example":"35 585308 072899 3"},"meid":{"type":"string","example":"35882334083223"},"personalHotspotEnabled":{"type":"boolean","example":false},"preferredVoiceNumber":{"type":"string","example":"555-555-5555"},"roaming":{"type":"boolean","example":false},"voiceRoamingEnabled":{"type":"string","example":"Enabled"},"lastLoggedInUsernameSelfService":{"type":"string","nullable":true,"example":"admin"},"lastLoggedInUsernameSelfServiceTimestamp":{"type":"string","format":"date-time","nullable":true,"example":"2018-10-31T18:04:13Z"},"lastLoggedInUsernameMdm":{"type":"string","nullable":true,"example":"admin"},"lastLoggedInUsernameMdmTimestamp":{"type":"string","format":"date-time","nullable":true,"example":"2018-10-31T18:04:13Z"},"extensionAttributeValueList":{"minLength":0,"type":"array","items":{"$ref":"#/components/schemas/ExtensionAttributeValue"}}}},"InventoryListMobileDeviceSearchResults":{"type":"object","properties":{"totalCount":{"type":"integer","nullable":false,"example":3},"results":{"type":"array","items":{"$ref":"#/components/schemas/InventoryListMobileDevice"}}}},"InventoryPreloadCsvValidationError":{"type":"object","properties":{"httpStatus":{"type":"integer","description":"HTTP status of the response","example":400},"errors":{"type":"array","items":{"$ref":"#/components/schemas/InventoryPreloadCsvValidationErrorCause"}}}},"InventoryPreloadCsvValidationErrorCause":{"allOf":[{"$ref":"#/components/schemas/ApiErrorCause"},{"type":"object","properties":{"value":{"type":"string","example":"abcdefghijklmnopqrstuwxyzabcdefghijklmnopqrstuwxyzabcdefghijklmnopqrstuwxyz"},"serialNumber":{"type":"string","example":"R7QFDE2YCFN4"},"line":{"type":"integer","example":5},"fieldSize":{"type":"integer","example":60},"deviceType":{"type":"string","example":"Computer"}}}]},"InventoryPreloadCsvValidationSuccess":{"type":"object","properties":{"recordCount":{"type":"integer","example":10}}},"InventoryPreloadExtensionAttribute":{"required":["name"],"type":"object","properties":{"name":{"type":"string","example":"foo"},"value":{"type":"string","example":"42"}}},"InventoryPreloadExtensionAttributeColumn":{"type":"object","properties":{"name":{"type":"string","example":"eaColumn1"},"fullName":{"type":"string","example":"Column 1"}}},"InventoryPreloadExtensionAttributeColumnResult":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":10},"results":{"type":"array","items":{"$ref":"#/components/schemas/InventoryPreloadExtensionAttributeColumn"}}}},"InventoryPreloadRecordSearchResultsV2":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":10},"results":{"type":"array","items":{"$ref":"#/components/schemas/InventoryPreloadRecordV2"}}}},"InventoryPreloadRecordV2":{"required":["deviceType","serialNumber"],"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"1"},"serialNumber":{"type":"string","example":"C02L29ECF8J1"},"deviceType":{"type":"string","example":"Computer","enum":["Computer","Mobile Device","Unknown"]},"username":{"type":"string","nullable":true,"example":"admin"},"fullName":{"type":"string","nullable":true,"example":"Name"},"emailAddress":{"type":"string","nullable":true,"example":"ITBob@jamf.com"},"phoneNumber":{"type":"string","nullable":true,"example":"555-555-5555"},"position":{"type":"string","nullable":true,"example":"IT Team Lead"},"department":{"type":"string","nullable":true,"example":"IT"},"building":{"type":"string","nullable":true,"example":"Eau Claire"},"room":{"type":"string","nullable":true,"example":"4th Floor - Quad 3"},"poNumber":{"type":"string","nullable":true,"example":"8675309"},"poDate":{"type":"string","nullable":true,"example":"2019-02-04T21:09:31.661Z"},"warrantyExpiration":{"type":"string","nullable":true,"example":"2012-07-21"},"appleCareId":{"type":"string","nullable":true,"example":"5678"},"lifeExpectancy":{"type":"string","nullable":true,"example":"5 years"},"purchasePrice":{"type":"string","nullable":true,"example":"$399"},"purchasingContact":{"type":"string","nullable":true,"example":"Nick in IT"},"purchasingAccount":{"type":"string","nullable":true,"example":"IT Budget"},"leaseExpiration":{"type":"string","nullable":true,"example":"2015-06-19"},"barCode1":{"type":"string","nullable":true,"example":"123456789"},"barCode2":{"type":"string","nullable":true,"example":"123456789"},"assetTag":{"type":"string","nullable":true,"example":"ABCDEFG12345"},"vendor":{"type":"string","nullable":true,"example":"Apple"},"extensionAttributes":{"type":"array","items":{"$ref":"#/components/schemas/InventoryPreloadExtensionAttribute"}}}},"InventorySelectionListMobileDevice":{"type":"object","properties":{"mobileDeviceId":{"minLength":1,"type":"string","example":"1"},"udid":{"type":"string","example":"0dad565fb40b010a9e490440188063a378721069"},"airPlayPassword":{"type":"string","format":"password","example":"1234"},"appAnalyticsEnabled":{"type":"boolean","example":false},"assetTag":{"type":"string","example":"8675309"},"availableSpaceMb":{"type":"integer","example":26646},"batteryLevel":{"type":"integer","example":100},"batteryHealth":{"type":"string","description":"- NON_GENUINE: The battery isn't a genuine Apple battery.\n- NORMAL: The battery is operating normally.\n- SERVICE_RECOMMENDED: The system recommends battery service.\n- UNKNOWN: The system couldn't determine battery health information.\n- UNSUPPORTED: The device doesn't support battery health reporting.\n","enum":["NON_GENUINE","NORMAL","SERVICE_RECOMMENDED","UNKNOWN","UNSUPPORTED"],"default":"UNKNOWN"},"bluetoothLowEnergyCapable":{"type":"boolean","example":false},"bluetoothMacAddress":{"type":"string","example":"ee:00:7c:f0:e5:aa"},"capacityMb":{"type":"integer","example":27503},"lostModeEnabledDate":{"type":"string","format":"date-time","example":"2022-10-17T11:48:56.307Z"},"declarativeDeviceManagementEnabled":{"type":"boolean","example":false},"appleEnrollmentType":{"type":"string","description":"The enrollment type reported by Apple.","example":"supervised","enum":["none","supervised","device","user","unknown"]},"awaitingConfiguration":{"type":"boolean","description":"Whether the device is awaiting configuration.","example":false},"returnToServiceEnabled":{"type":"boolean","description":"Whether Return to Service is enabled.","example":false},"lockdownModeEnabled":{"type":"boolean","description":"Whether Lockdown Mode is enabled.","example":false},"deviceId":{"type":"string","example":"1"},"deviceLocatorServiceEnabled":{"type":"boolean","example":false},"deviceOwnershipType":{"type":"string","example":"institutional"},"devicePhoneNumber":{"type":"string","example":"555-555-5555"},"diagnosticAndUsageReportingEnabled":{"type":"boolean","example":false},"displayName":{"type":"string","example":"iPad"},"doNotDisturbEnabled":{"type":"boolean","example":false},"enrollmentSessionTokenValid":{"type":"boolean","example":false},"exchangeDeviceId":{"type":"string","example":"TH3YE2RI4D234IS2B6U6IGH95D"},"cloudBackupEnabled":{"type":"boolean","example":false},"osBuild":{"type":"string","example":"15F79"},"osSupplementalBuildVersion":{"type":"string","example":"22A103310o"},"osRapidSecurityResponse":{"type":"string","example":"(a)"},"osVersion":{"type":"string","example":"11.4"},"ipAddress":{"type":"string","example":"10.0.0.1"},"itunesStoreAccountActive":{"type":"boolean","example":false},"jamfParentPairings":{"type":"integer","example":1},"languages":{"type":"string","example":"Polish"},"lastBackupDate":{"type":"string","format":"date-time","example":"2022-10-17T11:48:56.307Z"},"lastContactDate":{"type":"string","format":"date-time","example":"2022-10-17T11:48:56.307Z"},"lastEnrolledDate":{"type":"string","format":"date-time","example":"2022-10-17T11:48:56.307Z"},"lastCloudBackupDate":{"type":"string","format":"date-time","example":"2022-10-17T11:48:56.307Z"},"lastInventoryUpdateDate":{"type":"string","format":"date-time","example":"2022-10-17T11:48:56.307Z"},"locales":{"type":"string","example":"null"},"locationServicesForSelfServiceMobileEnabled":{"type":"boolean","example":false},"lostModeEnabled":{"type":"boolean","example":false},"managed":{"type":"boolean","example":true},"managementId":{"type":"string","example":"73226fb6-61df-4c10-9552-eb9bc353d507"},"mdmProfileExpirationDate":{"type":"string","format":"date-time","example":"2022-10-17T11:48:56.307Z"},"model":{"type":"string","example":"iPad 7th Generation (Wi-Fi)"},"modelIdentifier":{"type":"string","example":"iPad7,11"},"modelNumber":{"type":"string","example":"MW742LL"},"modemFirmwareVersion":{"type":"string","example":"5.70.01"},"pairedDevices":{"type":"integer","example":1},"quotaSize":{"type":"integer","example":1024},"residentUsers":{"type":"integer","example":0},"serialNumber":{"type":"string","example":"5c28fdae"},"sharedIpad":{"type":"boolean","example":false},"supervised":{"type":"boolean","example":true},"tethered":{"type":"boolean","example":false},"timeZone":{"type":"string","example":"Europe/Warsaw"},"usedSpacePercentage":{"type":"integer","example":3},"wifiMacAddress":{"type":"string","example":"C4:84:66:92:78:00"},"building":{"type":"string","example":"Eau Claire"},"department":{"type":"string","example":"Support"},"emailAddress":{"type":"string","example":"support@jamf.com"},"fullName":{"type":"string","example":"John Smith"},"position":{"type":"string","example":"IT Team Lead"},"room":{"type":"string","example":"4th Floor - Quad 3"},"userPhoneNumber":{"type":"string","example":"555-555-5555"},"username":{"type":"string","example":"admin"},"appleCareId":{"type":"string","example":"9546567.0"},"leaseExpirationDate":{"type":"string","format":"date-time","example":"2022-10-17T11:48:56.307Z"},"lifeExpectancyYears":{"type":"integer","example":7},"poDate":{"type":"string","format":"date-time","example":"2022-10-17T11:48:56.307Z"},"poNumber":{"type":"string","example":"8675309"},"purchasePrice":{"type":"string","example":"$399"},"purchasedOrLeased":{"type":"boolean","example":true},"purchasingAccount":{"type":"string","example":"IT Budget"},"purchasingContact":{"type":"string","example":"Nick in IT"},"vendor":{"type":"string","example":"Apple"},"warrantyExpirationDate":{"type":"string","format":"date-time","example":"2022-10-17T11:48:56.307Z"},"activationLockEnabled":{"type":"boolean","example":true},"blockEncryptionCapable":{"type":"boolean","example":false},"dataProtection":{"type":"boolean","example":false},"fileEncryptionCapable":{"type":"boolean","example":false},"hardwareEncryptionSupported":{"type":"boolean","example":false},"jailbreakStatus":{"type":"string","example":"Compromised"},"passcodeCompliant":{"type":"boolean","example":true},"passcodeCompliantWithProfile":{"type":"boolean","example":true},"passcodeLockGracePeriodEnforcedSeconds":{"type":"integer","example":9819083},"passcodePresent":{"type":"boolean","example":true},"personalDeviceProfileCurrent":{"type":"boolean","description":"**Deprecated as of 11.25.** This field always returns false.\n","readOnly":true,"deprecated":true,"default":false},"carrierSettingsVersion":{"type":"string","example":"33.1"},"cellularTechnology":{"type":"string","example":"Both"},"currentCarrierNetwork":{"type":"string","example":"Verizon Wireless"},"currentMobileCountryCode":{"type":"string","example":"311"},"currentMobileNetworkCode":{"type":"string","example":"480"},"dataRoamingEnabled":{"type":"boolean","example":true},"eid":{"type":"string","example":"89049032007008882600085727376656"},"homeCarrierNetwork":{"type":"string","example":"Verizon"},"homeMobileCountryCode":{"type":"string","example":"US"},"homeMobileNetworkCode":{"type":"string","example":"480"},"iccid":{"type":"string","example":"8991101200003204514"},"imei":{"type":"string","example":"35 882334 083223 0"},"imei2":{"type":"string","example":"35 585308 072899 3"},"meid":{"type":"string","example":"35882334083223"},"personalHotspotEnabled":{"type":"boolean","example":false},"preferredVoiceNumber":{"type":"string","example":"555-555-5555"},"roaming":{"type":"boolean","example":false},"voiceRoamingEnabled":{"type":"string","example":"Enabled"},"selected":{"type":"boolean","description":"If true the device is a part of the current group","example":false},"lastLoggedInUsernameSelfService":{"type":"string","nullable":true,"example":"admin"},"lastLoggedInUsernameSelfServiceTimestamp":{"type":"string","format":"date-time","nullable":true,"example":"2018-10-31T18:04:13Z"},"lastLoggedInUsernameMdm":{"type":"string","nullable":true,"example":"admin"},"lastLoggedInUsernameMdmTimestamp":{"type":"string","format":"date-time","nullable":true,"example":"2018-10-31T18:04:13Z"},"extensionAttributeValueList":{"minLength":0,"type":"array","items":{"$ref":"#/components/schemas/ExtensionAttributeValue"}}}},"InventorySelectionListMobileDeviceSearchResults":{"type":"object","properties":{"totalCount":{"type":"integer","nullable":false,"example":1},"results":{"type":"array","items":{"$ref":"#/components/schemas/InventorySelectionListMobileDevice"}}}},"IosBrandingConfiguration":{"required":["brandingName","brandingNameColorCode","headerBackgroundColorCode","menuIconColorCode","statusBarTextColor"],"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"1"},"brandingName":{"type":"string","example":"Self Service"},"iconId":{"type":"integer","example":1},"headerBackgroundColorCode":{"type":"string","example":"FFFFFF"},"menuIconColorCode":{"type":"string","example":"000001"},"brandingNameColorCode":{"type":"string","example":"000000"},"statusBarTextColor":{"type":"string","example":"dark"}}},"IosBrandingSearchResults":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":1},"results":{"type":"array","items":{"$ref":"#/components/schemas/IosBrandingConfiguration"}}}},"JamfApplicationResponse":{"type":"object","properties":{"displayName":{"type":"string","example":"Jamf Connect"},"releaseHistoryUrl":{"type":"string","example":"https://docs.jamf.com/jamf-connect/administrator-guide/Release_History.html"},"artifacts":{"type":"array","items":{"$ref":"#/components/schemas/JamfPackageResponse"}}}},"JamfPackageResponse":{"type":"object","properties":{"id":{"type":"string","example":"B84F9904-868B-4862-A8F5-33706AADED71"},"filename":{"type":"string","example":"JamfProtect-1.2.2.pkg"},"version":{"type":"string","example":"1.2.2"},"created":{"type":"string","example":"1970-01-01T00:00:00Z"},"url":{"type":"string","example":"https://example.jamf.com/path/to/JamfProtect-1.2.2.pkg"}}},"JamfProInformationV2":{"type":"object","properties":{"vppTokenEnabled":{"type":"boolean","example":false},"depAccountEnabled":{"type":"boolean","example":false},"byodEnabled":{"type":"boolean","description":"**Deprecated as of 11.25.** This field always returns false.\n","readOnly":true,"deprecated":true,"default":false},"userMigrationEnabled":{"type":"boolean","example":false},"cloudDeploymentsEnabled":{"type":"boolean","example":false},"patchEnabled":{"type":"boolean","example":false},"ssoSamlEnabled":{"type":"boolean","example":false},"smtpEnabled":{"type":"boolean","example":false}}},"JamfProServerUrl":{"required":["url"],"type":"object","properties":{"url":{"type":"string","example":"https://example.com:8443"}}},"JamfProVersion":{"type":"object","properties":{"version":{"type":"string","example":"10.9.0"}}},"JamfProtectPlan":{"type":"object","properties":{"uuid":{"type":"string","nullable":false,"readOnly":true,"example":"b999dfd3-8fde-4bf2-aa56-b167c8b68071"},"id":{"type":"string","readOnly":true,"example":"d265dfd3-8fde-4bf2-aa56-b167c8b68069"},"name":{"type":"string","readOnly":true,"example":"Main Plan"},"description":{"type":"string","readOnly":true,"example":"Plan for the majority of the company's computers"},"profileId":{"type":"integer","readOnly":true,"example":12},"profileName":{"type":"string","readOnly":true,"example":"Main Plan (Jamf Protect)"},"profileVersion":{"type":"integer","readOnly":true,"example":1},"scopeDescription":{"type":"string","readOnly":true,"example":"All Computers"},"siteId":{"type":"string","readOnly":true,"example":"-1"}}},"LanguageCode":{"type":"object","properties":{"value":{"type":"string","example":"en"},"name":{"type":"string","example":"English"}}},"LapsAccountManagementHistory":{"type":"object","properties":{"username":{"type":"string","nullable":false,"example":"username"},"eventType":{"type":"string","example":"VIEWED","enum":["PENDING","COMPLETED","VIEWED","ERROR","INVALID"]},"eventTime":{"type":"string","format":"date-time","nullable":true,"example":"2019-05-16T20:43:43.945Z"},"viewedBy":{"type":"string","nullable":true,"example":"admin"},"userSource":{"type":"string","nullable":false,"example":"MDM","enum":["MDM","JMF"]}}},"LapsAccountManagementHistoryResponse":{"type":"object","properties":{"totalCount":{"type":"integer","example":1},"results":{"minLength":0,"type":"array","items":{"$ref":"#/components/schemas/LapsAccountManagementHistory"}}}},"LapsAuditV2":{"type":"object","properties":{"viewedBy":{"type":"string","nullable":true,"example":"admin"},"dateSeen":{"type":"string","format":"date-time","nullable":true,"example":"2019-05-16T20:43:43.945Z"}}},"LapsHistory":{"type":"object","properties":{"createdDate":{"type":"string","format":"date-time","nullable":true,"example":"2019-05-16T20:43:43.945Z"},"dateLastSeen":{"type":"string","format":"date-time","nullable":true,"example":"2019-05-16T20:43:43.945Z"},"expirationTime":{"type":"string","format":"date-time","nullable":true,"example":"2019-05-16T20:43:43.945Z"},"rotationStatus":{"type":"string","example":"PENDING","enum":["PENDING","COMPLETED","VIEWED","ERROR","INVALID"]}}},"LapsHistoryResponse":{"type":"object","properties":{"totalCount":{"type":"integer","example":1},"results":{"minLength":0,"type":"array","items":{"$ref":"#/components/schemas/LapsHistory"}}}},"LapsPasswordAndAuditsV2":{"type":"object","properties":{"password":{"type":"string","format":"password","nullable":false,"readOnly":true,"example":"jamf12345"},"dateLastSeen":{"type":"string","format":"date-time","nullable":true,"example":"2019-05-16T20:43:43.945Z"},"expirationTime":{"type":"string","format":"date-time","nullable":true,"example":"2019-05-16T20:43:43.945Z"},"audits":{"minLength":0,"type":"array","items":{"$ref":"#/components/schemas/LapsAuditV2"}}}},"LapsPasswordAuditsResultsV2":{"type":"object","properties":{"totalCount":{"type":"integer","example":1},"results":{"minLength":0,"type":"array","items":{"$ref":"#/components/schemas/LapsPasswordAndAuditsV2"}}}},"LapsPasswordResponseV2":{"type":"object","properties":{"password":{"type":"string","format":"password","nullable":false,"readOnly":true,"example":"jamf12345"}}},"LapsPendingRotation":{"type":"object","properties":{"lapsUser":{"$ref":"#/components/schemas/LapsUserV2"},"createdDate":{"type":"string","format":"date-time","nullable":false,"example":"2019-05-16T20:43:43.945Z"}}},"LapsPendingRotationResponse":{"type":"object","properties":{"totalCount":{"type":"integer","example":1},"results":{"minLength":0,"type":"array","items":{"$ref":"#/components/schemas/LapsPendingRotation"}}}},"LapsSettingsRequestV2":{"required":["autoDeployEnabled","autoRotateEnabled","autoRotateExpirationTime","passwordRotationTime"],"type":"object","properties":{"autoDeployEnabled":{"type":"boolean","description":"When enabled, all appropriate computers will have the SetAutoAdminPassword command sent to them automatically.","nullable":false,"example":false},"passwordRotationTime":{"type":"integer","description":"The amount of time in seconds that the local admin password will be rotated after viewing.","example":3600},"autoRotateEnabled":{"type":"boolean","description":"When enabled, all appropriate computers will automatically have their password expired and rotated after the configured autoRotateExpirationTime","nullable":false,"example":false},"autoRotateExpirationTime":{"type":"integer","description":"The amount of time in seconds that the local admin password will be rotated automatically if it is never viewed.","example":7776000}}},"LapsSettingsResponseV2":{"type":"object","properties":{"autoDeployEnabled":{"type":"boolean","description":"When enabled, all appropriate computers will have the SetAutoAdminPassword command sent to them automatically.","nullable":false,"example":false},"passwordRotationTime":{"type":"integer","description":"The amount of time in seconds that the local admin password will be rotated after viewing.","example":3600},"autoRotateEnabled":{"type":"boolean","description":"When enabled, all appropriate computers will automatically have their password expired and rotated after the configured autoRotateExpirationTime","nullable":false,"example":false},"autoRotateExpirationTime":{"type":"integer","description":"The amount of time in seconds that the local admin password will be rotated automatically if it is never viewed.","example":7776000}}},"LapsUserPasswordRequestV2":{"type":"object","properties":{"lapsUserPasswordList":{"minLength":1,"type":"array","items":{"$ref":"#/components/schemas/LapsUserPasswordV2"}}}},"LapsUserPasswordResponseV2":{"type":"object","properties":{"lapsUserPasswordList":{"type":"array","nullable":false,"items":{"$ref":"#/components/schemas/LapsUserPasswordV2"}}}},"LapsUserPasswordV2":{"type":"object","properties":{"username":{"type":"string","nullable":false,"example":"username"},"password":{"type":"string","format":"password","nullable":false,"writeOnly":true,"example":"jamf1234"}}},"LapsUserResultsV2":{"type":"object","properties":{"totalCount":{"type":"integer","example":1},"results":{"minLength":0,"type":"array","items":{"$ref":"#/components/schemas/LapsUserV2"}}}},"LapsUserV2":{"type":"object","properties":{"clientManagementId":{"type":"string","example":"2db90ebf-ce9c-4078-b508-034c8ee3a060"},"guid":{"type":"string","nullable":false,"example":"602F96A6-7BC4-43CD-95F2-1DD3B8BC0AF3"},"username":{"type":"string","nullable":false,"example":"admin"},"userSource":{"type":"string","nullable":false,"example":"MDM","enum":["MDM","JMF"]}}},"LastLoginResponse":{"required":["lastLogin"],"type":"object","properties":{"lastLogin":{"type":"string","description":"Timestamp of the last login (ISO 8601 format)","format":"date-time","example":"2021-12-31T22:00:00Z"}}},"LdapConfigurationRequest":{"required":["cloudIdPCommon","server"],"type":"object","properties":{"cloudIdPCommon":{"$ref":"#/components/schemas/CloudIdPCommonRequest"},"server":{"$ref":"#/components/schemas/CloudLdapServerRequest"},"mappings":{"$ref":"#/components/schemas/CloudLdapMappingsRequest"}},"description":"A Cloud Identity Provider LDAP configuration for requests"},"LdapConfigurationResponse":{"required":["cloudIdPCommon","server"],"type":"object","properties":{"cloudIdPCommon":{"$ref":"#/components/schemas/CloudIdPCommon"},"server":{"$ref":"#/components/schemas/CloudLdapServerResponse"},"mappings":{"$ref":"#/components/schemas/CloudLdapMappingsResponse"}},"description":"A Cloud Identity Provider LDAP configuration for responses"},"LdapConfigurationUpdate":{"required":["cloudIdPCommon","server"],"type":"object","properties":{"cloudIdPCommon":{"$ref":"#/components/schemas/CloudIdPCommon"},"server":{"$ref":"#/components/schemas/CloudLdapServerUpdate"},"mappings":{"$ref":"#/components/schemas/CloudLdapMappingsRequest"}},"description":"A Cloud Identity Provider LDAP configuration for updates"},"LdapGroup":{"type":"object","properties":{"id":{"type":"string","example":"1"},"uuid":{"type":"string","example":"89AF33FC-123C-1231-AEFD-9C3ED123AFCC"},"ldapServerId":{"type":"integer","example":1},"name":{"type":"string","example":"Grade School Teachers"},"distinguishedName":{"type":"string","example":"Grade School Teachers"}},"description":"An LDAP group."},"LdapGroupSearchResults":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":3},"results":{"type":"array","items":{"$ref":"#/components/schemas/LdapGroup"}}}},"LdapServer":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Server name"}},"description":"An LDAP Server."},"LinkedConnectProfile":{"type":"object","properties":{"uuid":{"type":"string","readOnly":true,"example":"d265dfd3-8fde-4bf2-aa56-b167c8b68069"},"profileId":{"type":"string","readOnly":true,"example":"d265dfd3-8fde-4bf2-aa56-b167c8b68069"},"profileName":{"type":"string","readOnly":true,"example":"Best Plans of Mice"},"profileScopeDescription":{"type":"string","readOnly":true,"example":"Plan for all of the mouse computers at our org"},"version":{"type":"string","description":"Must be a valid Jamf Connect version 2.3.0 or higher. Versions are listed here `https://www.jamf.com/resources/product-documentation/jamf-connect-administrators-guide/`","example":"2.3.0"},"autoDeploymentType":{"type":"string","description":"Determines how the server will behave regarding application updates and installs on the devices that have the configuration profile installed. * `PATCH_UPDATES` - Server handles initial installation of the application and any patch updates. * `MINOR_AND_PATCH_UPDATES` - Server handles initial installation of the application and any patch and minor updates. * `INITIAL_INSTALLATION_ONLY` - Server only handles initial installation of the application. Updates will have to be done manually. * `NONE` - Server does not handle any installations or updates for the application. Version is ignored for this type.\n","enum":["PATCH_UPDATES","MINOR_AND_PATCH_UPDATES","INITIAL_INSTALLATION_ONLY","NONE"],"default":"NONE"}}},"LinkedConnectProfileSearchResults":{"type":"object","properties":{"totalCount":{"type":"integer","example":13},"results":{"type":"array","items":{"$ref":"#/components/schemas/LinkedConnectProfile"}}}},"Locale":{"type":"object","properties":{"description":{"type":"string","example":"English (United States)"},"identifier":{"type":"string","example":"en_US"}}},"LocationInformationV2":{"required":["buildingId","departmentId","email","id","phone","position","realname","room","username","versionLock"],"type":"object","properties":{"username":{"type":"string","example":"name"},"realname":{"type":"string","example":"realName"},"phone":{"type":"string","example":"123-456-7890"},"email":{"type":"string","example":"test@jamf.com"},"room":{"type":"string","example":"room"},"position":{"type":"string","example":"postion"},"departmentId":{"type":"string","example":"1"},"buildingId":{"type":"string","example":"1"},"id":{"type":"string","example":"-1"},"versionLock":{"type":"integer","example":1}}},"LocationInformationV3":{"required":["buildingId","departmentId","email","id","phone","position","realname","room","username","versionLock"],"type":"object","properties":{"username":{"type":"string","example":"name"},"realname":{"type":"string","example":"realName"},"phone":{"type":"string","example":"123-456-7890"},"email":{"type":"string","example":"test@jamf.com"},"room":{"type":"string","example":"room"},"position":{"type":"string","example":"postion"},"departmentId":{"type":"string","example":"1"},"buildingId":{"type":"string","example":"1"},"id":{"type":"string","example":"-1"},"versionLock":{"type":"integer","example":1}}},"LocationV2":{"type":"object","properties":{"username":{"type":"string","example":"admin"},"realName":{"type":"string","example":"IT Bob"},"emailAddress":{"type":"string","example":"ITBob@jamf.com"},"position":{"type":"string","example":"IT Team Lead"},"phoneNumber":{"type":"string","example":"555-555-5555"},"departmentId":{"type":"string","example":"1"},"buildingId":{"type":"string","example":"1"},"room":{"type":"string","example":"4th Floor - Quad 3"}}},"LogFlushingTaskV1":{"required":["qualifier","retentionPeriod","retentionPeriodUnit"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the log flushing task","readOnly":true,"example":"8c47858a-0029-450b-8720-cf5ae4bc27c7"},"qualifier":{"type":"string","description":"The qualifier of the retention policy","example":"policy"},"retentionPeriod":{"type":"integer","description":"The period beyond which data will be flushed","example":3},"retentionPeriodUnit":{"type":"string","description":"The unit of the retention period (eg: DAY, WEEK, MONTH, YEAR)","example":"MONTH"},"state":{"type":"string","description":"The state of the task (eg: RUNNING, SUCCESS, FAILED, CANCELLED)","readOnly":true,"example":"SUCCESS"}}},"LogFlushingV1":{"type":"object","properties":{"retentionPolicies":{"type":"array","items":{"$ref":"#/components/schemas/RetentionPolicyV1"}},"hourOfDay":{"maximum":23,"minimum":0,"type":"integer","default":0}}},"LogOutUserCommand":{"allOf":[{"$ref":"#/components/schemas/MdmCommandBase"},{"type":"object"}]},"LoginContent":{"required":["includeCustomDisclaimer"],"type":"object","properties":{"rampInstance":{"type":"boolean","nullable":false,"example":false},"fedRampInstance":{"type":"boolean","nullable":false,"example":false},"highComplianceInstance":{"type":"boolean","nullable":false,"example":false},"includeCustomDisclaimer":{"type":"boolean","nullable":false,"example":true},"disclaimerHeading":{"type":"string","nullable":false,"example":"Disclaimer header"},"disclaimerMainText":{"type":"string","nullable":false,"example":"Login disclaimer main text"},"actionText":{"type":"string","nullable":false,"example":"Accept"}}},"LoginContentPut":{"required":["includeCustomDisclaimer"],"type":"object","properties":{"includeCustomDisclaimer":{"type":"boolean","nullable":false,"example":true},"disclaimerHeading":{"type":"string","nullable":false,"example":"Disclaimer header"},"disclaimerMainText":{"type":"string","nullable":false,"example":"Login disclaimer main text"},"actionText":{"type":"string","nullable":false,"example":"Accept"}}},"M2mTenantIdInfo":{"type":"object","properties":{"tenantId":{"type":"string","description":"The M2M-sourced tenant ID","nullable":true,"readOnly":true,"example":"a1b2c3d4-e5f6-7a8b-9c0d-e1f2a3b4c5d6"}}},"MacOsBrandingConfiguration":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"1"},"applicationName":{"type":"string","example":"Self Service"},"brandingName":{"type":"string","example":"Self Service"},"brandingNameSecondary":{"type":"string","example":"Self Service"},"iconId":{"type":"integer","example":1},"brandingHeaderImageId":{"type":"integer","example":1},"homeHeading":{"type":"string","example":"Welcome to Self Service"},"homeSubheading":{"type":"string","example":"We help organizations succeed with Apple"}}},"MacOsBrandingSearchResults":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":1},"results":{"type":"array","items":{"$ref":"#/components/schemas/MacOsBrandingConfiguration"}}}},"MacOsManagedSoftwareUpdate":{"type":"object","properties":{"deviceIds":{"type":"array","example":["1","2","3","4"],"items":{"type":"string"}},"groupId":{"type":"string","example":"1"},"maxDeferrals":{"minimum":0,"type":"integer","description":"Allow users to defer the update the provided number of times before macOS forces the update. If a value is provided, the Software Update will use the InstallLater install action.","example":7},"version":{"type":"string","description":"If no value is provided, the version will default to latest version based on device eligibility.","example":"12.0.1"},"skipVersionVerification":{"type":"boolean","description":"If no value is provided, the skipVersionVerification will default to false. If a value is provided, the specified version will be forced to complete DownloadAndInstall install action.","example":false,"default":false},"applyMajorUpdate":{"type":"boolean","description":"ApplyMajorUpdate setting is available only when updating to the latest version based on device eligibility. If no value is provided, the calculated latest version will only include minor version updates. If a value is provided, the calculated latest version will include minor and major version updates.","example":false,"default":false},"updateAction":{"type":"string","description":"MaxDeferral is ignored if using the DownloadOnly install action.","example":"DOWNLOAD_AND_INSTALL","enum":["DOWNLOAD_AND_INSTALL","DOWNLOAD_ONLY"]},"forceRestart":{"type":"boolean","description":"If not set, forceRestart will default to false. Can only be true if using the DownloadAndInstall install action and the devices the command is sent to are on macOs 11 or higher. If true, the DownloadAndInstall action is performed, a restart will be forced. MaxDeferral will be ignored if defined. ","example":false,"default":false},"priority":{"type":"string","description":"Priority can only be configured on macOS 12.3 and above, for minor updates only. Any version below 12.3 is always Low and cannot be changed until prerequisites are met. When qualified, if not explicitly set, priority will default to High","example":"HIGH","enum":["HIGH","LOW"],"default":"HIGH"}}},"MacOsManagedSoftwareUpdateResponse":{"type":"object","properties":{"processManagerUuids":{"type":"array","example":["6E47EF55-5318-494F-A09E-70F613E0AFD1","6E73EF55-5318-494F-A09E-70G613E0AFD1"],"items":{"type":"string"}},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiErrorCause"}}}},"ManagedApplicationListCommand":{"allOf":[{"$ref":"#/components/schemas/MdmCommandBase"},{"type":"object","properties":{"identifiers":{"minItems":0,"type":"array","description":"Array of application identifiers to manage","nullable":true,"example":["com.example.app1","com.example.app2","com.example.app3"],"items":{"minLength":1,"type":"string","nullable":false}}}}]},"ManagedMediaListCommand":{"allOf":[{"$ref":"#/components/schemas/MdmCommandBase"},{"type":"object"}]},"ManagedSoftwareUpdatePlan":{"required":["device","maxDeferrals","planUuid","status","updateAction","versionType"],"type":"object","properties":{"planUuid":{"minLength":1,"type":"string","readOnly":true,"example":"6E47EF55-5318-494F-A09E-70F613E0AFD1"},"device":{"$ref":"#/components/schemas/PlanDevice"},"updateAction":{"type":"string","nullable":false,"readOnly":true,"example":"DOWNLOAD_INSTALL","enum":["DOWNLOAD_ONLY","DOWNLOAD_INSTALL","DOWNLOAD_INSTALL_ALLOW_DEFERRAL","DOWNLOAD_INSTALL_RESTART","DOWNLOAD_INSTALL_SCHEDULE","UNKNOWN"]},"versionType":{"type":"string","nullable":false,"readOnly":true,"example":"SPECIFIC_VERSION","enum":["LATEST_MAJOR","LATEST_MINOR","LATEST_ANY","SPECIFIC_VERSION","CUSTOM_VERSION","UNKNOWN"]},"specificVersion":{"type":"string","description":"Optional. Indicates the specific version to update to. Only available when the version type is set to specific version or custom version, otherwise defaults to NO_SPECIFIC_VERSION.","readOnly":true,"example":"12.6.1","default":"NO_SPECIFIC_VERSION"},"buildVersion":{"type":"string","description":"Optional. Indicates the build version to update to. Only available when the version type is set to custom version.","nullable":true,"readOnly":true,"example":"21F79"},"maxDeferrals":{"minimum":0,"type":"integer","description":"Not applicable to all managed software update plans","readOnly":true,"example":5},"forceInstallLocalDateTime":{"type":"string","description":"Optional. Indicates the local date and time of the device to force update by.","nullable":true,"example":"2023-12-25T21:09:31"},"recipeId":{"type":"string","description":"The id of the recipe that was used to generate the plan.","readOnly":true,"example":"1","default":"-1"},"status":{"$ref":"#/components/schemas/PlanStatus"}}},"ManagedSoftwareUpdatePlanEventStore":{"type":"object","properties":{"events":{"type":"string","nullable":false,"readOnly":true,"default":""}}},"ManagedSoftwareUpdatePlanGroupPost":{"required":["config","group"],"type":"object","properties":{"group":{"$ref":"#/components/schemas/PlanGroupPost"},"config":{"$ref":"#/components/schemas/PlanConfigurationPost"}}},"ManagedSoftwareUpdatePlanPost":{"required":["config","devices"],"type":"object","properties":{"devices":{"minItems":1,"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/PlanDevicePost"}},"config":{"$ref":"#/components/schemas/PlanConfigurationPost"}}},"ManagedSoftwareUpdatePlanPostResponse":{"type":"object","properties":{"plans":{"minItems":0,"uniqueItems":true,"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/PlanDeviceResponse"}}}},"ManagedSoftwareUpdatePlanToggle":{"required":["toggle"],"type":"object","properties":{"toggle":{"type":"boolean","nullable":false,"example":false},"forceInstallLocalDateEnabled":{"type":"boolean","nullable":false,"readOnly":true,"example":false},"customVersionEnabled":{"type":"boolean","nullable":false,"readOnly":true,"example":false},"dssEnabled":{"type":"boolean","nullable":false,"readOnly":true,"example":false},"recipeEnabled":{"type":"boolean","nullable":false,"readOnly":true,"example":false}},"nullable":false},"ManagedSoftwareUpdatePlanToggleStatus":{"type":"object","properties":{"startTime":{"type":"string","description":"The local server time when the toggle was initiated. Null if state is NEVER_RAN","nullable":true,"example":"2023-12-25T21:09:31"},"endTime":{"type":"string","description":"The local server time when the toggle was completed. Null if state is NEVER_RAN","nullable":true,"example":"2023-12-25T21:09:31"},"elapsedTime":{"type":"integer","description":"Duration in seconds between the start time and end time. \"Now\" is used when end time is null. Null if state is NEVER_RAN","nullable":true,"example":17},"state":{"type":"string","description":"The current state of the toggle","example":"NOT_RUNNING","enum":["NOT_RUNNING","RUNNING","NEVER_RAN"]},"totalRecords":{"type":"integer","description":"The total number of records that will be deleted","format":"int64","example":1000},"processedRecords":{"type":"integer","description":"The total number of records that have been deleted","format":"int64","example":500},"percentComplete":{"type":"number","description":"The percentage between total and completed records.","format":"double","example":61.2},"formattedPercentComplete":{"type":"string","description":"Pretty print of total, processed, and percentage complete","example":"100 / 500 -> 20% Complete"},"exitState":{"type":"string","description":"Troubleshooting - The exit status code from the toggle processing job. \"Unknown\" will return when the toggle is running.","example":"UNKNOWN","enum":["UNKNOWN","EXECUTING","COMPLETED","NOOP","FAILED","STOPPED"]},"exitMessage":{"type":"string","description":"Troubleshooting - The exit message of the toggle job if it encounters an exception while running. Nominal return is an empty string","example":"Error"}},"nullable":false},"ManagedSoftwareUpdatePlanToggleStatusWrapper":{"required":["toggleOff","toggleOn"],"type":"object","properties":{"toggleOn":{"$ref":"#/components/schemas/ManagedSoftwareUpdatePlanToggleStatus"},"toggleOff":{"$ref":"#/components/schemas/ManagedSoftwareUpdatePlanToggleStatus"}},"nullable":false},"ManagedSoftwareUpdatePlans":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":1},"results":{"minItems":0,"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/ManagedSoftwareUpdatePlan"}}}},"ManagedSoftwareUpdateStatus":{"type":"object","properties":{"osUpdatesStatusId":{"type":"string","example":"1"},"device":{"type":"object","properties":{"deviceId":{"type":"string"},"objectType":{"type":"string","enum":["COMPUTER","MOBILE_DEVICE","APPLE_TV"]},"href":{"type":"string"}}},"downloadPercentComplete":{"type":"number","example":0.8},"downloaded":{"type":"boolean","example":false},"productKey":{"type":"string","example":"iOSUpdate19F77"},"status":{"type":"string","example":"DOWNLOADING","enum":["DOWNLOADING","IDLE","INSTALLING","INSTALLED","ERROR","DOWNLOAD_FAILED","DOWNLOAD_REQUIRES_COMPUTER","DOWNLOAD_INSUFFICIENT_SPACE","DOWNLOAD_INSUFFICIENT_POWER","DOWNLOAD_INSUFFICIENT_NETWORK","INSTALL_INSUFFICIENT_SPACE","INSTALL_INSUFFICIENT_POWER","INSTALL_PHONE_CALL_IN_PROGRESS","INSTALL_FAILED","UNKNOWN"]},"deferralsRemaining":{"type":"integer","description":"not applicable to all managed software update statuses","example":4},"maxDeferrals":{"type":"integer","description":"not applicable to all managed software update statuses","example":5},"nextScheduledInstall":{"type":"string","description":"not applicable to all managed software update statuses","format":"date-time","example":"2022-12-25T21:09:31.661Z"},"pastNotifications":{"type":"array","description":"not applicable to all managed software update statuses","example":["2022-12-22T21:09:31.661Z","2022-12-23T21:09:31.661Z","2022-12-24T21:09:31.661Z"],"items":{"type":"string","format":"date-time"}},"created":{"type":"string","format":"date-time","example":"2022-12-22T21:09:00.661Z"},"updated":{"type":"string","format":"date-time","example":"2022-12-24T21:09:31.661Z"}}},"ManagedSoftwareUpdateStatuses":{"type":"object","properties":{"totalCount":{"type":"integer","example":1},"results":{"type":"array","items":{"$ref":"#/components/schemas/ManagedSoftwareUpdateStatus"}}}},"Markdown":{"type":"object","properties":{"markdown":{"type":"string","example":"**markdown**"}}},"MdmClientType":{"type":"string","example":"MOBILE_DEVICE","enum":["MOBILE_DEVICE","TV","VISION_PRO","WATCH","COMPUTER","COMPUTER_USER","MOBILE_DEVICE_USER","UNKNOWN"]},"MdmCommand":{"type":"object","properties":{"uuid":{"type":"string","example":"aaaaaaaa-3f1e-4b3a-a5b3-ca0cd7430937"},"dateSent":{"type":"string","format":"date-time","example":"2019-05-16T20:43:43.945Z"},"dateCompleted":{"type":"string","format":"date-time","example":"2019-05-16T20:43:43.945Z"},"client":{"$ref":"#/components/schemas/MdmCommandClient"},"commandState":{"$ref":"#/components/schemas/MdmCommandState"},"commandType":{"$ref":"#/components/schemas/MdmCommandType"},"commandError":{"$ref":"#/components/schemas/MdmCommandError"},"profileId":{"type":"integer","example":1}}},"MdmCommandBase":{"required":["commandType"],"type":"object","properties":{"commandType":{"$ref":"#/components/schemas/MdmCommandType"}}},"MdmCommandClient":{"type":"object","properties":{"managementId":{"type":"string","example":"aaaaaaaa-3f1e-4b3a-a5b3-ca0cd7430937"},"clientType":{"$ref":"#/components/schemas/MdmClientType"}}},"MdmCommandClientRequest":{"type":"object","properties":{"managementId":{"type":"string","example":"aaaaaaaa-3f1e-4b3a-a5b3-ca0cd7430937"}}},"MdmCommandError":{"type":"object","properties":{"errorCode":{"type":"integer","example":1234},"errorDomain":{"type":"string","example":"An error occurred while processing the command."},"errorLocalizedDescription":{"type":"string","example":"An error occurred while processing the command."},"errorEnglishDescription":{"type":"string","example":"An error occurred while processing the command."}}},"MdmCommandRequest":{"type":"object","properties":{"clientData":{"type":"array","items":{"$ref":"#/components/schemas/MdmCommandClientRequest"}},"commandData":{"example":{"commandType":"ENABLE_LOST_MODE","lostModeMessage":"Lost Mode Message","lostModePhone":"123-456-7890","lostModeFootnote":"This is a footnote"},"discriminator":{"propertyName":"commandType","mapping":{"APPLY_REDEMPTION_CODE":"#/components/schemas/ApplyRedemptionCodeCommand","CANCEL_ENHANCED_LOG_COLLECTION":"#/components/schemas/CancelEnhancedLogCollectionCommand","CERTIFICATE_LIST":"#/components/schemas/CertificateListCommand","CLEAR_PASSCODE":"#/components/schemas/ClearPasscodeCommand","CLEAR_RESTRICTIONS_PASSWORD":"#/components/schemas/ClearRestrictionsPasswordCommand","DECLARATIVE_MANAGEMENT":"#/components/schemas/DeclarativeManagementCommand","DELETE_USER":"#/components/schemas/DeleteUserCommand","DEVICE_INFORMATION":"#/components/schemas/DeviceInformationCommand","DEVICE_LOCATION":"#/components/schemas/DeviceLocationCommand","DEVICE_LOCK":"#/components/schemas/DeviceLockCommand","DISABLE_LOST_MODE":"#/components/schemas/DisableLostModeCommand","DISABLE_REMOTE_DESKTOP":"#/components/schemas/DisableRemoteDesktopCommand","ENABLE_LOST_MODE":"#/components/schemas/EnableLostModeCommand","ENABLE_REMOTE_DESKTOP":"#/components/schemas/EnableRemoteDesktopCommand","ERASE_DEVICE":"#/components/schemas/EraseDeviceCommand","INSTALLED_APPLICATION_LIST":"#/components/schemas/InstalledApplicationListCommand","LOG_OUT_USER":"#/components/schemas/LogOutUserCommand","MANAGED_APPLICATION_LIST":"#/components/schemas/ManagedApplicationListCommand","MANAGED_MEDIA_LIST":"#/components/schemas/ManagedMediaListCommand","PLAY_LOST_MODE_SOUND":"#/components/schemas/PlayLostModeSoundCommand","PROFILE_LIST":"#/components/schemas/ProfileListCommand","PROVISIONING_PROFILE_LIST":"#/components/schemas/ProvisioningProfileListCommand","REFRESH_CELLULAR_PLANS":"#/components/schemas/RefreshCellularPlansCommand","RESTART_DEVICE":"#/components/schemas/RestartDeviceCommand","REQUEST_MIRRORING":"#/components/schemas/RequestMirroringCommand","SECURITY_INFO":"#/components/schemas/SecurityInfoCommand","SETTINGS":"#/components/schemas/SettingsCommand","SET_AUTO_ADMIN_PASSWORD":"#/components/schemas/SetAutoAdminPasswordCommand","SET_RECOVERY_LOCK":"#/components/schemas/SetRecoveryLockCommand","SHUT_DOWN_DEVICE":"#/components/schemas/ShutDownDeviceCommand","STOP_MIRRORING":"#/components/schemas/StopMirroringCommand","TRIGGER_ENHANCED_LOG_COLLECTION":"#/components/schemas/TriggerEnhancedLogCollectionCommand","UNLOCK_USER_ACCOUNT":"#/components/schemas/UnlockUserAccountCommand","VALIDATE_APPLICATIONS":"#/components/schemas/ValidateApplicationsCommand","VERIFY_RECOVERY_LOCK":"#/components/schemas/VerifyRecoveryLockCommand"}},"oneOf":[{"$ref":"#/components/schemas/ApplyRedemptionCodeCommand"},{"$ref":"#/components/schemas/CancelEnhancedLogCollectionCommand"},{"$ref":"#/components/schemas/CertificateListCommand"},{"$ref":"#/components/schemas/ClearPasscodeCommand"},{"$ref":"#/components/schemas/DeclarativeManagementCommand"},{"$ref":"#/components/schemas/DeviceInformationCommand"},{"$ref":"#/components/schemas/DeviceLocationCommand"},{"$ref":"#/components/schemas/DeviceLockCommand"},{"$ref":"#/components/schemas/DisableLostModeCommand"},{"$ref":"#/components/schemas/DisableRemoteDesktopCommand"},{"$ref":"#/components/schemas/EnableRemoteDesktopCommand"},{"$ref":"#/components/schemas/EraseDeviceCommand"},{"$ref":"#/components/schemas/ManagedApplicationListCommand"},{"$ref":"#/components/schemas/InstalledApplicationListCommand"},{"$ref":"#/components/schemas/ClearRestrictionsPasswordCommand"},{"$ref":"#/components/schemas/DeleteUserCommand"},{"$ref":"#/components/schemas/EnableLostModeCommand"},{"$ref":"#/components/schemas/LogOutUserCommand"},{"$ref":"#/components/schemas/ManagedMediaListCommand"},{"$ref":"#/components/schemas/PlayLostModeSoundCommand"},{"$ref":"#/components/schemas/ProfileListCommand"},{"$ref":"#/components/schemas/ProvisioningProfileListCommand"},{"$ref":"#/components/schemas/RefreshCellularPlansCommand"},{"$ref":"#/components/schemas/RestartDeviceCommand"},{"$ref":"#/components/schemas/RequestMirroringCommand"},{"$ref":"#/components/schemas/SecurityInfoCommand"},{"$ref":"#/components/schemas/SetAutoAdminPasswordCommand"},{"$ref":"#/components/schemas/SetRecoveryLockCommand"},{"$ref":"#/components/schemas/SettingsCommand"},{"$ref":"#/components/schemas/ShutDownDeviceCommand"},{"$ref":"#/components/schemas/StopMirroringCommand"},{"$ref":"#/components/schemas/TriggerEnhancedLogCollectionCommand"},{"$ref":"#/components/schemas/UnlockUserAccountCommand"},{"$ref":"#/components/schemas/ValidateApplicationsCommand"},{"$ref":"#/components/schemas/VerifyRecoveryLockCommand"}]}}},"MdmCommandResults":{"type":"object","properties":{"totalCount":{"type":"integer","example":1},"results":{"type":"array","items":{"$ref":"#/components/schemas/MdmCommand"}}}},"MdmCommandState":{"type":"string","example":"PENDING","enum":["PENDING","ACKNOWLEDGED","NOT_NOW","ERROR","COMMAND_FORMAT_ERROR"]},"MdmCommandType":{"type":"string","example":"ENABLE_LOST_MODE","enum":["APPLY_REDEMPTION_CODE","CANCEL_ENHANCED_LOG_COLLECTION","CERTIFICATE_LIST","CLEAR_PASSCODE","CLEAR_RESTRICTIONS_PASSWORD","DECLARATIVE_MANAGEMENT","DELETE_USER","DEVICE_INFORMATION","DEVICE_LOCATION","DEVICE_LOCK","DISABLE_LOST_MODE","DISABLE_REMOTE_DESKTOP","ENABLE_LOST_MODE","ENABLE_REMOTE_DESKTOP","ERASE_DEVICE","INSTALLED_APPLICATION_LIST","LOG_OUT_USER","MANAGED_APPLICATION_LIST","MANAGED_MEDIA_LIST","REFRESH_CELLULAR_PLANS","PLAY_LOST_MODE_SOUND","PROFILE_LIST","PROVISIONING_PROFILE_LIST","RESTART_DEVICE","REQUEST_MIRRORING","SECURITY_INFO","SETTINGS","SET_AUTO_ADMIN_PASSWORD","SET_RECOVERY_LOCK","SHUT_DOWN_DEVICE","STOP_MIRRORING","TRIGGER_ENHANCED_LOG_COLLECTION","UNLOCK_USER_ACCOUNT","VALIDATE_APPLICATIONS","VERIFY_RECOVERY_LOCK"]},"MdmRenewalError":{"required":["clientManagementId","mdmRenewalErrorId","mdmRenewalErrorType"],"type":"object","properties":{"mdmRenewalErrorId":{"type":"string","description":"Unique identifier for the MDM renewal error","example":"123"},"clientManagementId":{"type":"string","description":"The client management ID associated with this error","example":"550e8400-e29b-41d4-a716-446655440000"},"mdmRenewalErrorType":{"$ref":"#/components/schemas/MdmRenewalErrorType"},"errorTimeStamp":{"type":"string","description":"Timestamp when the error occurred (ISO 8601 format)","format":"date-time","example":"2021-12-31T22:00:00Z"},"failureCount":{"type":"integer","description":"Number of times this error has occurred","format":"int32","example":3}}},"MdmRenewalErrorStrategiesResponse":{"required":["error","strategies"],"type":"object","properties":{"error":{"$ref":"#/components/schemas/MdmRenewalError"},"strategies":{"type":"array","description":"List of renewal strategies associated with this error","items":{"$ref":"#/components/schemas/MdmRenewalStrategy"}}}},"MdmRenewalErrorType":{"type":"string","description":"Type of MDM renewal error","example":"SERVER_ERROR","enum":["SERVER_ERROR","CHECK_IN_ERROR","OTHER"]},"MdmRenewalStrategy":{"required":["id","mdmRenewalErrorId","mdmRenewalStrategyType"],"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the renewal strategy","example":"456"},"mdmRenewalErrorId":{"type":"string","description":"The MDM renewal error ID this strategy is associated with","example":"123"},"mdmRenewalStrategyType":{"$ref":"#/components/schemas/MdmRenewalStrategyType"},"strategyTimeStamp":{"type":"string","description":"Timestamp when this renewal strategy was created (ISO 8601 format)","format":"date-time","example":"2021-12-31T22:00:00Z"},"mdmRenewalCheckInUrl":{"type":"string","description":"URL for MDM renewal check-in","example":"https://example.jamfcloud.com/mdm/CheckInURL"},"mdmRenewalServerUrl":{"type":"string","description":"URL for MDM renewal server","example":"https://example.jamfcloud.com/mdm/ServerURL"}}},"MdmRenewalStrategyType":{"type":"string","description":"Type of MDM renewal strategy","example":"JSS_URL_OVERRIDE","enum":["RETURN_NO_CHECK_IN_INVITATION","RETURN_CHECK_IN_INVITATION_FROM_MDM_INVITATION_TABLE","RETURN_CHECK_IN_INVITATION_FROM_ENROLLMENT_USAGE_TABLE","RETURN_CHECK_IN_INVITATION_FROM_MDM_PROFILE_PROTOTYPE_TABLE","JSS_URL_OVERRIDE","PAYLOAD_IDENTIFIER"]},"MembershipMappings":{"required":["groupMembershipMapping"],"type":"object","properties":{"groupMembershipMapping":{"type":"string","example":"memberOf"}},"description":"Cloud Identity Provider user group membership mappings configuration"},"MembershipTestSearchRequest":{"required":["groupname","username"],"type":"object","properties":{"username":{"type":"string","example":"admin"},"groupname":{"type":"string","example":"users"}}},"MembershipTestSearchResponse":{"type":"object","properties":{"username":{"type":"string","example":"admin"},"isMember":{"type":"boolean","example":true},"isMemberByUuid":{"type":"boolean","example":true}}},"MemcachedEndpoints":{"type":"object","properties":{"id":{"minLength":1,"type":"string","readOnly":true,"example":"1"},"name":{"type":"string","example":"Jamf Fake Example Memcache"},"hostName":{"type":"string","example":"https://memcache.jamf.com"},"port":{"type":"integer","example":9001},"enabled":{"type":"boolean","example":true},"jssCacheConfigurationId":{"type":"integer","example":1}}},"MobileDeviceApplication":{"type":"object","properties":{"identifier":{"type":"string","example":"com.apple.airport.mobileairportutility"},"name":{"type":"string","example":"AirPort Utility"},"version":{"type":"string","example":"135.24"},"shortVersion":{"type":"string","example":"7.0"}}},"MobileDeviceApplicationInventoryDetail":{"type":"object","properties":{"identifier":{"type":"string","example":"com.apple.airport.mobileairportutility"},"name":{"type":"string","example":"AirPort Utility"},"version":{"type":"string","example":"135.24"},"shortVersion":{"type":"string","example":"7.0"},"managementStatus":{"type":"string","example":"Managed"},"validationStatus":{"type":"boolean","example":true},"bundleSize":{"type":"string","example":"1024"},"dynamicSize":{"type":"string","example":"1423"},"appClip":{"type":"boolean","example":false}}},"MobileDeviceAttachmentV2":{"type":"object","properties":{"name":{"type":"string","example":"Bob's Attachment"},"id":{"type":"string","readOnly":true,"example":"1"}}},"MobileDeviceCertificate":{"type":"object","properties":{"commonName":{"type":"string","example":"3B259E4B-FAD5-4860-B1DD-336ADA786EBA"},"identity":{"type":"boolean","example":false},"expirationDate":{"type":"string","format":"date-time","example":"2019-02-04T21:09:31.661Z"}}},"MobileDeviceCertificateV2":{"type":"object","properties":{"commonName":{"type":"string","example":"3B259E4B-FAD5-4860-B1DD-336ADA786EBA"},"identity":{"type":"boolean","example":false},"expirationDateEpoch":{"type":"string","format":"date-time","example":"2030-10-31T18:04:13Z"},"subjectName":{"type":"string","example":"CN=Fleet Docker Jamf Pro JSS Built-in Certificate Authority"},"serialNumber":{"type":"string","example":"5c28fdae"},"sha1Fingerprint":{"type":"string","example":"050cfe8ec9d170be7bf8f1a3cac2c52f3c6ddb20"},"issuedDateEpoch":{"type":"string","example":"2022-05-23T14:54:10Z"},"certificateStatus":{"type":"string","example":"ISSUED","enum":["EXPIRING","EXPIRED","REVOKED","PENDING_REVOKE","ISSUED"]},"lifecycleStatus":{"type":"string","example":"ACTIVE","enum":["ACTIVE","INACTIVE"]}}},"MobileDeviceDetailsGetV2":{"allOf":[{"$ref":"#/components/schemas/MobileDeviceDetailsV2"},{"type":"object","properties":{"managementId":{"type":"string","readOnly":true,"example":"73226fb6-61df-4c10-9552-eb9bc353d507"},"groups":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceInventoryGroup"}}}}]},"MobileDeviceDetailsV2":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"1"},"name":{"type":"string","description":"Mobile device name.","example":"Jon's iPad"},"enforceName":{"type":"boolean","description":"Enforce the mobile device name. Device must be supervised. If set to true, Jamf Pro will revert the Mobile Device Name to the ‘name’ value each time the device checks in.","example":false},"assetTag":{"type":"string","example":"12345"},"lastInventoryUpdateTimestamp":{"type":"string","format":"date-time","example":"2018-10-15T16:39:56Z"},"lastContactTimestamp":{"type":"string","format":"date-time","example":"2018-10-15T16:39:56Z"},"osVersion":{"type":"string","example":"11.4"},"osBuild":{"type":"string","example":"15F79"},"osSupplementalBuildVersion":{"type":"string","description":"Collected for iOS 16 and iPadOS 16.1 or later","example":"20B101"},"osRapidSecurityResponse":{"type":"string","description":"Collected for iOS 16 and iPadOS 16.1 or later","example":"(a)"},"softwareUpdateDeviceId":{"type":"string","example":"J132AP"},"serialNumber":{"type":"string","example":"DMQVGC0DHLF0"},"udid":{"type":"string","example":"0dad565fb40b010a9e490440188063a378721069"},"ipAddress":{"type":"string","example":"10.0.0.1"},"wifiMacAddress":{"type":"string","example":"ee:00:7c:f0:e5:ff"},"bluetoothMacAddress":{"type":"string","example":"ee:00:7c:f0:e5:aa"},"managed":{"type":"boolean","example":true},"timeZone":{"type":"string","example":"Europe/Warsaw"},"initialEntryTimestamp":{"type":"string","format":"date-time","example":"2018-10-15T16:39:56.307Z"},"lastEnrollmentTimestamp":{"type":"string","format":"date-time","example":"2018-10-15T16:39:56.307Z"},"mdmProfileExpirationTimestamp":{"type":"string","format":"date-time","example":"2018-10-15T16:39:56.307Z"},"deviceOwnershipLevel":{"type":"string","example":"institutional"},"enrollmentMethod":{"type":"string","example":"User-initiated - no invitation"},"enrollmentSessionTokenValid":{"type":"boolean","example":false},"declarativeDeviceManagementEnabled":{"type":"boolean","example":true},"appleEnrollmentType":{"type":"string","description":"The enrollment type reported by Apple.","example":"supervised","enum":["none","supervised","device","user","unknown"]},"awaitingConfiguration":{"type":"boolean","description":"Whether the device is awaiting configuration.","example":false},"site":{"$ref":"#/components/schemas/V1SiteBase"},"extensionAttributes":{"type":"array","items":{"$ref":"#/components/schemas/ExtensionAttributeV2"}},"location":{"$ref":"#/components/schemas/LocationV2"},"type":{"type":"string","description":"Based on the value of this either iOS, tvOS, watch or visionOS objects will be populated.","example":"ios","enum":["ios","tvos","watchos","visionos","unknown"]},"ios":{"$ref":"#/components/schemas/DetailsV2"},"tvos":{"$ref":"#/components/schemas/TvOsDetails"},"watchos":{"$ref":"#/components/schemas/WatchOsDetailsV2"},"visionos":{"$ref":"#/components/schemas/DetailsV2"}}},"MobileDeviceEbook":{"type":"object","properties":{"author":{"type":"string","example":"Homer J Simpson"},"title":{"type":"string","example":"The Odyssey"},"version":{"type":"string","example":"0.1"}}},"MobileDeviceEbookInventoryDetail":{"type":"object","properties":{"author":{"type":"string","example":"Homer J Simpson"},"title":{"type":"string","example":"The Odyssey"},"version":{"type":"string","example":"0.1"},"kind":{"type":"string","example":"PDF"},"managementState":{"type":"string","example":"Managed"}}},"MobileDeviceExtensionAttribute":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"1"},"name":{"type":"string","example":"Example EA"},"type":{"type":"string","example":"STRING","enum":["STRING","INTEGER","DATE"]},"value":{"type":"array","items":{"type":"string","example":"EA Value"}},"extensionAttributeCollectionAllowed":{"type":"boolean","example":false},"inventoryDisplay":{"type":"string","example":"General"}}},"MobileDeviceExtensionAttributeResults":{"type":"object","properties":{"extensionAttributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"extAttribute1"}}}}}},"MobileDeviceExtensionAttributeSearchResults":{"required":["totalCount"],"type":"object","properties":{"totalCount":{"type":"integer","example":1},"results":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceExtensionAttributes"}}}},"MobileDeviceExtensionAttributes":{"allOf":[{"$ref":"#/components/schemas/ExtensionAttributes"},{"required":["inputType","inventoryDisplayType"],"type":"object","properties":{"inventoryDisplayType":{"type":"string","description":"Category in which to display the extension attribute in Jamf Pro.","example":"GENERAL","enum":["GENERAL","HARDWARE","USER_AND_LOCATION","PURCHASING","EXTENSION_ATTRIBUTES"],"default":"GENERAL"},"inputType":{"type":"string","description":"Extension attributes collect inventory data by using an input type.The type of the Input used to populate the extension attribute.","enum":["TEXT","POPUP","DIRECTORY_SERVICE_ATTRIBUTE_MAPPING"],"default":"TEXT"},"popupMenuChoices":{"minItems":0,"type":"array","description":"When added with list of choices while creating mobile device extension attributes these Pop-up menu can be displayed in inventory information. User can choose a value from the pop-up menu list when enrolling a mobile device any time using Jamf Pro. Provide popupMenuChoices only when inputType is 'POPUP'.","example":["Test","Popup"],"items":{"type":"string","description":"Popup Menu choices."}},"ldapAttributeMapping":{"type":"string","description":"Directory Service attribute use to populate the extension attribute. <br/> Required when inputType is \"DIRECTORY_SERVICE_ATTRIBUTE_MAPPING\"","example":"ldapAttributeMapping"},"ldapExtensionAttributeAllowed":{"type":"boolean","description":"Collect multiple values for this extension attribute. ldapExtensionAttributeAllowed is disabled by default, only for inputType 'DIRECTORY_SERVICE_ATTRIBUTE_MAPPING' it can be enabled. It's value cannot be modified during edit operation.<br/> Possible values are:<br/> false <br/> true <br/>","example":false,"default":false}}}]},"MobileDeviceGeneral":{"type":"object","properties":{"udid":{"type":"string","example":"0dad565fb40b010a9e490440188063a378721069"},"displayName":{"type":"string","example":"Banezicron"},"assetTag":{"type":"string","example":"8675309"},"siteId":{"type":"string","example":"-1"},"lastInventoryUpdateDate":{"type":"string","format":"date-time","example":"2022-10-17T11:48:56.307Z"},"lastContactDate":{"type":"string","description":"The date and time of the most recent device contact via MDM or DDM channels.","format":"date-time","example":"2022-10-17T11:48:56.307Z"},"osVersion":{"type":"string","example":"11.4"},"osRapidSecurityResponse":{"type":"string","example":"(a)"},"osBuild":{"type":"string","example":"15F79"},"osSupplementalBuildVersion":{"type":"string","example":"22A103310o"},"softwareUpdateDeviceId":{"type":"string","example":"J132AP"},"ipAddress":{"type":"string","example":"10.0.0.1"},"managed":{"type":"boolean","example":true},"supervised":{"type":"boolean","example":true},"deviceOwnershipType":{"type":"string","description":"The enrollment method used for the device. **Note:** The `PersonalDeviceProfile` enrollment method was removed as of 11.25.\n","example":"Institutional","enum":["Institutional","UserEnrollment","AccountDrivenUserEnrollment","AccountDrivenDeviceEnrollment"]},"appleEnrollmentType":{"type":"string","description":"The enrollment type reported by Apple.","example":"supervised","enum":["none","supervised","device","user","unknown"]},"awaitingConfiguration":{"type":"boolean","description":"Whether the device is awaiting configuration.","example":false},"enrollmentMethodPrestage":{"$ref":"#/components/schemas/EnrollmentMethodPrestage"},"enrollmentSessionTokenValid":{"type":"boolean","example":false},"lastEnrolledDate":{"type":"string","format":"date-time","example":"2022-10-17T11:48:56.307Z"},"mdmProfileExpirationDate":{"type":"string","format":"date-time","example":"2022-10-17T11:48:56.307Z"},"timeZone":{"type":"string","description":"IANA time zone database name","example":"Europe/Warsaw"},"declarativeDeviceManagementEnabled":{"type":"boolean","example":true},"managementId":{"type":"string","example":"9932fad3-29e9-4b71-bc7c-77dcefce819d"},"extensionAttributes":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceExtensionAttribute"}},"lastLoggedInUsernameSelfService":{"type":"string","nullable":true,"example":"admin"},"lastLoggedInUsernameSelfServiceTimestamp":{"type":"string","format":"date-time","nullable":true,"example":"2018-10-31T18:04:13Z"},"lastLoggedInUsernameMdm":{"type":"string","nullable":true,"example":"admin"},"lastLoggedInUsernameMdmTimestamp":{"type":"string","format":"date-time","nullable":true,"example":"2018-10-31T18:04:13Z"}}},"MobileDeviceGroup":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"All Managed iPads"},"description":{"type":"string","example":"A group containing all managed iPads"},"isSmartGroup":{"type":"boolean","example":true}}},"MobileDeviceHardware":{"type":"object","properties":{"capacityMb":{"type":"integer","example":100},"availableSpaceMb":{"type":"integer","example":30},"usedSpacePercentage":{"type":"integer","example":70},"batteryLevel":{"type":"integer","example":60},"batteryHealth":{"type":"string","description":"- NON_GENUINE: The battery isn’t a genuine Apple battery.\n- NORMAL: The battery is operating normally.\n- SERVICE_RECOMMENDED: The system recommends battery service.\n- UNKNOWN: The system couldn’t determine battery health information.\n- UNSUPPORTED: The device doesn’t support battery health reporting.\n","enum":["NON_GENUINE","NORMAL","SERVICE_RECOMMENDED","UNKNOWN","UNSUPPORTED"],"default":"UNKNOWN"},"serialNumber":{"type":"string","example":"5c28fdae"},"wifiMacAddress":{"type":"string","example":"ee:00:7c:f0:e5:ff"},"bluetoothMacAddress":{"type":"string","example":"ee:00:7c:f0:e5:aa"},"modemFirmwareVersion":{"type":"string","example":"iPad7,11"},"model":{"type":"string","example":"iPad 7th Generation (Wi-Fi)"},"modelIdentifier":{"type":"string","example":"iPad7,11"},"modelNumber":{"type":"string","example":"MW742LL"},"bluetoothLowEnergyCapable":{"type":"boolean","example":false},"deviceId":{"type":"string","example":"c6a49c6d-8c09-4d71-a37d-2f6a9dfbb69b"},"systemHealth":{"$ref":"#/components/schemas/MobileDeviceSystemHealth"},"extensionAttributes":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceExtensionAttribute"}}}},"MobileDeviceInventory":{"required":["deviceType"],"type":"object","properties":{"mobileDeviceId":{"minLength":1,"type":"string","readOnly":true,"example":"1"},"deviceType":{"type":"string","description":"Based on the value of this type either ios, appleTv, watch or visionOS objects will be populated.","example":"iOS"},"hardware":{"$ref":"#/components/schemas/MobileDeviceHardware"},"userAndLocation":{"$ref":"#/components/schemas/MobileDeviceUserAndLocation"},"applications":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceApplicationInventoryDetail"}},"certificates":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceCertificate"}},"profiles":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceProfile"}},"groups":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceInventoryGroup"}},"extensionAttributes":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceExtensionAttribute"}}}},"MobileDeviceInventoryGroup":{"type":"object","properties":{"groupId":{"type":"string","example":"1"},"groupName":{"minLength":1,"type":"string","example":"Test Group"},"groupDescription":{"minLength":0,"type":"string","example":"Test Group Description"},"smart":{"type":"boolean","example":false}}},"MobileDeviceInventorySearchResults":{"type":"object","properties":{"totalCount":{"type":"integer","nullable":false,"example":2},"results":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceResponse"}}}},"MobileDeviceIosGeneral":{"allOf":[{"$ref":"#/components/schemas/MobileDeviceGeneral"},{"type":"object","properties":{"sharedIpad":{"type":"boolean","example":false},"diagnosticAndUsageReportingEnabled":{"type":"boolean","example":false},"appAnalyticsEnabled":{"type":"boolean","example":false},"residentUsers":{"type":"integer","example":0},"quotaSize":{"type":"integer","example":1024},"temporarySessionOnly":{"type":"boolean","example":false},"temporarySessionTimeout":{"type":"integer","example":30},"userSessionTimeout":{"type":"integer","example":30},"syncedToComputer":{"type":"integer","example":30},"maximumSharediPadUsersStored":{"type":"integer","example":16},"lastBackupDate":{"type":"string","format":"date-time","example":"2022-10-17T11:48:56.307Z"},"deviceLocatorServiceEnabled":{"type":"boolean","example":false},"doNotDisturbEnabled":{"type":"boolean","example":false},"cloudBackupEnabled":{"type":"boolean","example":false},"lastCloudBackupDate":{"type":"string","format":"date-time","example":"2022-10-17T11:48:56.307Z"},"locationServicesForSelfServiceMobileEnabled":{"type":"boolean","example":false},"itunesStoreAccountActive":{"type":"boolean","example":false},"exchangeDeviceId":{"type":"string","example":"eas-1"},"tethered":{"type":"boolean","example":false},"returnToServiceEnabled":{"type":"boolean","description":"Whether Return to Service is enabled.","example":false}}}]},"MobileDeviceIosInventory":{"allOf":[{"$ref":"#/components/schemas/MobileDeviceInventory"},{"type":"object","properties":{"general":{"$ref":"#/components/schemas/MobileDeviceIosGeneral"},"security":{"$ref":"#/components/schemas/MobileDeviceSecurity"},"ebooks":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceEbookInventoryDetail"}},"network":{"$ref":"#/components/schemas/MobileDeviceNetwork"},"serviceSubscriptions":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceServiceSubscriptions"}},"provisioningProfiles":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceProvisioningProfiles"}},"sharedUsers":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceSharedUser"}},"purchasing":{"$ref":"#/components/schemas/MobileDevicePurchasing"},"userProfiles":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceUserProfile"}}}}]},"MobileDeviceLostModeLocation":{"type":"object","properties":{"lastLocationUpdate":{"type":"string","format":"date-time","example":"2019-02-04T21:09:31.661Z"},"lostModeLocationHorizontalAccuracyMeters":{"type":"number","example":7},"lostModeLocationVerticalAccuracyMeters":{"type":"number","example":5},"lostModeLocationAltitudeMeters":{"type":"number","example":7.9},"lostModeLocationSpeedMetersPerSecond":{"type":"number","example":10},"lostModeLocationCourseDegrees":{"type":"number","example":15},"lostModeLocationTimestamp":{"type":"string","example":"2023-04-21 12:30:00 UTC"}}},"MobileDeviceMdmCapableUser":{"type":"object","properties":{"userShortName":{"type":"string","example":"testUser"},"managementId":{"type":"string","example":"8835fe1c-eb9d-42e5-8277-f708ae011a9d"}}},"MobileDeviceNetwork":{"type":"object","properties":{"cellularTechnology":{"type":"string","example":"Unknown"},"voiceRoamingEnabled":{"type":"boolean","example":false},"imei":{"type":"string","example":"59 105109 176278 3"},"iccid":{"type":"string","example":"8991101200003204514"},"meid":{"type":"string","example":"15302309236898"},"eid":{"type":"string","description":"EID or \"embedded identity document\" is a number associated with the eSIM on a device","readOnly":true,"example":"12547444452496388545569920380795"},"carrierSettingsVersion":{"type":"string","example":"33.1"},"currentCarrierNetwork":{"type":"string","example":"Verizon Wireless"},"currentMobileCountryCode":{"type":"string","example":"311"},"currentMobileNetworkCode":{"type":"string","example":"480"},"homeCarrierNetwork":{"type":"string","example":"Verizon"},"homeMobileCountryCode":{"type":"string","example":"US"},"homeMobileNetworkCode":{"type":"string","example":"480"},"dataRoamingEnabled":{"type":"boolean","example":true},"roaming":{"type":"boolean","example":false},"personalHotspotEnabled":{"type":"boolean","example":false},"phoneNumber":{"type":"string","example":"555-555-5555 ext 5"},"preferredVoiceNumber":{"type":"string","example":"555-555-5555"}},"description":"This section only avaiable for Ios type."},"MobileDevicePrestageNameV2":{"type":"object","properties":{"id":{"type":"string","example":"1"},"deviceName":{"type":"string","example":"iPad"},"used":{"type":"boolean","example":false}}},"MobileDevicePrestageNameV3":{"type":"object","properties":{"id":{"type":"string","example":"1"},"deviceName":{"type":"string","example":"iPad"},"used":{"type":"boolean","example":false}}},"MobileDevicePrestageNamesV2":{"type":"object","properties":{"assignNamesUsing":{"type":"string","example":"List of Names"},"prestageDeviceNames":{"type":"array","items":{"$ref":"#/components/schemas/MobileDevicePrestageNameV2"}},"deviceNamePrefix":{"type":"string","example":"prefix"},"deviceNameSuffix":{"type":"string","example":"suffix"},"singleDeviceName":{"type":"string","example":"name"},"manageNames":{"type":"boolean","example":true},"deviceNamingConfigured":{"type":"boolean","example":true}}},"MobileDevicePrestageNamesV3":{"type":"object","properties":{"assignNamesUsing":{"type":"string","example":"List of Names"},"prestageDeviceNames":{"type":"array","items":{"$ref":"#/components/schemas/MobileDevicePrestageNameV3"}},"deviceNamePrefix":{"type":"string","example":"prefix"},"deviceNameSuffix":{"type":"string","example":"suffix"},"singleDeviceName":{"type":"string","example":"name"},"manageNames":{"type":"boolean","example":true},"deviceNamingConfigured":{"type":"boolean","example":true}}},"MobileDevicePrestageSearchResultsV2":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":1},"results":{"type":"array","items":{"$ref":"#/components/schemas/GetMobileDevicePrestageV2"}}}},"MobileDevicePrestageSearchResultsV3":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":1},"results":{"type":"array","items":{"$ref":"#/components/schemas/GetMobileDevicePrestageV3"}}}},"MobileDevicePrestageV2":{"allOf":[{"$ref":"#/components/schemas/DeviceEnrollmentPrestageV2"},{"required":["allowPairing","configureDeviceBeforeSetupAssistant","maximumSharedAccounts","multiUser","sendTimezone","storageQuotaSizeMegabytes","supervised","timezone","useStorageQuotaSize"],"type":"object","properties":{"allowPairing":{"type":"boolean","example":true},"multiUser":{"type":"boolean","example":true},"supervised":{"type":"boolean","example":true},"maximumSharedAccounts":{"type":"integer","example":10},"configureDeviceBeforeSetupAssistant":{"type":"boolean","example":true},"names":{"$ref":"#/components/schemas/MobileDevicePrestageNamesV2"},"sendTimezone":{"type":"boolean","example":true},"timezone":{"type":"string","example":"America/Chicago"},"storageQuotaSizeMegabytes":{"type":"integer","example":4096},"useStorageQuotaSize":{"type":"boolean","example":true},"temporarySessionOnly":{"type":"boolean","example":false},"enforceTemporarySessionTimeout":{"type":"boolean","example":false},"temporarySessionTimeout":{"type":"integer","example":30},"enforceUserSessionTimeout":{"type":"boolean","example":false},"userSessionTimeout":{"type":"integer","example":30},"prestageMinimumOsTargetVersionTypeIos":{"type":"string","nullable":false,"example":"MINIMUM_OS_LATEST_VERSION","enum":["NO_ENFORCEMENT","MINIMUM_OS_LATEST_VERSION","MINIMUM_OS_LATEST_MAJOR_VERSION","MINIMUM_OS_LATEST_MINOR_VERSION","MINIMUM_OS_SPECIFIC_VERSION"]},"minimumOsSpecificVersionIos":{"minLength":0,"type":"string","nullable":false,"example":"17.1"},"prestageMinimumOsTargetVersionTypeIpad":{"type":"string","nullable":false,"example":"MINIMUM_OS_LATEST_VERSION","enum":["NO_ENFORCEMENT","MINIMUM_OS_LATEST_VERSION","MINIMUM_OS_LATEST_MAJOR_VERSION","MINIMUM_OS_LATEST_MINOR_VERSION","MINIMUM_OS_SPECIFIC_VERSION"]},"minimumOsSpecificVersionIpad":{"minLength":0,"type":"string","nullable":false,"example":"17.1"},"rtsEnabled":{"type":"boolean","example":false},"rtsConfigProfileId":{"type":"string","example":"1"}}}]},"MobileDevicePrestageV3":{"allOf":[{"$ref":"#/components/schemas/DeviceEnrollmentPrestageV3"},{"required":["allowPairing","configureDeviceBeforeSetupAssistant","maximumSharedAccounts","multiUser","sendTimezone","storageQuotaSizeMegabytes","supervised","timezone","useStorageQuotaSize"],"type":"object","properties":{"allowPairing":{"type":"boolean","example":true},"multiUser":{"type":"boolean","example":true},"supervised":{"type":"boolean","example":true},"maximumSharedAccounts":{"type":"integer","example":10},"configureDeviceBeforeSetupAssistant":{"type":"boolean","example":true},"names":{"$ref":"#/components/schemas/MobileDevicePrestageNamesV3"},"sendTimezone":{"type":"boolean","example":true},"timezone":{"type":"string","example":"America/Chicago"},"storageQuotaSizeMegabytes":{"type":"integer","example":4096},"useStorageQuotaSize":{"type":"boolean","example":true},"temporarySessionOnly":{"type":"boolean","example":false},"enforceTemporarySessionTimeout":{"type":"boolean","example":false},"temporarySessionTimeout":{"type":"integer","example":30},"enforceUserSessionTimeout":{"type":"boolean","example":false},"userSessionTimeout":{"type":"integer","example":30},"prestageMinimumOsTargetVersionTypeIos":{"type":"string","nullable":false,"example":"MINIMUM_OS_LATEST_VERSION","enum":["NO_ENFORCEMENT","MINIMUM_OS_LATEST_VERSION","MINIMUM_OS_LATEST_MAJOR_VERSION","MINIMUM_OS_LATEST_MINOR_VERSION","MINIMUM_OS_SPECIFIC_VERSION"]},"minimumOsSpecificVersionIos":{"minLength":0,"type":"string","nullable":false,"example":"17.1"},"prestageMinimumOsTargetVersionTypeIpad":{"type":"string","nullable":false,"example":"MINIMUM_OS_LATEST_VERSION","enum":["NO_ENFORCEMENT","MINIMUM_OS_LATEST_VERSION","MINIMUM_OS_LATEST_MAJOR_VERSION","MINIMUM_OS_LATEST_MINOR_VERSION","MINIMUM_OS_SPECIFIC_VERSION"]},"minimumOsSpecificVersionIpad":{"minLength":0,"type":"string","nullable":false,"example":"17.1"},"rtsEnabled":{"type":"boolean","example":false},"rtsConfigProfileId":{"type":"string","example":"1"},"preserveManagedApps":{"type":"boolean","description":"Controls whether managed apps are preserved during Return to Service operations.","example":false},"installAppsDuringEnrollment":{"type":"boolean","description":"Controls whether apps are installed during the enrollment process.","example":true},"doNotUseProfileFromBackup":{"type":"boolean","description":"If true, the device does not use the profile when it restores a backup. Default is false. Available in iOS 26 and later, and visionOS 26 and later; otherwise ignored by devices.","example":true}}}]},"MobileDeviceProfile":{"type":"object","properties":{"displayName":{"type":"string","example":"Test WiFi"},"version":{"type":"string","example":"1"},"uuid":{"type":"string","example":"D29DD9FB-0D5B-422F-A3A2-ABBC5848E949"},"identifier":{"type":"string","example":"ac2-server4.D0EFAC2D-326C-4BB6-87E6-2BCB88490AAA"},"removable":{"type":"boolean","example":true},"lastInstalled":{"type":"string","format":"date-time","example":"2019-02-04T21:09:31.661Z"}}},"MobileDeviceProvisioningProfiles":{"type":"object","properties":{"displayName":{"type":"string","example":"jamfnation"},"uuid":{"type":"string","example":"89AF33FC-123C-1231-AEFD-9C3ED123AFCC"},"expirationDate":{"type":"string","format":"date-time","example":"2018-10-24T21:57:37Z"}}},"MobileDevicePurchasing":{"type":"object","properties":{"purchased":{"type":"boolean","example":true},"leased":{"type":"boolean","example":false},"poNumber":{"type":"string","example":"8675309"},"vendor":{"type":"string","example":"Apple"},"appleCareId":{"type":"string","example":"9546567.0"},"purchasePrice":{"type":"string","example":"$399"},"purchasingAccount":{"type":"string","example":"IT Budget"},"poDate":{"type":"string","format":"date-time","example":"2019-02-04T21:09:31.661Z"},"warrantyExpiresDate":{"type":"string","format":"date-time","example":"2019-02-04T21:09:31.661Z"},"leaseExpiresDate":{"type":"string","format":"date-time","example":"2019-02-04T21:09:31.661Z"},"lifeExpectancy":{"type":"integer","example":7},"purchasingContact":{"type":"string","example":"Nick in IT"},"extensionAttributes":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceExtensionAttribute"}}}},"MobileDeviceResponse":{"type":"object","discriminator":{"propertyName":"deviceType","mapping":{"iOS":"#/components/schemas/MobileDeviceIosInventory","tvOS":"#/components/schemas/MobileDeviceTvOsInventory","watchOS":"#/components/schemas/MobileDeviceWatchOsInventory","visionOS":"#/components/schemas/MobileDeviceVisionOsInventory"}},"oneOf":[{"$ref":"#/components/schemas/MobileDeviceIosInventory"},{"$ref":"#/components/schemas/MobileDeviceTvOsInventory"},{"$ref":"#/components/schemas/MobileDeviceWatchOsInventory"},{"$ref":"#/components/schemas/MobileDeviceVisionOsInventory"}]},"MobileDeviceSearchResultsV2":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":3},"results":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceV2"}}}},"MobileDeviceSection":{"type":"string","example":"GENERAL","enum":["GENERAL","HARDWARE","USER_AND_LOCATION","PURCHASING","SECURITY","APPLICATIONS","EBOOKS","NETWORK","SERVICE_SUBSCRIPTIONS","CERTIFICATES","PROFILES","USER_PROFILES","PROVISIONING_PROFILES","SHARED_USERS","GROUPS","EXTENSION_ATTRIBUTES"]},"MobileDeviceSecurity":{"type":"object","properties":{"dataProtected":{"type":"boolean","example":false},"blockLevelEncryptionCapable":{"type":"boolean","example":true},"fileLevelEncryptionCapable":{"type":"boolean","example":true},"passcodePresent":{"type":"boolean","example":false},"passcodeCompliant":{"type":"boolean","example":true},"passcodeCompliantWithProfile":{"type":"boolean","example":true},"hardwareEncryption":{"type":"integer","example":3},"activationLockEnabled":{"type":"boolean","example":false},"jailBreakDetected":{"type":"boolean","example":false},"attestationStatus":{"type":"string","readOnly":true,"example":"SUCCESS","enum":["PENDING","SUCCESS","CERTIFICATE_INVALID","DEVICE_PROPERTIES_MISMATCH","MDA_UNSUPPORTED_DUE_TO_HARDWARE","MDA_UNSUPPORTED_DUE_TO_SOFTWARE"]},"lastAttestationAttemptDate":{"type":"string","format":"date-time","readOnly":true,"example":"2019-02-04T21:09:31.661Z"},"lastSuccessfulAttestationDate":{"type":"string","format":"date-time","readOnly":true,"example":"2019-02-04T21:09:31.661Z"},"passcodeLockGracePeriodEnforcedSeconds":{"type":"integer","example":3},"personalDeviceProfileCurrent":{"type":"boolean","description":"**Deprecated as of 11.25.** This field always returns false\n","readOnly":true,"deprecated":true,"default":false},"lostModeEnabled":{"type":"boolean","example":false},"lostModePersistent":{"type":"boolean","example":false},"lostModeMessage":{"type":"string","example":"Lost phone"},"lostModePhoneNumber":{"type":"string","example":"555-555-5555"},"lostModeFootnote":{"type":"string","example":"Note"},"lostModeLocation":{"$ref":"#/components/schemas/MobileDeviceLostModeLocation"},"bootstrapTokenEscrowed":{"type":"string","description":"Indicates the bootstrap token escrow status for the device","example":"NOT_SUPPORTED","enum":["ESCROWED","NOT_ESCROWED","NOT_SUPPORTED"]},"lockdownModeEnabled":{"type":"boolean","description":"Whether Lockdown Mode is enabled.","example":false}},"description":"This section only available for Ios type."},"MobileDeviceServiceSubscriptions":{"type":"object","properties":{"carrierSettingsVersion":{"type":"string","example":"47.1"},"currentCarrierNetwork":{"type":"string","example":"T-Mobile Wi-Fi"},"currentMobileCountryCode":{"type":"string","example":"310"},"currentMobileNetworkCode":{"type":"string","example":"260"},"subscriberCarrierNetwork":{"type":"string","example":"T-Mobile Wi-Fi"},"eid":{"type":"string","example":"89049032007008882600085727376656"},"iccid":{"type":"string","example":"8901 2605 7071 8002 130"},"imei":{"type":"string","example":"35 882334 083223 0"},"dataPreferred":{"type":"boolean","example":true},"roaming":{"type":"boolean","example":true},"voicePreferred":{"type":"boolean","example":true},"label":{"type":"string","example":"Primary"},"labelId":{"type":"string","description":"The unique identifier for this subscription.","example":"D1F4AEC5-2FCD-4A6D-A09E-A940F60F856B"},"meid":{"type":"string","example":"35882334083223"},"phoneNumber":{"type":"string","example":"+15128145868"},"slot":{"type":"string","description":"The description of the slot that contains the SIM representing this subscription.","example":"CTSubscriptionSlotOne"}}},"MobileDeviceSharedUser":{"type":"object","properties":{"managedAppleId":{"type":"string","example":"astark@jamf.edu"},"loggedIn":{"type":"boolean","example":true},"dataToSync":{"type":"boolean","example":true}}},"MobileDeviceSmartGroupCriteriaV2":{"required":["andOr","name","priority","searchType","value"],"type":"object","properties":{"name":{"maxLength":255,"type":"string","description":"The field to search on (e.g., Model, OS Version, etc.)","example":"Model"},"priority":{"type":"integer","description":"The priority order of this criterion (must start at 0 and increment by 1)","example":0},"andOr":{"type":"string","description":"Whether this criterion should be ANDed or ORed with the previous criterion. Must be exactly \"and\" or \"or\" (case-insensitive).","example":"and","enum":["and","or"]},"searchType":{"type":"string","description":"The type of search to perform (e.g., is, is not, like, etc.)","example":"is"},"value":{"maxLength":255,"type":"string","description":"The value to search for","example":"iPad"},"openingParen":{"type":"boolean","description":"Whether to add an opening parenthesis before this criterion","example":false},"closingParen":{"type":"boolean","description":"Whether to add a closing parenthesis after this criterion","example":false}}},"MobileDeviceSystemHealth":{"type":"object","properties":{"baseband":{"maxLength":255,"type":"string","example":"ok"},"camera":{"maxLength":255,"type":"string","example":"ok"},"display":{"maxLength":255,"type":"string","example":"ok"},"faceId":{"maxLength":255,"type":"string","example":"ok"},"touchId":{"maxLength":255,"type":"string","example":"ok"},"nfc":{"maxLength":255,"type":"string","example":"ok"},"ultraWideband":{"maxLength":255,"type":"string","example":"ok"}},"description":"System health status for device components. Reported for iOS devices."},"MobileDeviceTvOsGeneral":{"allOf":[{"$ref":"#/components/schemas/MobileDeviceGeneral"},{"type":"object","properties":{"airPlayPassword":{"type":"string","example":"1234"},"locales":{"type":"string","example":"null"},"languages":{"type":"string","example":"english"}}}]},"MobileDeviceTvOsInventory":{"allOf":[{"$ref":"#/components/schemas/MobileDeviceInventory"},{"type":"object","properties":{"general":{"$ref":"#/components/schemas/MobileDeviceTvOsGeneral"},"purchasing":{"$ref":"#/components/schemas/MobileDevicePurchasing"},"userProfiles":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceUserProfile"}}}}]},"MobileDeviceUserAndLocation":{"type":"object","properties":{"username":{"type":"string","example":"admin"},"realName":{"type":"string","example":"IT Bob"},"emailAddress":{"type":"string","example":"ITBob@jamf.com"},"position":{"type":"string","example":"IT Team Lead"},"phoneNumber":{"type":"string","example":"555-555-5555"},"departmentId":{"type":"string","example":"1"},"buildingId":{"type":"string","example":"1"},"room":{"type":"string","example":"room"},"building":{"type":"string","example":"Building 1"},"department":{"type":"string","example":"Department 1"},"extensionAttributes":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceExtensionAttribute"}}}},"MobileDeviceUserProfile":{"type":"object","properties":{"displayName":{"type":"string","example":"Test WiFi"},"version":{"type":"string","example":"1"},"uuid":{"type":"string","example":"D29DD9FB-0D5B-422F-A3A2-ABBC5848E949"},"identifier":{"type":"string","example":"ac2-server4.D0EFAC2D-326C-4BB6-87E6-2BCB88490AAA"},"removable":{"type":"boolean","example":true},"lastInstalled":{"type":"string","format":"date-time","example":"2019-02-04T21:09:31.661Z"},"username":{"type":"string","example":"admin"}}},"MobileDeviceV2":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"1"},"name":{"type":"string","example":"iPad"},"serialNumber":{"type":"string","example":"DMQVGC0DHLA0"},"wifiMacAddress":{"type":"string","example":"C4:84:66:92:78:00"},"udid":{"type":"string","example":"0dad565fb40b010a9e490440188063a378721069"},"phoneNumber":{"type":"string","example":"651-555-5555 Ext111"},"model":{"type":"string","example":"iPad 5th Generation (Wi-Fi)"},"modelIdentifier":{"type":"string","example":"iPad6,11"},"username":{"type":"string","example":"admin"},"type":{"type":"string","example":"ios","enum":["ios","tvos","watchos","visionos","unknown"]},"managementId":{"type":"string","readOnly":true,"example":"73226fb6-61df-4c10-9552-eb9bc353d507"},"softwareUpdateDeviceId":{"type":"string","example":"J132AP"}}},"MobileDeviceVisionOsGeneral":{"allOf":[{"$ref":"#/components/schemas/MobileDeviceGeneral"},{"type":"object","properties":{"diagnosticAndUsageReportingEnabled":{"type":"boolean","example":false},"appAnalyticsEnabled":{"type":"boolean","example":false},"deviceLocatorServiceEnabled":{"type":"boolean","example":false},"doNotDisturbEnabled":{"type":"boolean","example":false},"cloudBackupEnabled":{"type":"boolean","example":false},"lastCloudBackupDate":{"type":"string","format":"date-time","nullable":true,"example":"2022-10-17T11:48:56.307Z"},"itunesStoreAccountActive":{"type":"boolean","example":false}}}]},"MobileDeviceVisionOsInventory":{"allOf":[{"$ref":"#/components/schemas/MobileDeviceInventory"},{"type":"object","properties":{"general":{"$ref":"#/components/schemas/MobileDeviceVisionOsGeneral"},"security":{"$ref":"#/components/schemas/MobileDeviceSecurity"},"network":{"$ref":"#/components/schemas/MobileDeviceNetwork"},"provisioningProfiles":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/MobileDeviceProvisioningProfiles"}},"purchasing":{"$ref":"#/components/schemas/MobileDevicePurchasing"}}}]},"MobileDeviceWatchOsGeneral":{"allOf":[{"$ref":"#/components/schemas/MobileDeviceGeneral"},{"type":"object","properties":{"diagnosticAndUsageReportingEnabled":{"type":"boolean","example":false},"appAnalyticsEnabled":{"type":"boolean","example":false},"deviceLocatorServiceEnabled":{"type":"boolean","example":false},"doNotDisturbEnabled":{"type":"boolean","example":false},"lastCloudBackupDate":{"type":"string","format":"date-time","example":"2022-10-17T11:48:56.307Z"},"itunesStoreAccountActive":{"type":"boolean","example":false}}}]},"MobileDeviceWatchOsInventory":{"allOf":[{"$ref":"#/components/schemas/MobileDeviceInventory"},{"type":"object","properties":{"general":{"$ref":"#/components/schemas/MobileDeviceWatchOsGeneral"},"security":{"$ref":"#/components/schemas/MobileDeviceSecurity"},"provisioningProfiles":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceProvisioningProfiles"}}}}]},"NetworkV2":{"type":"object","properties":{"cellularTechnology":{"type":"string","example":"Unknown"},"voiceRoamingEnabled":{"type":"boolean","example":false},"imei":{"type":"string","example":"59 105109 176278 3"},"iccid":{"type":"string","example":"8991101200003204514"},"meid":{"type":"string","example":"15302309236898"},"eid":{"type":"string","description":"EID or \"embedded identity document\" is a number associated with the eSIM on a device","readOnly":true,"example":"12547444452496388545569920380795"},"carrierSettingsVersion":{"type":"string","example":"33.1"},"currentCarrierNetwork":{"type":"string","example":"Verizon Wireless"},"currentMobileCountryCode":{"type":"string","example":"311"},"currentMobileNetworkCode":{"type":"string","example":"480"},"homeCarrierNetwork":{"type":"string","example":"Verizon"},"homeMobileCountryCode":{"type":"string","example":"US"},"homeMobileNetworkCode":{"type":"string","example":"480"},"dataRoamingEnabled":{"type":"boolean","example":true},"roaming":{"type":"boolean","example":false},"personalHotspotEnabled":{"type":"boolean","example":false},"phoneNumber":{"type":"string","example":"555-555-5555 ext 5"},"preferredVoiceNumber":{"type":"string","example":"555-555-5555"}}},"NotificationType":{"type":"string","enum":["APNS_CERT_REVOKED","APNS_CONNECTION_FAILURE","APPLE_SCHOOL_MANAGER_T_C_NOT_SIGNED","BUILT_IN_CA_EXPIRED","BUILT_IN_CA_EXPIRING","BUILT_IN_CA_RENEWAL_FAILED","BUILT_IN_CA_RENEWAL_SUCCESS","CLOUD_LDAP_CERT_EXPIRED","CLOUD_LDAP_CERT_WILL_EXPIRE","DEP_INSTANCE_EXPIRED","DEP_INSTANCE_WILL_EXPIRE","DEVICE_ENROLLMENT_PROGRAM_T_C_NOT_SIGNED","EXCEEDED_LICENSE_COUNT","FREQUENT_INVENTORY_COLLECTION_POLICY","GSX_CERT_EXPIRED","GSX_CERT_WILL_EXPIRE","HCL_BIND_ERROR","HCL_ERROR","INSECURE_LDAP","INVALID_REFERENCES_EXT_ATTR","INVALID_REFERENCES_POLICIES","INVALID_REFERENCES_SCRIPTS","JAMF_CONNECT_UPDATE","JAMF_PROTECT_UPDATE","JIM_ERROR","LDAP_CONNECTION_CHECK_THROUGH_JIM_FAILED","LDAP_CONNECTION_CHECK_THROUGH_JIM_SUCCESSFUL","MDM_EXTERNAL_SIGNING_CERTIFICATE_EXPIRED","MDM_EXTERNAL_SIGNING_CERTIFICATE_EXPIRING","MDM_EXTERNAL_SIGNING_CERTIFICATE_EXPIRING_TODAY","MII_HEARTBEAT_FAILED_NOTIFICATION","MII_INVENTORY_UPLOAD_FAILED_NOTIFICATION","MII_UNATHORIZED_RESPONSE_NOTIFICATION","PATCH_EXTENTION_ATTRIBUTE","PATCH_UPDATE","POLICY_MANAGEMENT_ACCOUNT_PAYLOAD_SECURITY_MULTIPLE","POLICY_MANAGEMENT_ACCOUNT_PAYLOAD_SECURITY_SINGLE","PUSH_CERT_EXPIRED","PUSH_CERT_WILL_EXPIRE","PUSH_PROXY_CERT_EXPIRED","SSO_CERT_EXPIRED","SSO_IDP_CERT_EXPIRED","SSO_CERT_WILL_EXPIRE","SSO_IDP_CERT_WILL_EXPIRE","TOMCAT_SSL_CERT_EXPIRED","TOMCAT_SSL_CERT_WILL_EXPIRE","USER_INITIATED_ENROLLMENT_MANAGEMENT_ACCOUNT_SECURITY_ISSUE","USER_MAID_DUPLICATE_ERROR","USER_MAID_MISMATCH_ERROR","USER_MAID_ROSTER_DUPLICATE_ERROR","VPP_ACCOUNT_EXPIRED","VPP_ACCOUNT_WILL_EXPIRE","VPP_TOKEN_REVOKED","DEVICE_COMPLIANCE_CONNECTION_ERROR","CONDITIONAL_ACCESS_CONNECTION_ERROR","AZURE_AD_MIGRATION_REPORT_GENERATED","BEYOND_CORP_CONNECTION_ERROR","APP_INSTALLERS_NEW_APP_VERSION_AVAILABLE","APP_INSTALLERS_NEW_APP_VERSION_DEPLOYMENT_STARTED","APP_INSTALLERS_APP_VERSION_REMOVED","APP_INSTALLERS_APP_TITLE_REMOVED","APP_INSTALLERS_DEPLOYMENT_INSTALLATION_FAILED","SAML_RESPONSE_ASSERTION_SIGNING_REQUIRED","DIRECTORY_CACHE_AWAITING_SYNC","PSSO_EXTERNAL_URL_UNAVAILABLE"]},"NotificationV1":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/NotificationType"},"id":{"type":"string","example":"1"},"params":{"type":"object","additionalProperties":{"type":"object"},"example":{}}},"description":"Jamf Pro notification used for important alerts."},"OAuthClientCredentials":{"required":["clientId","clientSecret"],"type":"object","properties":{"clientId":{"type":"string","example":"admin"},"clientSecret":{"type":"string","example":"12345"}}},"OAuthTokenEndpointErrorResponse":{"required":["error"],"type":"object","properties":{"error":{"type":"string","example":"invalid_client"},"error_description":{"type":"string","example":"OAuth 2.0 Parameter: grant_type"},"error_uri":{"type":"string","example":"https://datatracker.ietf.org/doc/html/rfc6749#section-5.2"}}},"OAuthTokenRequest":{"required":["client_id","client_secret","grant_type"],"type":"object","properties":{"grant_type":{"type":"string","description":"OAuth2 grant type. For Jamf Pro API Clients, use `client_credentials`","example":"client_credentials"},"client_id":{"type":"string","description":"Client ID from your API Client","example":"1979ca82-1337-c0de-1012-82a008a3bf70"},"client_secret":{"type":"string","description":"Client secret from your API Client","format":"password","writeOnly":true,"example":"-j1o7Ery2fQG9IrBsUoTjN-AdcgFvj9zgXpSN_JdNjR6jYzTrU-K1ngshmzo3RuG"},"scope":{"type":"string","description":"Optional. Provide a space-delimited list of roles that are within the configuration for \nthis API Client. Omitting this field will grant an access token that includes all of this client's \nallowed roles. Specifying a subset of them will limit the privileges for this access token to\nthat subset of roles. Specifying a role that is not assigned to this client will result in \nan `invalid_scope` error. The format matches what is returned from the OAuth token\nendpoint response's `scope` field.\n","example":"api-role:1 api-role:2"}}},"OAuthTokenResponse":{"required":["access_token","expires_in","scope","token_type"],"type":"object","properties":{"access_token":{"type":"string","example":"eyJhbGciOiJIUzI1NiJ9.RXJpayBTYXRpZSBzYWlkIHlvdSBoYWQgdG8gcGxhbiBWZXhhdGlvbnMgODQwIHRpbWVzIGluIGEgcm93Li4uZG8geW91IHRoaW5rIGhlIHJlYWxseSBtZWFudCBpdD8.bGlF3raOEwNgcbV52yVJClNixVlwrJy2RECVFrH_GQg"},"token_type":{"type":"string","example":"Bearer"},"scope":{"type":"string","description":"Space-delimited list of API Roles, formatted and identified by ID like `api-role:{apiRoleId}`.","example":"api-role:1 api-role:2"},"expires_in":{"type":"integer","description":"Seconds until this access token is expired. This will reflect the `accessTokenLifetimeSeconds` value configured on your API Client.","example":60}}},"OauthTokens":{"type":"object","properties":{"accessToken":{"type":"string","nullable":false,"example":"eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NiIsImtpZCI6ImEyNDc2MmUwOTc1NDllMzIzZTVlYzY5OGE2Zjk0NjZiIn0.eyJodHRwczovL2V4YW1wbGUuY29tL2xhbmd1YWdlIjoiZW5fVVMiLCJodHRwczovL2V4YW1wbGUuY29tL3RpbWV6b25lIjoiRXVyb3BlL1dhcnNhdyIsImh0dHBzOi8vZXhhbXBsZS5jb20vY29ubmVjdGlvbl9uYW1lIjoiVGVzdC1hc2ZhZGZzZ3NkZmh5NjV6dHgzd3BnM2xiY28iLCJodHRwczovL2V4YW1wbGUuY29tL2lzX2phbWZfZW1wbG95ZWUiOmZhbHNlLCJpc3MiOiJodHRwczovL3Rlc3QuZW52LmF1dGgwLmNvbS8iLCJzdWIiOiJvaWRjfFRlc3QtYXNmYWRmc2dzZGZoeTY1enR4M3dwZzNsYmNvfDRwM3ItRkl4THVBREZydGRnYTM0ZGZTU29Xc0hFRUhhayIsImF1ZCI6WyJodHRwOi8vZXhhbXBsZS5jb20iLCJodHRwczovL3Rlc3QuZW52LmF1dGgwLmNvbS91c2VyaW5mbyJdLCJpYXQiOjE3MTUxOTM2NjYsImV4cCI6MTcxNTI4MDA2Niwic2NvcGUiOiJvcGVuaWQgcHJvZmlsZSBlbWFpbCIsImF6cCI6Ikh4ZVVqdDkxanFldHRXRXphck5nazBnbjdtWHYxbHBCUSJ9.D230129dYtmQLPYeZxKD2gBz9M3MA-8xpOg1IHMNpYgoK_zQLMwpNdWqdWO7xGPj2vc8xZOT6h0sY6pre15s_g"},"idToken":{"type":"string","nullable":false,"example":"eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NiIsImtpZCI6Ijg2YmY4MzVkOWM2NWM5Yzg3YzY0MmEyMGIzZjQzYzdkIiwiaHR0cHM6Ly9leGFtcGxlLmNvbS9jb250YWN0X2lkIjoiMDAzVkUwMDAwMEF2VFFvWUFOIiwiaHR0cHM6Ly9leGFtcGxlLmNvbS9hY2NvdW50X2lkIjoiMDAxOEowMDAwMEZCbzF1UUFEIiwiaHR0cHM6Ly9leGFtcGxlLmNvbS9zdXBwb3J0X3BsYW4iOiJTdGFuZGFyZCIsImh0dHBzOi8vZXhhbXBsZS5jb20vY3JtX3JvbGUiOiJVbmtub3duIiwiaHR0cHM6Ly9leGFtcGxlLmNvbS9maXJzdF9uYW1lIjoiV29ya2VyIiwiaHR0cHM6Ly9leGFtcGxlLmNvbS9sYXN0X25hbWUiOiIxIiwiaHR0cHM6Ly9leGFtcGxlLmNvbS9jb250YWN0X25hbWUiOiJVc2VyIiwiaHR0cHM6Ly9leGFtcGxlLmNvbS9sYW5ndWFnZSI6ImVuX1VTIiwiaHR0cHM6Ly9leGFtcGxlLmNvbS90aW1lem9uZSI6IkV1cm9wZS9XYXJzYXciLCJodHRwczovL2V4YW1wbGUuY29tL2Nvbm5lY3Rpb25fbmFtZSI6IlRlc3RFbnYtNmRkb242dGFnaG9wZmQ1NnNkZzV6dHgzd3BnM2xiY28iLCJodHRwczovL2V4YW1wbGUuY29tL2lzX2phbWZfZW1wbG95ZWUiOmZhbHNlLCJuaWNrbmFtZSI6InVzZXItMSIsIm5hbWUiOiJVc2VyIiwicGljdHVyZSI6Imh0dHBzOi8vcy5ncmF2YXRhci5jb20vYXZhdGFyL3ZhdGFycyUyRncxLnBuZyIsInVwZGF0ZWRfYXQiOiIyMDI0LTA1LTE1VDE2OjEwOjI2LjUyMloiLCJlbWFpbCI6InVzZXJAZXhhbXBsZS5jb20iLCJpc3MiOiJodHRwczovL3Rlc3QuZW52LmF1dGgwLmNvbS8iLCJhdWQiOiJIYXNkZnJ0NDM1MzRzZGZzYWFkZmZyNTQiLCJpYXQiOjE3MTU3ODk0MzcsImV4cCI6MTcxNTgyNTQzNywic3ViIjoib2lkY3xUZXN0RW52LTZkZG9uNnRhZ2hvcGZkNTZzZGc1enR4M3dwZzNsYmNvfDRwM3ItRkl4THVkYlRCLXNhZGZhbGtqNTM0c2RzZjM0NTU0MyIsInNpZCI6IjNLbnk5dTNPa2tGSEFTRDU1NXMxVDl1MENyX1ZVIiwibm9uY2UiOiJwUzBGcFR3NHBUWnMzRzVDQ0NkNE9hWFdTSXBUN0hWMmZ6SHF3cERWRWMifQ.e30.N2sF3wD4cHMnoi667YFNPK7u7UfOnxdbt7cZPPF3JJUw_UDeOhS5r7O6fyaQVD0VowLukQILVb_PdnxayNKYrg"}},"nullable":false},"ObjectHistory":{"type":"object","properties":{"id":{"minimum":1,"type":"integer","example":1},"username":{"type":"string","example":"admin"},"date":{"type":"string","example":"2019-02-04T21:09:31.661Z"},"note":{"type":"string","example":"Sso settings update"},"details":{"type":"string","nullable":true,"example":"Is SSO Enabled false\\nSelected SSO Provider"}}},"ObjectHistoryNote":{"required":["note"],"type":"object","properties":{"note":{"type":"string","example":"A generic note can sometimes be useful, but generally not."}}},"ObjectHistoryV1":{"type":"object","properties":{"id":{"minLength":1,"type":"string","example":"1"},"username":{"type":"string","example":"admin"},"date":{"type":"string","example":"2019-02-04T21:09:31.661Z"},"note":{"type":"string","example":"Sso settings update"},"details":{"type":"string","nullable":true,"example":"Is SSO Enabled false\\nSelected SSO Provider"}}},"OidcBrokerConfig":{"required":["capabilities","clientAuthMethod","clientId","clientType","discoveryUrl","enabled","id","productUserMapping","redirectUris","scopes"],"type":"object","properties":{"id":{"type":"string","example":"550e8400-e29b-41d4-a716-446655440000"},"clientType":{"type":"string","nullable":true,"example":"CONFIDENTIAL","enum":["PUBLIC","CONFIDENTIAL"]},"clientAuthMethod":{"type":"string","description":"Read this before updating to determine whether an update changes the client authentication method, which requires supplying the new method's credential.","nullable":true,"example":"CLIENT_SECRET","enum":["CLIENT_SECRET","PRIVATE_KEY_JWT"]},"productUsernameClaim":{"type":"string","example":"email"},"productUserMapping":{"type":"string","nullable":true,"example":"EMAIL","enum":["USERNAME","EMAIL"]},"capabilities":{"type":"array","description":"A broker configuration carries ADMIN_SSO; an update preserves whatever is already stored rather than replacing it. The other values exist for non-broker IdP configurations.","example":["ADMIN_SSO"],"items":{"type":"string","enum":["IOS_SELF_SERVICE_PLUS","MAC_SELF_SERVICE_PLUS","USER_INITIATED_ENROLLMENT","ADMIN_SSO"]}},"discoveryUrl":{"type":"string","example":"https://example.okta.com/.well-known/openid-configuration"},"clientId":{"type":"string","example":"my-client-id"},"scopes":{"type":"array","example":["openid","profile"],"items":{"type":"string"}},"redirectUris":{"type":"array","example":["https://app.jamf.com/callback"],"items":{"type":"string"}},"enabled":{"type":"boolean","example":true},"createdAt":{"type":"string","format":"date-time","example":"2024-01-15T10:30:00Z"},"updatedAt":{"type":"string","format":"date-time","example":"2024-01-16T08:45:00Z"}},"description":"The tenant's currently selected OIDC broker IdP configuration. Secret fields (clientSecret, privateKeyJwt) are never included in the response. The three enum-valued fields are always present but may be null — an unrecognized value from a newer authentication service is read as null rather than failing the response."},"OidcBrokerConfigUpdate":{"required":["clientAuthMethod","clientId","discoveryUrl","enabled","productUserMapping","scopes"],"type":"object","properties":{"clientAuthMethod":{"type":"string","description":"Selects which credential the authentication service stores and which it clears — the credential belonging to the other method is discarded. Changing this value therefore requires the new method's credential in the same request.","example":"CLIENT_SECRET","enum":["CLIENT_SECRET","PRIVATE_KEY_JWT"]},"productUsernameClaim":{"type":"string","example":"email"},"productUserMapping":{"type":"string","example":"EMAIL","enum":["USERNAME","EMAIL"]},"discoveryUrl":{"type":"string","example":"https://example.okta.com/.well-known/openid-configuration"},"clientId":{"type":"string","example":"my-client-id"},"scopes":{"minItems":1,"type":"array","example":["openid","profile"],"items":{"type":"string"}},"clientSecret":{"type":"string","description":"Omit to keep the currently stored secret; supply to rotate it. Required when this request changes clientAuthMethod to CLIENT_SECRET, or when clientAuthMethod is CLIENT_SECRET and no secret is currently stored.","format":"password","writeOnly":true,"example":"***"},"privateKeyJwt":{"type":"string","description":"Omit to keep the currently stored key; supply to rotate it. Required when this request changes clientAuthMethod to PRIVATE_KEY_JWT, or when clientAuthMethod is PRIVATE_KEY_JWT and no key is currently stored.","format":"password","writeOnly":true,"example":"***"},"enabled":{"type":"boolean","description":"Required. The authentication service replaces this value on every update, so omitting it would silently re-enable a disabled configuration.","example":true}},"description":"Full-replacement update of the tenant's broker IdP configuration. The config to update is the tenant's stored broker selection; it is not part of this body. Every non-secret field is replaced with the value sent here, so all of them must be supplied on every update; only the secret fields are kept when omitted — except when this request changes clientAuthMethod, which requires the new method's credential to be supplied. The clientType (always CONFIDENTIAL) is set by Jamf Pro, and the capabilities and redirect URIs are carried over from the stored configuration unchanged; none of the three can be supplied here."},"OidcDirectIdpLoginSkipUrl":{"required":["url"],"type":"object","properties":{"url":{"type":"string","description":"Direct IdP login URL to skip unified login page.","example":"https://jamf-pro-server/oauth2/authorization/idp-region-domain.com"}}},"OidcJwksResponse":{"type":"object","properties":{"keys":{"type":"array","items":{"type":"object","properties":{"kty":{"type":"string","example":"RSA"},"e":{"type":"string","example":"AQAB"},"use":{"type":"string","example":"sig"},"kid":{"type":"string","example":"695eccd8c1918105c0f57fcac412651245d778cd301fca44a5ee6f7e0c5320ce"},"alg":{"type":"string","example":"RS256"},"iat":{"type":"integer","example":1717518913},"n":{"type":"string","example":"yvoRJjwm_JR3z0_MQS5zU8RQCav82PbdZOG8DYcDzRrbklVJZXAGOH16m6egW5B-hb_zxncsSCZTvwmXYiUsWcYE8Lu-CZ0-O2WmpOsk-rc5mklQlEGlD2N3u6MZWIpOofyrbM2AhVssmzgFRHR_22O05KDsNKMKy7ZQaUvvIbqBrnvGRKJMZ4GqzeWyo3rmBpdhmY1wLoPQBAQgwO-TTy5xLhTmLLimAV6ckkLtxjUUdwu4pSKiiJGkJAlDEFXJA5-Y9GE3CZOywj1sJsuHvfHGcgWbEDYVVqdD6PB4NRKmuvj_yJ1BACObaFSLNzfw693FBvuyH1s9D-zGT58Kvw"}}}}}},"OidcLoginDispatchRequest":{"required":["emailAddress","originalUrl"],"type":"object","properties":{"originalUrl":{"type":"string","description":"Original Url","example":"aHR0cHM6Ly9qYW1mLXByby11cmwuY29tL2xvZ2dpbmcuaHRtbA=="},"emailAddress":{"type":"string","description":"User email address","example":"admin@domain.name"}}},"OidcLoginDispatchResponse":{"required":["redirectUrl"],"type":"object","properties":{"redirectUrl":{"type":"string","example":"/oauth2/authorization/jamf-account-domain.name?original_url=aHR0cHM6Ly9qYW1mLXByby11cmwuY29tL2xvZ2dpbmcuaHRtbA==&login_hint=YWRtaW5AZG9tYWluLm5hbWU="}}},"OidcLoginDispatchResponseV2":{"required":["redirectUrl"],"type":"object","properties":{"idpRedirects":{"type":"array","items":{"type":"object","properties":{"redirectUrl":{"type":"string","example":"/oauth2/authorization/jamf-account-domain.name?original_url=aHR0cHM6Ly9qYW1mLXByby11cmwuY29tL2xvZ2dpbmcuaHRtbA==&login_hint=YWRtaW5AZG9tYWluLm5hbWU="},"idpName":{"type":"string","example":"SomeIdp"},"idpType":{"type":"string","example":"GENERIC_OIDC"},"logoUrl":{"type":"string","description":"Customer-provided icon served by jamf account URL for this connection. Null when no custom icon is configured (Jamf ID connections always return null).\n","nullable":true,"example":"https://acme.example.com/sso-logo.png"}}}}}},"OidcPublicFeaturesResponse":{"required":["jamfIdAuthenticationEnabled"],"type":"object","properties":{"jamfIdAuthenticationEnabled":{"type":"boolean","description":"Indicates whether Jamf ID authentication is enabled for this instance. When true, users can authenticate using Jamf ID credentials. When false, Jamf ID login option is not available.","example":true}}},"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"]}}},"OnboardingConfiguration":{"required":["enabled","onboardingItems"],"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"1"},"enabled":{"type":"boolean","nullable":false,"example":true},"onboardingItems":{"type":"array","items":{"$ref":"#/components/schemas/OnboardingItem"}}}},"OnboardingEligibleItem":{"required":["id","name","scopeDescription","siteDescription"],"type":"object","properties":{"id":{"type":"string","nullable":false,"example":"1"},"name":{"type":"string","nullable":false,"example":"Item 1"},"scopeDescription":{"type":"string","nullable":false,"example":"All Computers"},"siteDescription":{"type":"string","nullable":false,"example":"Example Site"}}},"OnboardingEligibleItemsSearchResult":{"type":"object","properties":{"totalCount":{"type":"integer","nullable":false,"example":1},"results":{"type":"array","items":{"$ref":"#/components/schemas/OnboardingEligibleItem"}}},"description":"A list of onboarding eligible items"},"OnboardingItem":{"required":["entityId","priority","selfServiceEntityType"],"type":"object","properties":{"id":{"type":"string","nullable":true,"example":"3"},"entityId":{"type":"string","description":"The id of the Jamf Pro object that should be added to the onboarding workflow for end users.\nUse this in conjunction with the selfServiceEntityType. For example, if the policy with id 132\nshould be added to onboarding, then entityId should be 132 and selfServiceEntityType should be \nOS_X_POLICY.\n","nullable":false,"example":"1"},"entityName":{"type":"string","readOnly":true,"example":"Policy 1"},"scopeDescription":{"type":"string","readOnly":true,"example":"All Computers"},"siteDescription":{"type":"string","readOnly":true,"example":"None"},"selfServiceEntityType":{"type":"string","nullable":false,"example":"OS_X_POLICY","enum":["OS_X_POLICY","OS_X_CONFIG_PROFILE","OS_X_MAC_APP","OS_X_APP_INSTALLER","OS_X_EBOOK","OS_X_PATCH_POLICY","UNKNOWN"]},"priority":{"type":"integer","nullable":false,"example":35}}},"OrganizationName":{"required":["organizationName"],"type":"object","properties":{"organizationName":{"type":"string","description":"The Organization Name for Jamf Pro.","nullable":false,"example":"Your Organization Name"}}},"Package":{"required":["categoryId","fileName","fillUserTemplate","osInstall","packageName","priority","rebootRequired","suppressEula","suppressFromDock","suppressRegistration","suppressUpdates"],"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"1"},"packageName":{"type":"string","example":"Google Chrome"},"fileName":{"type":"string","example":"my-package.pkg"},"categoryId":{"type":"string","example":"-1"},"info":{"type":"string","nullable":true,"example":"A package that is important to my organization."},"notes":{"type":"string","nullable":true,"example":"Some notes."},"priority":{"type":"integer","example":3},"osRequirements":{"type":"string","nullable":true,"example":"10.6.8, 10.7.x"},"fillUserTemplate":{"type":"boolean","example":false},"indexed":{"type":"boolean","readOnly":true,"example":false},"fillExistingUsers":{"type":"boolean","example":false},"swu":{"type":"boolean","example":false},"rebootRequired":{"type":"boolean","example":false},"selfHealNotify":{"type":"boolean","example":false},"selfHealingAction":{"type":"string","nullable":true,"example":"nothing"},"osInstall":{"type":"boolean","example":false},"serialNumber":{"type":"string","nullable":true,"example":"1234"},"parentPackageId":{"type":"string","nullable":true,"example":"3"},"basePath":{"type":"string","nullable":true,"example":"my/path"},"suppressUpdates":{"type":"boolean","example":false},"cloudTransferStatus":{"type":"string","readOnly":true,"example":"READY"},"ignoreConflicts":{"type":"boolean","example":false},"suppressFromDock":{"type":"boolean","example":false},"suppressEula":{"type":"boolean","example":false},"suppressRegistration":{"type":"boolean","example":false},"installLanguage":{"type":"string","nullable":true,"example":"en_US"},"md5":{"type":"string","nullable":true,"example":"0cc175b9c0f1b6a831c399e269772661"},"sha256":{"type":"string","nullable":true,"example":"61be55a8e2f6b4e172338bddf184d6dbee29c98853e0a0485ecee7f27b9af0b4"},"sha3512":{"type":"string","nullable":true,"example":"a51a01e63f76c4601a2989575280e2a1c1e83191382277906b0f92a251c53bbbd1d9804dd30edd304cffe75d1c6455440b0c39081ca94c68f149d1f719e15092"},"hashType":{"type":"string","nullable":true,"example":"MD5"},"hashValue":{"type":"string","nullable":true,"example":"0cc175b9c0f1b6a831c399e269772661"},"size":{"type":"string","nullable":true,"readOnly":true,"example":"234KB"},"osInstallerVersion":{"type":"string","nullable":true,"example":"10.3.x"},"manifest":{"type":"string","nullable":true,"example":"manifest"},"manifestFileName":{"type":"string","nullable":true,"example":"manifest.plist"},"format":{"type":"string","nullable":true,"example":"format"}}},"PackageManifest":{"required":["bundleId","bundleVersion","hash","hashType","sizeInBytes","title","url"],"type":"object","properties":{"url":{"type":"string","example":"https://example.jamf.com/this/package"},"hash":{"type":"string","example":"dcb02a41cd6d842943459a88c96a5f72"},"hashType":{"type":"string","example":"MD5","enum":["MD5","SHA256"]},"displayImageUrl":{"type":"string","example":"https://example.jamf.com/img/display/this/package.jpg"},"fullSizeImageUrl":{"type":"string","example":"https://example.jamf.com/img/full/this/package.jpg"},"bundleId":{"type":"string","example":"com.jamf.example"},"bundleVersion":{"type":"string","example":"0.1.0"},"subtitle":{"type":"string","example":"Subtitle"},"title":{"type":"string","example":"Title"},"sizeInBytes":{"type":"integer","example":12345}}},"PackagesSearchResults":{"type":"object","properties":{"totalCount":{"type":"integer","example":1},"results":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/Package"}}}},"PagedUserResults":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number (zero-based)","format":"int32","nullable":false,"example":0},"pageSize":{"type":"integer","description":"Number of results per page","format":"int32","example":100},"totalCount":{"type":"integer","description":"Total number of users matching the search criteria","format":"int64","example":150},"totalPages":{"type":"integer","description":"Total number of pages available","format":"int64","example":2},"hasNext":{"type":"boolean","description":"True if there are more pages after the current page","example":true},"hasPrevious":{"type":"boolean","description":"True if there are pages before the current page","example":false},"results":{"type":"array","description":"List of users in the current page","items":{"$ref":"#/components/schemas/User"}}}},"ParentApp":{"required":["deviceGroupId","isEnabled","restrictedTimes","timezoneId"],"type":"object","properties":{"timezoneId":{"type":"string","example":"Europe/Paris"},"restrictedTimes":{"type":"object","properties":{"key":{"$ref":"#/components/schemas/DayOfWeek"}},"additionalProperties":{"$ref":"#/components/schemas/TimeFrame"},"example":{"SUNDAY":{"beginTime":"08:30:00","endTime":"15:45:00"}}},"deviceGroupId":{"type":"integer","example":1},"isEnabled":{"type":"boolean","example":true},"allowTemplates":{"type":"boolean","example":true},"disassociateOnWipeAndReEnroll":{"type":"boolean","example":true},"allowClearPasscode":{"type":"boolean","example":true},"safelistedApps":{"type":"array","items":{"$ref":"#/components/schemas/SafelistedApp"}}}},"PatchPolicies":{"type":"object","properties":{"totalCount":{"type":"integer","example":1},"results":{"type":"array","items":{"$ref":"#/components/schemas/PatchPolicyListView"}}}},"PatchPolicyDetail":{"type":"object","properties":{"id":{"type":"string","nullable":false,"example":"1"},"name":{"type":"string","example":"Policy name"},"enabled":{"type":"boolean","example":false},"targetPatchVersion":{"type":"string","example":"v1"},"deploymentMethod":{"type":"string","example":"automatically"},"softwareTitleId":{"type":"string","example":"1"},"softwareTitleConfigurationId":{"type":"string","example":"1"},"killAppsDelayMinutes":{"type":"integer","example":5},"killAppsMessage":{"type":"string","example":"message"},"downgrade":{"type":"boolean","example":false},"patchUnknownVersion":{"type":"boolean","example":false},"notificationHeader":{"type":"string","example":"notification header"},"selfServiceEnforceDeadline":{"type":"boolean","example":false},"selfServiceDeadline":{"type":"integer","example":1},"installButtonText":{"type":"string","example":"install"},"selfServiceDescription":{"type":"string","example":"description"},"iconId":{"type":"string","example":"1"},"reminderFrequency":{"type":"integer","example":1},"reminderEnabled":{"type":"boolean","example":false}}},"PatchPolicyDetails":{"type":"object","properties":{"totalCount":{"type":"integer","nullable":false,"example":1},"results":{"type":"array","items":{"$ref":"#/components/schemas/PatchPolicyDetail"}}}},"PatchPolicyListView":{"type":"object","properties":{"id":{"type":"string","example":"1"},"policyName":{"type":"string","example":"Policy name"},"policyEnabled":{"type":"boolean","example":false},"policyTargetVersion":{"type":"string","example":"v1"},"policyDeploymentMethod":{"type":"string","example":"automatically"},"softwareTitle":{"type":"string","example":"Software title"},"softwareTitleConfigurationId":{"type":"string","example":"1"},"pending":{"type":"integer","example":0},"completed":{"type":"integer","example":0},"deferred":{"type":"integer","example":0},"failed":{"type":"integer","example":0}}},"PatchPolicyLogDetail":{"type":"object","properties":{"id":{"type":"string","example":"1"},"attemptNumber":{"type":"integer","example":1},"deviceId":{"type":"string","example":"1"},"actions":{"type":"array","items":{"$ref":"#/components/schemas/PatchPolicyLogDetailAction"}}}},"PatchPolicyLogDetailAction":{"type":"object","properties":{"id":{"type":"string","example":"1"},"actionOrder":{"type":"integer","example":1},"action":{"type":"string","example":"Installing..."}}},"PatchPolicyLogEligibleRetryCount":{"type":"object","properties":{"count":{"type":"integer","example":5}}},"PatchPolicyLogRetry":{"type":"object","properties":{"deviceIds":{"type":"array","example":["1","3"],"items":{"type":"string"}}}},"PatchPolicyLogV2":{"type":"object","properties":{"patchPolicyId":{"type":"string","example":"1"},"deviceName":{"type":"string","example":"Admins Macbook"},"deviceId":{"type":"string","example":"1"},"statusCode":{"type":"integer","example":1},"statusDate":{"type":"string","format":"date-time","example":"2019-02-04T21:09:31.661Z"},"statusEnum":{"type":"string","example":"COMPLETED","enum":["UNKNOWN","PENDING","COMPLETED","FAILED"]},"attemptNumber":{"type":"integer","example":1},"ignoredForPatchPolicyId":{"type":"string","example":"1"}}},"PatchPolicyLogs":{"type":"object","properties":{"totalCount":{"type":"integer","example":1},"results":{"type":"array","items":{"$ref":"#/components/schemas/PatchPolicyLogV2"}}}},"PatchPolicyV2OnDashboard":{"type":"object","properties":{"onDashboard":{"type":"boolean","nullable":false,"example":true}}},"PatchReportV3":{"type":"object","properties":{"computerName":{"type":"string","nullable":true,"example":"MacBook"},"deviceId":{"type":"string","nullable":true,"example":"2"},"username":{"type":"string","nullable":true,"example":"User"},"operatingSystemVersion":{"type":"string","nullable":true,"example":"10.11"},"lastCheckIn":{"type":"string","format":"date-time","nullable":true,"example":"1970-01-01T00:00:00Z"},"buildingName":{"type":"string","nullable":true,"example":"Building"},"departmentName":{"type":"string","nullable":true,"example":"Department"},"siteName":{"type":"string","nullable":true,"example":"Site"},"version":{"type":"string","nullable":true,"example":"10.1"}}},"PatchSoftwareTitleConfiguration":{"allOf":[{"$ref":"#/components/schemas/PatchSoftwareTitleConfigurationBase"},{"type":"object","properties":{"id":{"type":"string","nullable":false,"example":"1"},"packages":{"type":"array","items":{"$ref":"#/components/schemas/PatchSoftwareTitlePackages"}}}}]},"PatchSoftwareTitleConfigurationBase":{"required":["displayName","softwareTitleId"],"type":"object","properties":{"displayName":{"type":"string","nullable":false,"example":"Google Chrome"},"categoryId":{"type":"string","example":"-1","default":"-1"},"siteId":{"type":"string","example":"-1","default":"-1"},"uiNotifications":{"type":"boolean","example":false,"default":false},"emailNotifications":{"type":"boolean","example":false,"default":false},"softwareTitleId":{"type":"string","nullable":false,"example":"1"},"jamfOfficial":{"type":"boolean","readOnly":true,"example":false},"extensionAttributes":{"type":"array","items":{"$ref":"#/components/schemas/PatchSoftwareTitleConfigurationExtensionAttributes"}},"softwareTitleName":{"type":"string","readOnly":true,"example":"Safari"},"softwareTitleNameId":{"type":"string","readOnly":true,"example":"AppleSafari"},"softwareTitlePublisher":{"type":"string","readOnly":true,"example":"Apple"},"patchSourceName":{"type":"string","readOnly":true,"example":"Jamf"},"patchSourceEnabled":{"type":"boolean","readOnly":true,"example":true}}},"PatchSoftwareTitleConfigurationDefinitionKillApp":{"type":"object","properties":{"appName":{"type":"string","example":"Firefox"}}},"PatchSoftwareTitleConfigurationDependencies":{"type":"object","properties":{"totalCount":{"type":"integer","nullable":false,"example":1},"results":{"type":"array","items":{"$ref":"#/components/schemas/PatchSoftwareTitleConfigurationDependency"}}}},"PatchSoftwareTitleConfigurationDependency":{"type":"object","properties":{"smartGroupId":{"type":"string","nullable":false,"example":"1"},"smartGroupName":{"type":"string","example":"name"}}},"PatchSoftwareTitleConfigurationExtensionAttributes":{"type":"object","properties":{"accepted":{"type":"boolean","description":"Once an extension attribute is accepted, it cannot be reverted.","example":false,"default":false},"eaId":{"type":"string","nullable":false,"example":"google-chrome-ea"}}},"PatchSoftwareTitleConfigurationPatch":{"type":"object","properties":{"displayName":{"type":"string","example":"Google Chrome"},"categoryId":{"type":"string","example":"-1"},"siteId":{"type":"string","example":"-1"},"uiNotifications":{"type":"boolean","example":false},"emailNotifications":{"type":"boolean","example":false},"softwareTitleId":{"type":"string","example":"1"},"packages":{"type":"array","items":{"$ref":"#/components/schemas/PatchSoftwareTitlePackages"}},"extensionAttributes":{"type":"array","items":{"$ref":"#/components/schemas/PatchSoftwareTitleConfigurationExtensionAttributes"}}}},"PatchSoftwareTitleDefinition":{"type":"object","properties":{"version":{"type":"string","nullable":false,"example":"10.37.0"},"minimumOperatingSystem":{"type":"string","example":"12.0.1","default":"-1"},"releaseDate":{"type":"string","example":"2010-12-10 13:36:04","default":"-1"},"rebootRequired":{"type":"boolean","example":false,"default":false},"killApps":{"type":"array","items":{"$ref":"#/components/schemas/PatchSoftwareTitleConfigurationDefinitionKillApp"}},"standalone":{"type":"boolean","example":false,"default":false},"absoluteOrderId":{"type":"string","example":"1"}}},"PatchSoftwareTitleDefinitions":{"type":"object","properties":{"totalCount":{"type":"integer","example":1},"results":{"type":"array","items":{"$ref":"#/components/schemas/PatchSoftwareTitleDefinition"}}}},"PatchSoftwareTitleExtensionAttributes":{"type":"object","properties":{"eaId":{"type":"string","nullable":false,"example":"google-chrome-ea"},"accepted":{"type":"boolean","example":true},"displayName":{"type":"string","example":"Google Chrome"},"scriptContents":{"type":"string","format":"base64","example":"ZXhhbXBsZSBvZiBhIGJhc2U2NCBlbmNvZGVkIHZhbGlkIHAxMi4ga2V5c3RvcmUgZmlsZQ=="}}},"PatchSoftwareTitlePackages":{"type":"object","properties":{"packageId":{"type":"string","nullable":false,"example":"1"},"version":{"type":"string","nullable":false,"example":"1"},"displayName":{"type":"string","readOnly":true,"example":"Firefox.pkg"}}},"PatchSoftwareTitleReport":{"type":"object","properties":{"computerName":{"type":"string","example":"MacBook"},"deviceId":{"type":"string","example":"2"},"username":{"type":"string","example":"User"},"operatingSystemVersion":{"type":"string","example":"10.11"},"lastContactTime":{"type":"string","format":"date-time","example":"1970-01-01T00:00:00Z"},"buildingName":{"type":"string","example":"Building"},"departmentName":{"type":"string","example":"Department"},"siteName":{"type":"string","example":"Site"},"version":{"type":"string","example":"10.1"}}},"PatchSoftwareTitleReportSearchResult":{"type":"object","properties":{"totalCount":{"type":"integer","example":1},"results":{"type":"array","items":{"$ref":"#/components/schemas/PatchSoftwareTitleReport"}}}},"PatchSoftwareTitleReportV3SearchResult":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":3},"results":{"type":"array","items":{"$ref":"#/components/schemas/PatchReportV3"}}}},"PatchSummary":{"type":"object","properties":{"softwareTitleId":{"type":"string","example":"1"},"title":{"type":"string","example":"Patch title"},"latestVersion":{"type":"string","example":"2"},"releaseDate":{"type":"string","format":"date-time","example":"2018-10-15T16:39:56.307Z"},"upToDate":{"type":"integer","example":3},"outOfDate":{"type":"integer","example":6},"onDashboard":{"type":"boolean","example":false},"softwareTitleConfigurationId":{"type":"string","example":"1"}}},"PatchSummaryVersion":{"type":"object","properties":{"absoluteOrderId":{"type":"string","example":"1"},"version":{"type":"string","example":"3"},"onVersion":{"type":"integer","example":1}}},"PersonalHotspotSetting":{"type":"string","example":"ENABLE_PERSONAL_HOTSPOT","enum":["ENABLE_PERSONAL_HOTSPOT","DISABLE_PERSONAL_HOTSPOT"]},"PlanConfigurationPost":{"required":["updateAction","versionType"],"type":"object","properties":{"updateAction":{"type":"string","nullable":false,"example":"DOWNLOAD_INSTALL","enum":["DOWNLOAD_ONLY","DOWNLOAD_INSTALL","DOWNLOAD_INSTALL_ALLOW_DEFERRAL","DOWNLOAD_INSTALL_RESTART","DOWNLOAD_INSTALL_SCHEDULE","UNKNOWN"]},"versionType":{"type":"string","nullable":false,"example":"SPECIFIC_VERSION","enum":["LATEST_MAJOR","LATEST_MINOR","LATEST_ANY","SPECIFIC_VERSION","CUSTOM_VERSION","UNKNOWN"]},"specificVersion":{"minLength":0,"type":"string","description":"Optional. Indicates the specific version to update to. Only available when the version type is set to specific version or custom version, otherwise defaults to NO_SPECIFIC_VERSION.","example":"12.6.1","default":"NO_SPECIFIC_VERSION"},"buildVersion":{"type":"string","description":"Optional. Indicates the build version to update to. Only available when the version type is set to custom version.","nullable":true,"example":"21F79"},"maxDeferrals":{"minimum":0,"type":"integer","description":"Required when the provided updateAction is DOWNLOAD_INSTALL_ALLOW_DEFERRAL, not applicable to all managed software update plans","example":5},"forceInstallLocalDateTime":{"type":"string","description":"Optional. Indicates the local date and time of the device to force update by.","nullable":true,"example":"2023-12-25T21:09:31"}},"nullable":false},"PlanDevice":{"type":"object","properties":{"deviceId":{"minLength":1,"type":"string","readOnly":true,"example":"1"},"objectType":{"type":"string","nullable":false,"readOnly":true,"example":"COMPUTER","enum":["COMPUTER","MOBILE_DEVICE","APPLE_TV"]},"href":{"type":"string","nullable":false,"readOnly":true,"example":"/v1/computers-inventory/1"}}},"PlanDevicePost":{"required":["deviceId","objectType"],"type":"object","properties":{"deviceId":{"minLength":1,"type":"string","example":"1"},"objectType":{"type":"string","nullable":false,"example":"COMPUTER","enum":["COMPUTER","MOBILE_DEVICE","APPLE_TV"]}}},"PlanDeviceResponse":{"type":"object","properties":{"device":{"$ref":"#/components/schemas/PlanDevice"},"planId":{"minLength":1,"type":"string","readOnly":true,"example":"6E47EF55-5318-494F-A09E-70F613E0AFD1"},"href":{"type":"string","nullable":false,"readOnly":true,"example":"/v1/managed-software-updates/plans/6E47EF55-5318-494F-A09E-70F613E0AFD1"}}},"PlanGroupPost":{"required":["groupId","objectType"],"type":"object","properties":{"groupId":{"minLength":1,"type":"string","example":"1"},"objectType":{"type":"string","nullable":false,"example":"COMPUTER_GROUP","enum":["COMPUTER_GROUP","MOBILE_DEVICE_GROUP"]}},"nullable":false},"PlanSearchResults":{"type":"object","properties":{"totalCount":{"type":"integer","nullable":false,"example":3},"results":{"type":"array","items":{"$ref":"#/components/schemas/JamfProtectPlan"}}}},"PlanStatus":{"type":"object","properties":{"state":{"type":"string","nullable":false,"readOnly":true,"example":"SchedulingScanForOSUpdates","enum":["Init","PendingPlanValidation","AcceptingPlan","RejectingPlan","ProcessingPlanType","ProcessingPlanTypeMdm","StartingPlan","PlanFailed","SchedulingScanForOSUpdates","ProcessingScheduleOSUpdateScanResponse","WaitingForScheduledOSUpdateScanToComplete","CollectingAvailableOSUpdates","ProcessingAvailableOSUpdatesResponse","ProcessingSchedulingType","SchedulingDDM","DDMPlanScheduled","WaitingToStartDDMUpdate","ProcessingDDMStatusResponse","CollectingDDMStatus","SchedulingMDM","MDMPlanScheduled","SchedulingOSUpdate","ProcessingScheduleOSUpdateResponse","CollectingOSUpdateStatus","ProcessingOSUpdateStatusResponse","WaitingToCollectOSUpdateStatus","VerifyingInstallation","ProcessingInstallationVerification","PlanCompleted","PlanCanceled","PlanException","Unknown"]},"errorReasons":{"type":"array","nullable":true,"readOnly":true,"example":["NO_UPDATES_AVAILABLE","NOT_SUPERVISED"],"items":{"type":"string","enum":["APPLE_SILICON_NO_ESCROW_KEY","NOT_SUPERVISED","NOT_MANAGED","NO_DISK_SPACE","NO_UPDATES_AVAILABLE","SPECIFIC_VERSION_UNAVAILABLE","SPECIFIC_VERSION_UNAVAILABLE_FOR_DEVICE_MODEL","ACTION_NOT_SUPPORTED_FOR_DEVICE_TYPE","DECLARATIVE_DEVICE_MANAGEMENT_SOFTWARE_UPDATES_NOT_SUPPORTED_FOR_DEVICE_OS_VERSION","DECLARATIVE_DEVICE_MANAGEMENT_SOFTWARE_UPDATES_NOT_SUPPORTED_FOR_DEVICE_TYPE","PLAN_NOT_FOUND","APPLE_SOFTWARE_LOOKUP_SERVICE_ERROR","EXISTING_PLAN_FOR_DEVICE_IN_PROGRESS","DOWNGRADE_NOT_SUPPORTED","DECLARATIVE_SERVICE_ERROR","UNABLE_TO_FIND_UPDATES_AND_OUT_OF_RETRIES","DATA_INTEGRITY_VIOLATION_EXCEPTION","ILLEGAL_ARGUMENT_EXCEPTION","MDM_EXCEPTION","INSTALL_REASON_UNKNOWN","ACCEPT_PLAN_FAILURE","SCHEDULE_PLAN_FAILURE","REJECT_PLAN_FAILURE","START_PLAN_FAILURE","QUEUE_SCHEDULED_OS_UPDATE_SCAN_FAILURE","SCAN_WAIT_FINISHED_FAILURE","QUEUE_AVAILABLE_OS_UPDATE_COMMAND_FAILURE","MDM_CLIENT_EXCEPTION","QUEUE_SCHEDULE_OS_UPDATE_FAILURE","QUEUE_OS_UPDATE_STATUS_COMMAND_FAILURE","STILL_IN_PROGRESS_FAILURE","WAIT_TO_COLLECT_OS_UPDATE_STATUS_FAILURE","IS_DOWNLOADED_AND_NEEDS_INSTALL_FAILURE","IS_INSTALLED_FAILURE","IS_DOWNLOAD_ONLY_AND_DOWNLOADED_FAILURE","VERIFY_INSTALLATION_FAILURE","IS_MAC_OS_UPDATE_FAILURE","IS_LATEST_FAILURE","IS_SPECIFIC_VERSION_FAILURE","HANDLE_COMMAND_QUEUE_FAILURE","INVALID_CONFIGURATION_DECLARATION","DECLARATIVE_DEVICE_MANAGEMENT_STATUS_RESPONSE_FAILURE_REASON_RECEIVED","NO_DEVICE_STATUS_BY_GRACE_PERIOD","UNKNOWN"]}}}},"PlatformInitializeV1":{"required":["activationCode","email","eulaAccepted","institutionName","jssUrl","username"],"type":"object","properties":{"activationCode":{"maxLength":39,"minLength":39,"type":"string","example":"VFAB-YDAB-DFAB-UDAB-DEAB-EFAB-ABAB-DEAB"},"institutionName":{"minLength":1,"type":"string","example":"Jamf"},"eulaAccepted":{"type":"boolean","example":false},"username":{"minLength":1,"type":"string","description":"Federated user OIDC username to create","example":"admin"},"email":{"type":"string","description":"Federated user OIDC email to create","example":"ITBob@jamf.com"},"jssUrl":{"minLength":1,"type":"string","example":"https://jamf.jamfcloud.com"}},"description":"Platform Initial Jamf Pro setup data"},"PlayLostModeSoundCommand":{"allOf":[{"$ref":"#/components/schemas/MdmCommandBase"},{"type":"object"}]},"PluginPath":{"required":["id","path"],"type":"object","properties":{"id":{"type":"string","description":"A \"-1\" id indicates a built-in path that cannot be deleted or modified.","example":"3"},"path":{"type":"string","example":"/Example/Path/To/Plugin/"}}},"PolicyProperties":{"type":"object","properties":{"isPoliciesRequireNetworkStateChange":{"type":"boolean","description":"This field always returns false.","default":false},"isAllowNetworkStateChangeTriggers":{"type":"boolean","default":true}}},"PolicyPropertiesV1":{"type":"object","properties":{"policiesRequireNetworkStateChange":{"type":"boolean","description":"This field always returns false.","default":false},"allowNetworkStateChangeTriggers":{"type":"boolean","default":true}}},"PostComputerPrestageV3":{"allOf":[{"$ref":"#/components/schemas/ComputerPrestageV3"},{"type":"object","properties":{"accountSettings":{"$ref":"#/components/schemas/AccountSettingsRequest"},"recoveryLockPassword":{"minLength":1,"type":"string","format":"password","writeOnly":true,"example":"password123"}}}]},"PrestageDependencies":{"type":"object","properties":{"dependencies":{"type":"array","items":{"$ref":"#/components/schemas/PrestageDependency"}}}},"PrestageDependency":{"type":"object","properties":{"name":{"type":"string","example":"Name"},"humanReadableName":{"type":"string","example":"Computer PreStage"},"hyperlink":{"type":"string","example":"/mobile-prestage/id"}}},"PrestageFileAttachmentV2":{"type":"object","properties":{"id":{"type":"string","example":"1"},"name":{"type":"string","example":"receipt.pdf"},"fileType":{"type":"string","example":"pdf"}}},"PrestageFileAttachmentV3":{"type":"object","properties":{"id":{"type":"string","example":"1"},"name":{"type":"string","example":"receipt.pdf"},"fileType":{"type":"string","example":"pdf"}}},"PrestagePurchasingInformationV2":{"required":["appleCareId","id","leaseDate","leased","lifeExpectancy","poDate","poNumber","purchasePrice","purchased","purchasingAccount","purchasingContact","vendor","versionLock","warrantyDate"],"type":"object","properties":{"id":{"type":"string","example":"-1"},"leased":{"type":"boolean","example":true},"purchased":{"type":"boolean","example":true},"appleCareId":{"type":"string","example":"abcd"},"poNumber":{"type":"string","example":"53-1"},"vendor":{"type":"string","example":"Example Vendor"},"purchasePrice":{"type":"string","example":"$500"},"lifeExpectancy":{"type":"integer","example":5},"purchasingAccount":{"type":"string","example":"admin"},"purchasingContact":{"type":"string","example":"true"},"leaseDate":{"type":"string","example":"2019-01-01"},"poDate":{"type":"string","example":"2019-01-01"},"warrantyDate":{"type":"string","example":"2019-01-01"},"versionLock":{"type":"integer","example":1}}},"PrestagePurchasingInformationV3":{"required":["appleCareId","id","leaseDate","leased","lifeExpectancy","poDate","poNumber","purchasePrice","purchased","purchasingAccount","purchasingContact","vendor","versionLock","warrantyDate"],"type":"object","properties":{"id":{"type":"string","example":"-1"},"leased":{"type":"boolean","example":true},"purchased":{"type":"boolean","example":true},"appleCareId":{"type":"string","example":"abcd"},"poNumber":{"type":"string","example":"53-1"},"vendor":{"type":"string","example":"Example Vendor"},"purchasePrice":{"type":"string","example":"$500"},"lifeExpectancy":{"type":"integer","example":5},"purchasingAccount":{"type":"string","example":"admin"},"purchasingContact":{"type":"string","example":"true"},"leaseDate":{"type":"string","example":"2019-01-01"},"poDate":{"type":"string","example":"2019-01-01"},"warrantyDate":{"type":"string","example":"2019-01-01"},"versionLock":{"type":"integer","example":1}}},"PrestageScopeAssignmentV2":{"type":"object","properties":{"serialNumber":{"type":"string","example":"XYZ"},"assignmentDate":{"type":"string","format":"date-time","example":"2019-02-04T21:09:31.661Z"},"userAssigned":{"type":"string","example":"admin"}}},"PrestageScopeResponseV2":{"type":"object","properties":{"prestageId":{"type":"string","example":"1"},"assignments":{"type":"array","items":{"$ref":"#/components/schemas/PrestageScopeAssignmentV2"}},"versionLock":{"type":"integer","example":1}}},"PrestageScopeUpdate":{"required":["serialNumbers","versionLock"],"type":"object","properties":{"serialNumbers":{"type":"array","example":["DMQVGC0DHLF0","C02L29ECF8J1"],"items":{"type":"string"}},"versionLock":{"type":"integer","example":1}}},"PrestageScopeV2":{"type":"object","properties":{"serialsByPrestageId":{"type":"object","additionalProperties":{"type":"string"},"example":{"ABCD":1,"XYZ":12}}}},"PrestageSyncStatusV2":{"type":"object","properties":{"syncState":{"type":"string","example":"CONNECTION_ERROR"},"prestageId":{"type":"string","example":"1"},"timestamp":{"type":"string","example":"2019-04-17T14:08:06.706+0000"}}},"ProcessTextsSearchResults":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":10},"results":{"type":"array","items":{"$ref":"#/components/schemas/EnrollmentProcessTextObject"}}}},"ProfileListCommand":{"allOf":[{"$ref":"#/components/schemas/MdmCommandBase"},{"type":"object","properties":{"managedOnly":{"type":"boolean","description":"If true, only managed configuration profiles are returned. If false, all configuration profiles are returned. The default value is false.","nullable":true,"example":true,"default":false}}}]},"ProtectRegistrationRequest":{"required":["clientId","password","protectUrl"],"type":"object","properties":{"protectUrl":{"type":"string","example":"https://examplejamfprotect.jamfcloud.com/graphql"},"clientId":{"type":"string","example":"uzPJXlArmzTAmPRQtZEnQ2OFtNw8qQV"},"password":{"type":"string","format":"password","writeOnly":true,"example":"7fyP6BphUUQ5B_zoLrkYhM5j1HTcf-4PxshettZbK0ZcnzV57gyHwF23U3F96F"}},"description":"Create an API Client in the Jamf Protect web console to obtain these values."},"ProtectSettingsResponse":{"type":"object","properties":{"id":{"type":"string","nullable":false,"example":"1"},"apiClientId":{"type":"string","example":"esgzYzYBqN7wCImwyusbQcXob2qalGMN"},"apiClientName":{"type":"string","description":"display name used when creating the API Client in the Jamf Protect web console","example":"Jamf Pro integration"},"registrationId":{"type":"string","description":"ID used when making requests to identify this particular Protect registration.","example":"6f250316-2cfb-4521-8cb7-bfaf46497bc5"},"protectUrl":{"type":"string","example":"https://examplejamfprotect.jamfcloud.com/graphql"},"platformPlanSync":{"type":"boolean","description":"determines whether Protect Platform Plan syncing is enabled","example":true},"lastSyncTime":{"type":"string","example":"2003-01-05T18:00:14.885Z"},"syncStatus":{"type":"string","example":"COMPLETED","enum":["IN_PROGRESS","COMPLETED","ERROR","UNKNOWN"]},"autoInstall":{"type":"boolean","description":"determines whether the Jamf Protect agent will be automatically installed on client computers","example":true}}},"ProtectUpdatableSettingsRequest":{"type":"object","properties":{"autoInstall":{"type":"boolean","description":"determines whether the Jamf Protect agent will be automatically installed on client computers","nullable":false,"example":true}}},"ProvisioningProfileListCommand":{"allOf":[{"$ref":"#/components/schemas/MdmCommandBase"},{"type":"object","properties":{"managedOnly":{"type":"boolean","description":"If true, only managed provisioning profiles are returned. If false, all provisioning profiles are returned. The default value is false.","nullable":true,"example":true,"default":false}}}]},"PurchasingV2":{"type":"object","properties":{"purchased":{"type":"boolean","example":true},"leased":{"type":"boolean","example":false},"poNumber":{"type":"string","example":"8675309"},"vendor":{"type":"string","example":"Apple"},"appleCareId":{"type":"string","example":"9546567.0"},"purchasePrice":{"type":"string","example":"$399"},"purchasingAccount":{"type":"string","example":"IT Budget"},"poDate":{"type":"string","format":"date-time","example":"2019-02-04T21:09:31.661Z"},"warrantyExpiresDate":{"type":"string","format":"date-time","example":"2019-02-04T21:09:31.661Z"},"leaseExpiresDate":{"type":"string","format":"date-time","example":"2019-02-04T21:09:31.661Z"},"lifeExpectancy":{"type":"integer","example":7},"purchasingContact":{"type":"string","example":"Nick in IT"}}},"PutComputerPrestageV3":{"allOf":[{"$ref":"#/components/schemas/ComputerPrestageV3"},{"type":"object","properties":{"accountSettings":{"$ref":"#/components/schemas/AccountSettingsRequest"},"recoveryLockPassword":{"minLength":1,"type":"string","format":"password","writeOnly":true,"example":"password123"},"versionLock":{"minimum":0,"type":"integer","example":0}}}]},"PutMobileDevicePrestageV2":{"allOf":[{"$ref":"#/components/schemas/MobileDevicePrestageV2"},{"type":"object","properties":{"versionLock":{"type":"integer","example":0}}}]},"PutMobileDevicePrestageV3":{"allOf":[{"$ref":"#/components/schemas/MobileDevicePrestageV3"},{"type":"object","properties":{"versionLock":{"type":"integer","example":0}}}]},"RecalculationResults":{"type":"object","properties":{"count":{"type":"integer","example":3}}},"RedeployJamfManagementFrameworkResponse":{"type":"object","properties":{"deviceId":{"type":"string","example":"1"},"commandUuid":{"type":"string","example":"f5965c4f-0db4-4dc4-9f37-6f1dad4e939c"}}},"Reenrollment":{"required":["flushMDMQueue"],"type":"object","properties":{"isFlushPolicyHistoryEnabled":{"type":"boolean","default":false},"isFlushLocationInformationEnabled":{"type":"boolean","default":false},"isFlushLocationInformationHistoryEnabled":{"type":"boolean","default":false},"isFlushExtensionAttributesEnabled":{"type":"boolean","default":false},"isFlushSoftwareUpdatePlansEnabled":{"type":"boolean","default":false},"flushMDMQueue":{"type":"string","example":"DELETE_EVERYTHING_EXCEPT_ACKNOWLEDGED","enum":["DELETE_NOTHING","DELETE_ERRORS","DELETE_EVERYTHING_EXCEPT_ACKNOWLEDGED","DELETE_EVERYTHING"]}}},"RefreshCellularPlansCommand":{"allOf":[{"$ref":"#/components/schemas/MdmCommandBase"},{"required":["esimServerUrl"],"type":"object","properties":{"esimServerUrl":{"maxLength":2048,"minLength":1,"type":"string","description":"The URL of the eSIM server that the device should contact to refresh cellular plans.","example":"https://esim.example.com"}}}]},"RemoteAdministrationResponse":{"type":"object","properties":{"id":{"minimum":1,"type":"string","example":"1"},"siteId":{"type":"string","example":"1"},"displayName":{"type":"string","example":"Remote administration"},"type":{"type":"string","example":"team-viewer","enum":["team-viewer"]}},"description":"A Remote administration response"},"RemoteAdministrationSearchResults":{"type":"object","properties":{"totalCount":{"type":"integer","example":1},"results":{"type":"array","items":{"$ref":"#/components/schemas/RemoteAdministrationResponse"}}},"description":"A list with Remote administration configurations"},"RemoveComputerMdmProfileResponse":{"type":"object","properties":{"deviceId":{"type":"string","description":"Id of the computer whose MDM profile was removed","example":"1234"},"commandUuid":{"type":"string","description":"Uuid of the command queued that removes the MDM profile","example":"1234-5678-90ab-cdef-1234567890ab"}}},"RenewMdmProfileResponse":{"type":"object","properties":{"udidsNotProcessed":{"$ref":"#/components/schemas/Udids"}}},"RequestMirroringCommand":{"allOf":[{"$ref":"#/components/schemas/MdmCommandBase"},{"type":"object","properties":{"destinationDeviceId":{"type":"string","description":"The hardware address of the destination device to which the screen will be mirrored. This value isn’t case-sensitive. Required if destinationName is not provided.","example":"xx:xx:xx:xx:xx"},"destinationName":{"type":"string","description":"The name of the destination device to which the screen will be mirrored. Required if destinationDeviceId is not provided.","example":"airplay name"},"password":{"type":"string","description":"The screen-sharing password used to connect to the destination device.","format":"password","nullable":true,"writeOnly":true,"example":"password123"},"scanTime":{"type":"integer","description":"The scan time which device spends in seconds to find the destination device.","nullable":true,"example":30}}}]},"RestartDeviceCommand":{"allOf":[{"$ref":"#/components/schemas/MdmCommandBase"},{"type":"object","properties":{"rebuildKernelCache":{"type":"boolean","example":true},"kextPaths":{"type":"array","description":"Only used if RebuildKernelCache is true","example":["extension1","extension2"],"items":{"type":"string"}},"notifyUser":{"type":"boolean","example":true}}}]},"RetentionPolicyV1":{"type":"object","properties":{"displayName":{"type":"string","readOnly":true,"example":"Policy Logs"},"qualifier":{"type":"string","readOnly":true,"example":"policy"},"retentionPeriod":{"type":"integer","nullable":false,"example":3},"retentionPeriodUnit":{"type":"string","description":"The unit of the retention period (eg: DAY, WEEK, MONTH, YEAR)","nullable":false,"example":"MONTH"}}},"ReturnToService":{"required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","example":true},"mdmProfileData":{"type":"string","description":"Base64 encoded mdm profile","example":"PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPCFET0NUWVBFIHBsaXN0IFBVQkxJQyAiLS8vQXBwbGUvL0RURCBQTElTVCAxLjAvL0VOIiAiaHR0cDovL3d3dy5hcHBsZS5jb20vRFREcy9Qcm9wZXJ0eUxpc3QtMS4wLmR0ZCI+CjxwbGlzdCB2ZXJzaW9uPSIxIj4KICAgIDxkaWN0PgogICAgICAgIDxrZXk+UGF5bG9hZFVVSUQ8L2tleT4KICAgICAgICA8c3RyaW5nPjAwMDAwMDAwLTAwMDAtMDAwMC1BMDAwLTRBNDE0RDQ2MDAwMzwvc3RyaW5nPgogICAgICAgIDxrZXk+UGF5bG9hZFR5cGU8L2tleT4KICAgICAgICA8c3RyaW5nPkNvbmZpZ3VyYXRpb248L3N0cmluZz4KICAgICAgICA8a2V5PlBheWxvYWRPcmdhbml6YXRpb248L2tleT4KICAgICAgICA8c3RyaW5nPkphbWYgUHJvPC9zdHJpbmc+CiAgICAgICAgPGtleT5QYXlsb2FkSWRlbnRpZmllcjwva2V5PgogICAgICAgIDxzdHJpbmc+MDAwMDAwMDAtMDAwMC0wMDAwLUEwMDAtNEE0MTRENDYwMDAzPC9zdHJpbmc+CiAgICAgICAgPGtleT5QYXlsb2FkRGlzcGxheU5hbWU8L2tleT4KICAgICAgICA8c3RyaW5nPk1ETSBQcm9maWxlPC9zdHJpbmc+CiAgICAgICAgPGtleT5QYXlsb2FkRGVzY3JpcHRpb248L2tleT4KICAgICAgICA8c3RyaW5nPk1ETSBQcm9maWxlIGZvciBtb2JpbGUgZGV2aWNlIG1hbmFnZW1lbnQ8L3N0cmluZz4KICAgICAgICA8a2V5PlBheWxvYWRWZXJzaW9uPC9rZXk+CiAgICAgICAgPGludGVnZXI+MTwvaW50ZWdlcj4KICAgICAgICA8a2V5PlBheWxvYWRFbmFibGVkPC9rZXk+CiAgICAgICAgPHRydWUgLz4KICAgICAgICA8a2V5PlBheWxvYWRSZW1vdmFsRGlzYWxsb3dlZDwva2V5PgogICAgICAgIDxmYWxzZSAvPgogICAgICAgIDxrZXk+UGF5bG9hZENvbnRlbnQ8L2tleT4KICAgICAgICA8YXJyYXk+CiAgICAgICAgICAgIDxkaWN0PgogICAgICAgICAgICAgICAgPGtleT5QYXlsb2FkVVVJRDwva2V5PgogICAgICAgICAgICAgICAgPHN0cmluZz5FQjA1RURCNy04MzYxLTQ1N0ItQjUyOC0wQjFCMjU2QTY2QUY8L3N0cmluZz4KICAgICAgICAgICAgICAgIDxrZXk+UGF5bG9hZFR5cGU8L2tleT4KICAgICAgICAgICAgICAgIDxzdHJpbmc+Y29tLmFwcGxlLnNlY3VyaXR5LnJvb3Q8L3N0cmluZz4KICAgICAgICAgICAgICAgIDxrZXk+UGF5bG9hZE9yZ2FuaXphdGlvbjwva2V5PgogICAgICAgICAgICAgICAgPHN0cmluZz5KYW1mIFBybzwvc3RyaW5nPgogICAgICAgICAgICAgICAgPGtleT5QYXlsb2FkSWRlbnRpZmllcjwva2V5PgogICAgICAgICAgICAgICAgPHN0cmluZz5FQjA1RURCNy04MzYxLTQ1N0ItQjUyOC0wQjFCMjU2QTY2QUY8L3N0cmluZz4KICAgICAgICAgICAgICAgIDxrZXk+UGF5bG9hZERpc3BsYXlOYW1lPC9rZXk+CiAgICAgICAgICAgICAgICA8c3RyaW5nPkNOPUphbWYgUHJvIEpTUyBCdWlsdC1pbiBDZXJ0aWZpY2F0ZSBBdXRob3JpdHk8L3N0cmluZz4KICAgICAgICAgICAgICAgIDxrZXk+UGF5bG9hZERlc2NyaXB0aW9uPC9rZXk+CiAgICAgICAgICAgICAgICA8c3RyaW5nPkEgUm9vdCBDQSBDZXJ0aWZpY2F0ZTwvc3RyaW5nPgogICAgICAgICAgICAgICAgPGtleT5QYXlsb2FkVmVyc2lvbjwva2V5PgogICAgICAgICAgICAgICAgPGludGVnZXI+MTwvaW50ZWdlcj4KICAgICAgICAgICAgICAgIDxrZXk+UGF5bG9hZEVuYWJsZWQ8L2tleT4KICAgICAgICAgICAgICAgIDx0cnVlIC8+CiAgICAgICAgICAgICAgICA8a2V5PlBheWxvYWRDZXJ0aWZpY2F0ZUZpbGVOYW1lPC9rZXk+CiAgICAgICAgICAgICAgICA8c3RyaW5nPkNOPUphbWYgUHJvIEpTUyBCdWlsdC1pbiBDZXJ0aWZpY2F0ZSBBdXRob3JpdHk8L3N0cmluZz4KICAgICAgICAgICAgICAgIDxrZXk+UGF5bG9hZENvbnRlbnQ8L2tleT4KICAgICAgICAgICAgICAgIDxkYXRhPgogICAgICAgICAgICAgICAgICAgIHBheWxvYWRDb250ZW50CiAgICAgICAgICAgICAgICA8L2RhdGE+CiAgICAgICAgICAgICAgICA8a2V5PkFsbG93QWxsQXBwc0FjY2Vzczwva2V5PgogICAgICAgICAgICAgICAgPGZhbHNlIC8+CiAgICAgICAgICAgIDwvZGljdD4KICAgICAgICAgICAgPGRpY3Q+CiAgICAgICAgICAgICAgICA8a2V5PlBheWxvYWRVVUlEPC9rZXk+CiAgICAgICAgICAgICAgICA8c3RyaW5nPjAwMDAwMDAwLTAwMDAtMDAwMC1BMDAwLTRBNDE0RDQ2MDAwNjwvc3RyaW5nPgogICAgICAgICAgICAgICAgPGtleT5QYXlsb2FkVHlwZTwva2V5PgogICAgICAgICAgICAgICAgPHN0cmluZz5jb20uYXBwbGUuc2VjdXJpdHkuc2NlcDwvc3RyaW5nPgogICAgICAgICAgICAgICAgPGtleT5QYXlsb2FkT3JnYW5pemF0aW9uPC9rZXk+CiAgICAgICAgICAgICAgICA8c3RyaW5nPkphbWYgUHJvPC9zdHJpbmc+CiAgICAgICAgICAgICAgICA8a2V5PlBheWxvYWRJZGVudGlmaWVyPC9rZXk+CiAgICAgICAgICAgICAgICA8c3RyaW5nPmNvbS5qYW1mc29mdHdhcmUuZW5jcnlwdGVkLXByb2ZpbGUtc2VydmljZS1zY2VwMjwvc3RyaW5nPgogICAgICAgICAgICAgICAgPGtleT5QYXlsb2FkRGlzcGxheU5hbWU8L2tleT4KICAgICAgICAgICAgICAgIDxzdHJpbmc+SkFNRiBFbnJvbGxtZW50IFBheWxvYWQ6IFNDRVA8L3N0cmluZz4KICAgICAgICAgICAgICAgIDxrZXk+UGF5bG9hZERlc2NyaXB0aW9uPC9rZXk+CiAgICAgICAgICAgICAgICA8c3RyaW5nPkNvbmZpZ3VyYXRpb24gdG8gY29ubmVjdCB0byB5b3VyIFNDRVAgU2VydmVyPC9zdHJpbmc+CiAgICAgICAgICAgICAgICA8a2V5PlBheWxvYWRWZXJzaW9uPC9rZXk+CiAgICAgICAgICAgICAgICA8aW50ZWdlcj4xPC9pbnRlZ2VyPgogICAgICAgICAgICAgICAgPGtleT5QYXlsb2FkRW5hYmxlZDwva2V5PgogICAgICAgICAgICAgICAgPHRydWUgLz4KICAgICAgICAgICAgICAgIDxrZXk+UGF5bG9hZENvbnRlbnQ8L2tleT4KICAgICAgICAgICAgICAgIDxkaWN0PgogICAgICAgICAgICAgICAgICAgIDxrZXk+VVJMPC9rZXk+CiAgICAgICAgICAgICAgICAgICAgPHN0cmluZz5odHRwczovL2pzcy51cmwvQ0EvU0NFUDwvc3RyaW5nPgogICAgICAgICAgICAgICAgICAgIDxrZXk+Q2hhbGxlbmdlPC9rZXk+CiAgICAgICAgICAgICAgICAgICAgPHN0cmluZz4wMDAwMDwvc3RyaW5nPgogICAgICAgICAgICAgICAgICAgIDxrZXk+S2V5IFR5cGU8L2tleT4KICAgICAgICAgICAgICAgICAgICA8c3RyaW5nPlJTQTwvc3RyaW5nPgogICAgICAgICAgICAgICAgICAgIDxrZXk+S2V5IFVzYWdlPC9rZXk+CiAgICAgICAgICAgICAgICAgICAgPGludGVnZXI+NTwvaW50ZWdlcj4KICAgICAgICAgICAgICAgICAgICA8a2V5PktleXNpemU8L2tleT4KICAgICAgICAgICAgICAgICAgICA8aW50ZWdlcj4yMDQ4PC9pbnRlZ2VyPgogICAgICAgICAgICAgICAgICAgIDxrZXk+U3ViamVjdDwva2V5PgogICAgICAgICAgICAgICAgICAgIDxhcnJheT4KICAgICAgICAgICAgICAgICAgICAgICAgPGFycmF5PgogICAgICAgICAgICAgICAgICAgICAgICAgICAgPGFycmF5PgogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIDxzdHJpbmc+Tzwvc3RyaW5nPgogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIDxzdHJpbmc+SmFtZiBQcm88L3N0cmluZz4KICAgICAgICAgICAgICAgICAgICAgICAgICAgIDwvYXJyYXk+CiAgICAgICAgICAgICAgICAgICAgICAgIDwvYXJyYXk+CiAgICAgICAgICAgICAgICAgICAgICAgIDxhcnJheT4KICAgICAgICAgICAgICAgICAgICAgICAgICAgIDxhcnJheT4KICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICA8c3RyaW5nPkNOPC9zdHJpbmc+CiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgPHN0cmluZz40RkY0QzJEQi0wRDhDLTREQjEtODUyNi04RTFGQUQ3ODg4RTQ8L3N0cmluZz4KICAgICAgICAgICAgICAgICAgICAgICAgICAgIDwvYXJyYXk+CiAgICAgICAgICAgICAgICAgICAgICAgIDwvYXJyYXk+CiAgICAgICAgICAgICAgICAgICAgPC9hcnJheT4KICAgICAgICAgICAgICAgIDwvZGljdD4KICAgICAgICAgICAgPC9kaWN0PgogICAgICAgICAgICA8ZGljdD4KICAgICAgICAgICAgICAgIDxrZXk+QWNjZXNzUmlnaHRzPC9rZXk+CiAgICAgICAgICAgICAgICA8aW50ZWdlcj44MTkxPC9pbnRlZ2VyPgogICAgICAgICAgICAgICAgPGtleT5DaGVja0luVVJMPC9rZXk+CiAgICAgICAgICAgICAgICA8c3RyaW5nPgogICAgICAgICAgICAgICAgICAgIGh0dHBzOi8vanNzLnVybC9tZG0vQ2hlY2tJblVSTD9pbnZpdGF0aW9uPTI4MzY5MDc2MzU4NzI1MjExMzI4MzE0ODcxNjEyNjI2MzkxMzQxOTwvc3RyaW5nPgogICAgICAgICAgICAgICAgPGtleT5DaGVja091dFdoZW5SZW1vdmVkPC9rZXk+CiAgICAgICAgICAgICAgICA8dHJ1ZSAvPgogICAgICAgICAgICAgICAgPGtleT5JZGVudGl0eUNlcnRpZmljYXRlVVVJRDwva2V5PgogICAgICAgICAgICAgICAgPHN0cmluZz4wMDAwMDAwMC0wMDAwLTAwMDAtQTAwMC00QTQxNEQ0NjAwMDY8L3N0cmluZz4KICAgICAgICAgICAgICAgIDxrZXk+UGF5bG9hZERlc2NyaXB0aW9uPC9rZXk+CiAgICAgICAgICAgICAgICA8c3RyaW5nPkNvbmZpZ3VyYXRpb24gdG8gY29ubmVjdCB0byB5b3VyIE1ETSBTZXJ2ZXI8L3N0cmluZz4KICAgICAgICAgICAgICAgIDxrZXk+UGF5bG9hZERpc3BsYXlOYW1lPC9rZXk+CiAgICAgICAgICAgICAgICA8c3RyaW5nPkpBTUYgTWFudWFsIEVucm9sbG1lbnQgUGF5bG9hZDogTURNPC9zdHJpbmc+CiAgICAgICAgICAgICAgICA8a2V5PlBheWxvYWRFbmFibGVkPC9rZXk+CiAgICAgICAgICAgICAgICA8dHJ1ZSAvPgogICAgICAgICAgICAgICAgPGtleT5QYXlsb2FkSWRlbnRpZmllcjwva2V5PgogICAgICAgICAgICAgICAgPHN0cmluZz4wMDAwMDAwMC0wMDAwLTAwMDAtQTAwMC00QTQxNEQ0NjAwMDQ8L3N0cmluZz4KICAgICAgICAgICAgICAgIDxrZXk+UGF5bG9hZE9yZ2FuaXphdGlvbjwva2V5PgogICAgICAgICAgICAgICAgPHN0cmluZz5KYW1mIFBybzwvc3RyaW5nPgogICAgICAgICAgICAgICAgPGtleT5QYXlsb2FkVHlwZTwva2V5PgogICAgICAgICAgICAgICAgPHN0cmluZz5jb20uYXBwbGUubWRtPC9zdHJpbmc+CiAgICAgICAgICAgICAgICA8a2V5PlBheWxvYWRVVUlEPC9rZXk+CiAgICAgICAgICAgICAgICA8c3RyaW5nPjAwMDAwMDAwLTAwMDAtMDAwMC1BMDAwLTRBNDE0RDQ2MDAwNDwvc3RyaW5nPgogICAgICAgICAgICAgICAgPGtleT5QYXlsb2FkVmVyc2lvbjwva2V5PgogICAgICAgICAgICAgICAgPGludGVnZXI+MTwvaW50ZWdlcj4KICAgICAgICAgICAgICAgIDxrZXk+U2VydmVyVVJMPC9rZXk+CiAgICAgICAgICAgICAgICA8c3RyaW5nPmh0dHBzOi8vanNzLnVybC9tZG0vU2VydmVyVVJMPC9zdHJpbmc+CiAgICAgICAgICAgICAgICA8a2V5PlNpZ25NZXNzYWdlPC9rZXk+CiAgICAgICAgICAgICAgICA8dHJ1ZSAvPgogICAgICAgICAgICAgICAgPGtleT5Ub3BpYzwva2V5PgogICAgICAgICAgICAgICAgPHN0cmluZz5jb20uYXBwbGUubWdtdC5FeHRlcm5hbC5hYWFhYWFhYS1hYWFhLWFhYWEtYWFhLWFhYWFhYWE8L3N0cmluZz4KICAgICAgICAgICAgICAgIDxrZXk+VXNlRGV2ZWxvcG1lbnRBUE5TPC9rZXk+CiAgICAgICAgICAgICAgICA8ZmFsc2UgLz4KICAgICAgICAgICAgICAgIDxrZXk+U2VydmVyQ2FwYWJpbGl0aWVzPC9rZXk+CiAgICAgICAgICAgICAgICA8YXJyYXk+CiAgICAgICAgICAgICAgICAgICAgPHN0cmluZz5jb20uYXBwbGUubWRtLnBlci11c2VyLWNvbm5lY3Rpb25zPC9zdHJpbmc+CiAgICAgICAgICAgICAgICA8L2FycmF5PgogICAgICAgICAgICA8L2RpY3Q+CiAgICAgICAgPC9hcnJheT4KICAgIDwvZGljdD4KPC9wbGlzdD4="},"wifiProfileData":{"type":"string","description":"Base64 encoded wifi profile","example":"PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPCFET0NUWVBFIHBsaXN0IFBVQkxJQyAiLS8vQXBwbGUvL0RURCBQTElTVCAxLjAvL0VOIiAiaHR0cDovL3d3dy5hcHBsZS5jb20vRFREcy9Qcm9wZXJ0eUxpc3QtMS4wLmR0ZCI+CjxwbGlzdCB2ZXJzaW9uPSIxLjAiPgo8ZGljdD4KCTxrZXk+UGF5bG9hZENvbnRlbnQ8L2tleT4KCTxhcnJheT4KCQk8ZGljdD4KCQkJPGtleT5BdXRvSm9pbjwva2V5PgoJCQk8dHJ1ZS8+CgkJCTxrZXk+Q2FwdGl2ZUJ5cGFzczwva2V5PgoJCQk8ZmFsc2UvPgoJCQk8a2V5PkRpc2FibGVBc3NvY2lhdGlvbk1BQ1JhbmRvbWl6YXRpb248L2tleT4KCQkJPGZhbHNlLz4KCQkJPGtleT5FbmNyeXB0aW9uVHlwZTwva2V5PgoJCQk8c3RyaW5nPldQQTwvc3RyaW5nPgoJCQk8a2V5PkhJRERFTl9ORVRXT1JLPC9rZXk+CgkJCTxmYWxzZS8+CgkJCTxrZXk+SXNIb3RzcG90PC9rZXk+CgkJCTxmYWxzZS8+CgkJCTxrZXk+UGFzc3dvcmQ8L2tleT4KCQkJPHN0cmluZz53aWZpUGFzc3dvcmQ8L3N0cmluZz4KCQkJPGtleT5QYXlsb2FkRGVzY3JpcHRpb248L2tleT4KCQkJPHN0cmluZz5Db25maWd1cmVzIFdpLUZpIHNldHRpbmdzPC9zdHJpbmc+CgkJCTxrZXk+UGF5bG9hZERpc3BsYXlOYW1lPC9rZXk+CgkJCTxzdHJpbmc+V2ktRmk8L3N0cmluZz4KCQkJPGtleT5QYXlsb2FkSWRlbnRpZmllcjwva2V5PgoJCQk8c3RyaW5nPmNvbS5hcHBsZS53aWZpLm1hbmFnZWQuRDA1QzhDQzQtMzNGNi00OEVFLUEwNzMtM0M1M0VGOTExQUIzPC9zdHJpbmc+CgkJCTxrZXk+UGF5bG9hZFR5cGU8L2tleT4KCQkJPHN0cmluZz5jb20uYXBwbGUud2lmaS5tYW5hZ2VkPC9zdHJpbmc+CgkJCTxrZXk+UGF5bG9hZFVVSUQ8L2tleT4KCQkJPHN0cmluZz5EMDVDOENDNC0zM0Y2LTQ4RUUtQTA3My0zQzUzRUY5MTFBQjM8L3N0cmluZz4KCQkJPGtleT5QYXlsb2FkVmVyc2lvbjwva2V5PgoJCQk8aW50ZWdlcj4xPC9pbnRlZ2VyPgoJCQk8a2V5PlByb3h5VHlwZTwva2V5PgoJCQk8c3RyaW5nPk5vbmU8L3N0cmluZz4KCQkJPGtleT5TU0lEX1NUUjwva2V5PgoJCQk8c3RyaW5nPlNTSUQ8L3N0cmluZz4KCQk8L2RpY3Q+Cgk8L2FycmF5PgoJPGtleT5QYXlsb2FkRGlzcGxheU5hbWU8L2tleT4KCTxzdHJpbmc+VW50aXRsZWQ8L3N0cmluZz4KCTxrZXk+UGF5bG9hZElkZW50aWZpZXI8L2tleT4KCTxzdHJpbmc+Y29yZXkuODcxOUQ0RTktQTYxMy00OTg4LTlFQjctOUYzNzdGMEUwMEMwPC9zdHJpbmc+Cgk8a2V5PlBheWxvYWRSZW1vdmFsRGlzYWxsb3dlZDwva2V5PgoJPGZhbHNlLz4KCTxrZXk+UGF5bG9hZFR5cGU8L2tleT4KCTxzdHJpbmc+Q29uZmlndXJhdGlvbjwvc3RyaW5nPgoJPGtleT5QYXlsb2FkVVVJRDwva2V5PgoJPHN0cmluZz42MkZGQzZBRC1GMDFDLTRENzQtQUIwQS1EMEM0N0QzQjdBMDc8L3N0cmluZz4KCTxrZXk+UGF5bG9hZFZlcnNpb248L2tleT4KCTxpbnRlZ2VyPjE8L2ludGVnZXI+CjwvZGljdD4KPC9wbGlzdD4="},"bootstrapToken":{"type":"string","description":"Base64 encoded bootstrap token for the device.","example":"HPZC3p80IWb3XgD51W7hhUxWNwKElvvEgCgjegI="}},"description":"The configuration settings for Return to Service."},"ReturnToServiceConfiguration":{"type":"object","properties":{"id":{"minimum":1,"type":"string","description":"Id of the Return to Service Configuration.","nullable":false,"example":"1"},"displayName":{"type":"string","nullable":false,"example":"displayName","default":"false"},"wifiProfileId":{"type":"string","description":"Id of the wifi profile that is associated with the return to service configuration.","nullable":false,"example":"1"}}},"ReturnToServiceConfigurationRequest":{"type":"object","properties":{"displayName":{"type":"string","description":"Display name of the Return to Service Configuration.","nullable":false,"example":"displayName","default":"false"},"wifiProfileId":{"type":"string","description":"Id of the wifi profile that is associated with the return to service configuration.","nullable":false,"example":"1"}}},"ReturnToServiceConfigurationSearchResults":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":1},"results":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/ReturnToServiceConfiguration"}}}},"SafelistedApp":{"type":"object","properties":{"name":{"type":"string","example":"Content Filter"},"bundleId":{"type":"string","example":"com.jamf.parent"}}},"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}}},"SchedulerJob":{"type":"object","properties":{"totalCount":{"type":"integer","example":1},"results":{"type":"array","items":{"$ref":"#/components/schemas/SchedulerTrigger"}}},"readOnly":true},"SchedulerJobs":{"type":"object","properties":{"jobKeys":{"type":"array","items":{"type":"string","example":"EXAMPLE_JOB"}}},"readOnly":true},"SchedulerSummary":{"type":"object","properties":{"numberOfPendingJobs":{"type":"integer","example":1},"numberOfExecutingJobs":{"type":"integer","example":1},"numberOfExecutedJobs":{"type":"integer","example":1},"started":{"type":"boolean","example":true}},"readOnly":true},"SchedulerTrigger":{"type":"object","properties":{"triggerKey":{"type":"string","example":"EXAMPLE_TRIGGER"},"previousFireTime":{"type":"string","format":"date-time","example":"2023-08-21T21:20:34.35Z"},"nextFireTime":{"type":"string","format":"date-time","example":"2023-08-21T21:30:34.35Z"}},"readOnly":true},"Script":{"required":["name"],"type":"object","properties":{"id":{"minLength":1,"type":"string","readOnly":true,"example":"1"},"name":{"type":"string","example":"Install Developer Utils Script"},"info":{"type":"string","example":"Installs utilities for developers"},"notes":{"type":"string","example":"Should be able to be re-run without problem."},"priority":{"type":"string","example":"AFTER","enum":["BEFORE","AFTER","AT_REBOOT"]},"categoryId":{"type":"string","example":"1"},"categoryName":{"type":"string","example":"Developer Tools"},"parameter4":{"type":"string","example":"1"},"parameter5":{"type":"string","example":"2"},"parameter6":{"type":"string","example":"3"},"parameter7":{"type":"string","example":"4"},"parameter8":{"type":"string","example":"5"},"parameter9":{"type":"string","example":"6"},"parameter10":{"type":"string","example":"7"},"parameter11":{"type":"string","example":"8"},"osRequirements":{"type":"string","example":"10.10.x"},"scriptContents":{"type":"string","example":"echo \"Trivial script.\""}}},"ScriptsSearchResults":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":3},"results":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/Script"}}}},"SecurityInfoCommand":{"allOf":[{"$ref":"#/components/schemas/MdmCommandBase"},{"type":"object"}]},"SecurityV2":{"type":"object","properties":{"dataProtected":{"type":"boolean","example":false},"blockLevelEncryptionCapable":{"type":"boolean","example":true},"fileLevelEncryptionCapable":{"type":"boolean","example":true},"passcodePresent":{"type":"boolean","example":false},"passcodeCompliant":{"type":"boolean","example":true},"passcodeCompliantWithProfile":{"type":"boolean","example":true},"hardwareEncryption":{"type":"integer","example":3},"activationLockEnabled":{"type":"boolean","example":false},"jailBreakDetected":{"type":"boolean","example":false},"attestationStatus":{"type":"string","readOnly":true,"example":"SUCCESS","enum":["PENDING","SUCCESS","CERTIFICATE_INVALID","DEVICE_PROPERTIES_MISMATCH","MDA_UNSUPPORTED_DUE_TO_HARDWARE","MDA_UNSUPPORTED_DUE_TO_SOFTWARE"]},"lastAttestationAttemptDate":{"type":"string","format":"date-time","readOnly":true,"example":"2019-02-04T21:09:31.661Z"},"lastSuccessfulAttestationDate":{"type":"string","format":"date-time","readOnly":true,"example":"2019-02-04T21:09:31.661Z"},"bootstrapToken":{"type":"string","description":"The bootstrap token for the device","readOnly":true,"example":"dGVzdCB0b2tlbg=="},"bootstrapTokenEscrowed":{"type":"string","description":"Indicates the bootstrap token escrow status for the device","example":"NOT_SUPPORTED","enum":["ESCROWED","NOT_ESCROWED","NOT_SUPPORTED"]},"lockdownModeEnabled":{"type":"boolean","description":"Whether Lockdown Mode is enabled.","example":false}}},"SelfServiceInstallSettings":{"required":["installLocation"],"type":"object","properties":{"installAutomatically":{"type":"boolean","description":"true if Self Service is installed automatically, false if not\n","default":false},"installLocation":{"type":"string","description":"path at which Self Service is installed. Required if installAutomatically is true\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":{"minimum":-4,"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"},"SelfServicePlusSettings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether Self Service Plus is enabled","nullable":false,"example":true}}},"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"},"ServiceDiscoveryVersion":{"type":"string","description":"Service discovery enrollment version","example":"mdm-byod","enum":["none","mdm-byod","mdm-adde"]},"Session":{"type":"object","properties":{"currentSiteId":{"type":"integer","example":1}}},"SessionCandidateRequest":{"required":["description","deviceId","deviceType"],"type":"object","properties":{"deviceId":{"type":"string","description":"Device identifier","example":"1"},"deviceType":{"type":"string","description":"Device type","example":"COMPUTER","enum":["COMPUTER"]},"description":{"maxLength":255,"minLength":0,"type":"string","description":"Session description. To be used for additional context on the reason of the session","example":"Customer reported that he cannot install application X"}},"description":"Request to crate new remote session. Ultimately this allows connection between an admin and an end-user"},"SessionDetails":{"type":"object","properties":{"id":{"type":"string","description":"Session identifier","example":"1"},"code":{"type":"string","description":"Sessions code","example":"s1234-5678"},"description":{"type":"string","description":"Session description. To be used for additional context on the reason of the session","example":"Customer reported that he cannot install application X"},"supporterLink":{"type":"string","description":"Supporter session URL","example":"https://get.teamviewer.com/v15/en/s12345678-a1b2c3d4e5f6"},"endUserLink":{"type":"string","description":"End user session URL","example":"https://get.teamviewer.com/v15/en/s12345678"},"deviceId":{"type":"string","description":"Device identifier","example":"1"},"deviceName":{"type":"string","description":"Device name if found - null otherwise","example":"Przemek MacBook Pro"},"deviceType":{"type":"string","description":"Device type","example":"COMPUTER","enum":["COMPUTER"]},"state":{"type":"string","description":"Session state","example":"OPEN","enum":["OPEN","CLOSED","UNKNOWN"]},"creatorId":{"type":"string","description":"ID of session creator if session created by Jamf Pro local user, null otherwise","example":"1"},"creatorName":{"type":"string","description":"Username of the session creator","example":"creator"},"createdAt":{"type":"string","description":"Session creation time","format":"date-time","example":"2021-06-10T12:00:00Z"}},"description":"Session details"},"SessionDetailsSearchResults":{"type":"object","properties":{"totalCount":{"type":"integer","example":1},"results":{"type":"array","items":{"$ref":"#/components/schemas/SessionDetails"}}},"description":"Sessions search result"},"SessionHistoryItem":{"type":"object","properties":{"tenantId":{"type":"string","nullable":false,"example":"ee5d0ffae49e675d32ba5bdb2ce25182e958b979afc8d210c924d725bbf45f8b"},"sessionId":{"type":"string","nullable":false,"example":"c4087bc8-cb48-4452-9bec-a3c50088a485"},"deviceId":{"type":"string","example":"aeafd2ff95c7e0b937a8dbf3121a8dcab7a70161cd4493af038fa9c784b61866"},"sessionStartedTimestamp":{"type":"string","format":"date-time","example":"2023-11-07T10:25:27.49Z"},"sessionEndedTimestamp":{"type":"string","format":"date-time","example":"2023-11-07T10:25:27.49Z"},"sessionType":{"type":"string","example":"ATTENDED","enum":["ATTENDED","UNATTENDED"]},"statusType":{"type":"string","example":"STARTED","enum":["STARTED","FINISHED","ERROR"]},"sessionAdminId":{"type":"string","example":"sessionAdminId1"},"comment":{"type":"string","example":"Example comment"}}},"SessionHistoryItemDetails":{"type":"object","properties":{"fileTransferItemList":{"type":"array","nullable":false,"items":{"$ref":"#/components/schemas/FileTransferItem"}}}},"SessionHistoryItemWithDetails":{"type":"object","properties":{"tenantId":{"type":"string","nullable":false,"example":"ee5d0ffae49e675d32ba5bdb2ce25182e958b979afc8d210c924d725bbf45f8b"},"sessionId":{"type":"string","nullable":false,"example":"c4087bc8-cb48-4452-9bec-a3c50088a485"},"deviceId":{"type":"string","example":"aeafd2ff95c7e0b937a8dbf3121a8dcab7a70161cd4493af038fa9c784b61866"},"sessionStartedTimestamp":{"type":"string","format":"date-time","example":"2023-11-07T10:25:27.49Z"},"sessionEndedTimestamp":{"type":"string","format":"date-time","example":"2023-11-07T10:25:27.49Z"},"sessionType":{"type":"string","example":"ATTENDED","enum":["ATTENDED","UNATTENDED"]},"statusType":{"type":"string","example":"STARTED","enum":["STARTED","FINISHED","ERROR"]},"sessionAdminId":{"type":"string","example":"sessionAdminId1"},"comment":{"type":"string","example":"Example comment"},"details":{"$ref":"#/components/schemas/SessionHistoryItemDetails"}}},"SessionHistorySearchResults":{"required":["results","totalCount"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/SessionHistoryItem"}},"totalCount":{"type":"integer","example":100}}},"SessionStatus":{"type":"object","properties":{"sessionState":{"type":"string","description":"Session state","example":"OPEN","enum":["OPEN","CLOSED","UNKNOWN"]},"online":{"type":"boolean","description":"Defines if the end user is online","example":true}},"description":"Session status"},"SetAutoAdminPasswordCommand":{"allOf":[{"$ref":"#/components/schemas/MdmCommandBase"},{"type":"object","properties":{"guid":{"type":"string","description":"The unique identifier of the local administrator account. Must match the GUID of an administrator account that MDM created during Device Enrollment Program (DEP) enrollment.","example":"76d765f1-651b-4032-9eea-a10e09a62d50"},"password":{"minLength":1,"type":"string","description":"The new password for the local administrator account.","format":"password","writeOnly":true,"example":"newQuerty1234"}}}]},"SetRecoveryLockCommand":{"allOf":[{"$ref":"#/components/schemas/MdmCommandBase"},{"type":"object","properties":{"newPassword":{"type":"string","description":"The new password for Recovery Lock. Set as an empty string to clear the Recovery Lock password.","format":"password","example":"newQuerty1234"}}}]},"SettingsCommand":{"allOf":[{"$ref":"#/components/schemas/MdmCommandBase"},{"type":"object","properties":{"bootstrapTokenAllowed":{"type":"boolean","description":"Deprecated - BootstrapTokenAllowed is automatically managed by macOS 11 and later. This field will continue to function but is no longer necessary.","nullable":true,"example":true,"deprecated":true},"bluetooth":{"type":"boolean","nullable":true,"example":true},"appAnalytics":{"$ref":"#/components/schemas/AppAnalyticsSetting"},"diagnosticSubmission":{"$ref":"#/components/schemas/DiagnosticSubmissionSetting"},"dataRoaming":{"$ref":"#/components/schemas/DataRoamingSetting"},"defaultApplications":{"$ref":"#/components/schemas/DefaultApplications"},"voiceRoaming":{"$ref":"#/components/schemas/VoiceRoamingSetting"},"personalHotspot":{"$ref":"#/components/schemas/PersonalHotspotSetting"},"maximumResidentUsers":{"type":"integer","nullable":true,"example":1},"deviceName":{"type":"string","example":"My iPhone"},"applicationAttributes":{"$ref":"#/components/schemas/ApplicationAttributes"},"sharedDeviceConfiguration":{"$ref":"#/components/schemas/SharedDeviceConfiguration"},"applicationConfiguration":{"$ref":"#/components/schemas/ApplicationConfiguration"},"timeZone":{"type":"string","nullable":true,"example":"America/New_York"},"softwareUpdateSettings":{"$ref":"#/components/schemas/SoftwareUpdateSettings"},"passcodeLockGracePeriod":{"type":"integer","description":"The number of seconds before a locked screen requires the user to enter the device passcode to unlock it. (Shared iPad Only)","nullable":true,"example":60},"activationLockAllowedWhileSupervised":{"type":"boolean","description":"If true, a supervised device registers itself with Activation Lock when the user enables Find My. This setting is available for supervised devices in iOS 7 and later, and macOS 10.15 and later.","example":true}}}]},"SharedDeviceComplianceFeatureToggle":{"required":["sharedDeviceFeatureEnabled"],"type":"object","properties":{"sharedDeviceFeatureEnabled":{"type":"boolean","nullable":false,"example":false}},"nullable":false},"SharedDeviceConfiguration":{"type":"object","properties":{"quotaSize":{"type":"integer","nullable":true,"example":2048},"residentUsers":{"type":"integer","example":3}}},"ShutDownDeviceCommand":{"allOf":[{"$ref":"#/components/schemas/MdmCommandBase"},{"type":"object"}]},"Signature":{"type":"object","properties":{"algorithm":{"type":"string","example":"SHA256withRSA"},"algorithmOid":{"type":"string","example":"1.2.840.113549.1.1.11"},"value":{"type":"string","example":"6874f9b8c60a46c25b6b270c14b9a2949c87b25524868394309b20349f95edd624588ada274e5678a921199d26d0fe5b231fc794eb6e020b7a6c4790cf91ec5d9a5bd4da126f141a657cf4af78df6303327964c57721d82b85af1d46379ac7ec45a24ae3418576688f05fd075a1c9c3d137d0fd8831f4c88ce7698af9c747db983a40fb0480ebfb293bf4889e34a949d4a53251b1abef19d895bcea8e0ce590b22244ad1623624319e6a8b7e7d11aea3d94b77be1a94d28fda58e8df2e398c45e2e9c13473dcc81db01acac8f2c6d21cb5c44371c9ebfba632dcb46838a91808d4e82a35500f370dc71f4156528fbce93137c94eb33d83d41d49483d4dcca5e1"}}},"Site":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Eau Claire"}}},"SiteObject":{"required":["objectId","objectType","siteId"],"type":"object","properties":{"siteId":{"type":"string","example":"1"},"objectType":{"type":"string","example":"User","enum":["Computer","Peripheral","Licensed Software","Licensed Software Template","Policy","macOS Configuration Profile","Restricted Software","Managed Preference Profile","Computer Group","Mobile Device","Apple TV","User Group","iOS Configuration Profile","Mobile Device App","E-book","Mobile Device Group","Classroom","Advanced Computer Search","Advanced Mobile Search","Advanced User Search","Advanced User Content Search","Computer Invitation","Mobile Device Invitation","Mobile Device Enrollment Profile","Device Enrollment Program Instance","Mobile Device Prestage","Computer DEP Prestage","Enrollment Customization","VPP Location","VPP Subscription","VPP Invitation","VPP Assignment","User","Network Integration","Mac App","App Installer","Self Service Plugin","Software Title","Patch Software Title Summary","Patch Policy","Patch Software Title Configuration","Change Password","Mobile Device Inventory","Computer Inventory","Change Management","Licensed Software License","Unknown"]},"objectId":{"type":"string","example":"1"}}},"SlasaAcceptance":{"type":"object","properties":{"slasaAcceptanceStatus":{"type":"string","nullable":false,"example":"ACCEPTED","enum":["ACCEPTED","NOT_ACCEPTED"]}}},"SmartComputerGroupSearch":{"type":"object","properties":{"id":{"minLength":1,"type":"string","readOnly":true,"example":"1"},"siteId":{"minLength":1,"type":"string","readOnly":true,"example":"1"},"name":{"minLength":1,"type":"string","example":"My computer group"},"description":{"minLength":0,"type":"string","example":"My computer group description"},"membershipCount":{"type":"integer","example":231}}},"SmartComputerGroupV2":{"required":["name"],"type":"object","properties":{"name":{"type":"string","example":"New Group Name"},"description":{"type":"string","example":"New Group Description"},"criteria":{"type":"array","items":{"$ref":"#/components/schemas/SmartSearchCriterion"}},"siteId":{"type":"string","nullable":true,"example":"-1"}}},"SmartComputerGroupV3":{"required":["name"],"type":"object","properties":{"name":{"maxLength":255,"type":"string","example":"New Group Name"},"description":{"type":"string","example":"New Group Description"},"criteria":{"type":"array","items":{"$ref":"#/components/schemas/ComputerSmartGroupCriteriaV2"}},"siteId":{"type":"string","nullable":true,"example":"-1"}}},"SmartGroup":{"type":"object","properties":{"groupId":{"type":"string","example":"1"},"groupName":{"type":"string","example":"Smart iPad Group"},"groupDescription":{"type":"string","example":"A smart group containing iPads meeting certain criteria"},"siteId":{"type":"string","example":"-1"},"count":{"minimum":0,"type":"integer","description":"membership count","example":25}}},"SmartGroupAssignment":{"required":["groupName"],"type":"object","properties":{"groupId":{"minLength":1,"type":"string","description":"The unique identifier of the smart group","readOnly":true,"example":"7"},"groupName":{"minLength":1,"type":"string","example":"Smart iPads Group"},"groupDescription":{"type":"string","example":"Smart iPads that meet certain criteria"},"siteId":{"type":"string","example":"11"},"criteria":{"type":"array","items":{"$ref":"#/components/schemas/SmartGroupCriteria"}}}},"SmartGroupAssignmentV2":{"required":["groupName"],"type":"object","properties":{"groupId":{"minLength":1,"type":"string","description":"The unique identifier of the smart group","readOnly":true,"example":"7"},"groupName":{"maxLength":255,"minLength":1,"type":"string","example":"Smart iPads Group"},"groupDescription":{"type":"string","example":"Smart iPads that meet certain criteria"},"siteId":{"type":"string","example":"-1"},"criteria":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceSmartGroupCriteriaV2"}}}},"SmartGroupCriteria":{"required":["andOr","name","priority","searchType","value"],"type":"object","properties":{"name":{"maxLength":255,"type":"string","description":"The field to search on (e.g., Model, OS Version, etc.)","example":"Model"},"priority":{"minimum":0,"type":"integer","description":"The priority order of this criterion","nullable":false,"example":1},"andOr":{"minLength":1,"type":"string","description":"Whether this criterion should be ANDed or ORed with the previous criterion","example":"and"},"searchType":{"minLength":1,"type":"string","description":"The type of search to perform (e.g., is, is not, like, etc.)","example":"is"},"value":{"type":"string","description":"The value to search for","example":"iPad"},"openingParen":{"type":"boolean","description":"Whether to add an opening parenthesis before this criterion","example":false},"closingParen":{"type":"boolean","description":"Whether to add a closing parenthesis after this criterion","example":false}},"description":"V1 criteria format with string andOr field"},"SmartGroupDetail":{"allOf":[{"$ref":"#/components/schemas/SmartGroup"},{"type":"object","properties":{"criteria":{"minLength":0,"type":"array","description":"The criteria used to define the smart group","items":{"$ref":"#/components/schemas/SmartGroupCriteria"}}}}]},"SmartGroupDetailV2":{"allOf":[{"$ref":"#/components/schemas/SmartGroup"},{"type":"object","properties":{"criteria":{"minLength":0,"type":"array","description":"The criteria used to define the smart group","items":{"$ref":"#/components/schemas/MobileDeviceSmartGroupCriteriaV2"}}}}]},"SmartGroupMembership":{"type":"object","properties":{"members":{"minLength":0,"type":"array","example":[1,2,3],"items":{"type":"integer"}}},"description":"the ids of the computers that are members of the smart group"},"SmartGroupSearchResult":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":3},"results":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/SmartComputerGroupSearch"}}}},"SmartGroupSearchResults":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":2},"results":{"type":"array","items":{"$ref":"#/components/schemas/SmartGroup"}}}},"SmartSearchCriterion":{"required":["andOr","name","searchType","value"],"type":"object","properties":{"name":{"type":"string","example":"Account"},"priority":{"type":"integer","example":0},"andOr":{"type":"string","example":"and"},"searchType":{"type":"string","example":"is"},"value":{"type":"string","example":"test"},"openingParen":{"type":"boolean","example":false},"closingParen":{"type":"boolean","example":false}}},"SmtpAuthenticationTypeList":{"required":["allowedAuthenticationTypes"],"type":"object","properties":{"allowedAuthenticationTypes":{"type":"array","example":["GRAPH_API","GOOGLE_MAIL"],"items":{"type":"string","enum":["NONE","BASIC","GRAPH_API","GOOGLE_MAIL"]}}}},"SmtpBasicCredentials":{"required":["password","username"],"type":"object","properties":{"username":{"type":"string","example":"exampleEmail@example.com","default":""},"password":{"type":"string","format":"password","writeOnly":true,"default":""}}},"SmtpConnectionSettings":{"required":["connectionTimeout","encryptionType","host","port"],"type":"object","properties":{"host":{"type":"string","example":"abcd.server.com","default":""},"port":{"type":"integer","example":25,"default":25},"encryptionType":{"type":"string","example":"SSL","enum":["NONE","SSL","TLS_1_2","TLS_1_1","TLS_1","TLS_1_3"],"default":"NONE"},"connectionTimeout":{"type":"integer","example":5,"default":5}}},"SmtpGoogleMailAuthentication":{"required":["emailAddress","status"],"type":"object","properties":{"emailAddress":{"type":"string","example":"exampleEmail@example.com","default":""},"status":{"type":"string","readOnly":true,"example":"AUTHENTICATED","enum":["FAILED","UNAUTHENTICATED","AUTHENTICATED"]}}},"SmtpGoogleMailCredentials":{"required":["clientId","clientSecret"],"type":"object","properties":{"clientId":{"type":"string","example":"012345678901-abcdefghijklmnopqrstuvwxyz123456.apps.googleusercontent.com","default":""},"clientSecret":{"type":"string","format":"password","writeOnly":true,"default":""},"authentications":{"type":"array","items":{"$ref":"#/components/schemas/SmtpGoogleMailAuthentication"}}}},"SmtpGraphApiCredentials":{"required":["clientId","clientSecret","tenantId"],"type":"object","properties":{"tenantId":{"type":"string","example":"c84b7b82-c277-411b-975d-7431b4ce40ac","default":""},"clientId":{"type":"string","example":"5294f9d1-f723-419c-93db-ff040bf7c947","default":""},"clientSecret":{"type":"string","format":"password","writeOnly":true,"default":""}}},"SmtpSenderSettings":{"required":["emailAddress"],"type":"object","properties":{"displayName":{"type":"string","example":"Jamf Pro Server","default":"Jamf Pro Server"},"emailAddress":{"type":"string","example":"exampleEmail@example.com","default":""}}},"SmtpServerTest":{"required":["recipientEmail"],"type":"object","properties":{"recipientEmail":{"type":"string","nullable":false,"example":"exampleEmail@example.com"}}},"SmtpServerV2":{"required":["authenticationType","enabled","senderSettings"],"type":"object","properties":{"enabled":{"type":"boolean","example":true,"default":false},"authenticationType":{"type":"string","description":"The authentication type to use for the SMTP server. Note that NONE and BASIC may not be available depending on the server configuration. Check allowedAuthenticationTypes for the list of currently supported values.\n","example":"NONE","enum":["NONE","BASIC","GRAPH_API","GOOGLE_MAIL"]},"connectionSettings":{"$ref":"#/components/schemas/SmtpConnectionSettings"},"senderSettings":{"$ref":"#/components/schemas/SmtpSenderSettings"},"basicAuthCredentials":{"$ref":"#/components/schemas/SmtpBasicCredentials"},"graphApiCredentials":{"$ref":"#/components/schemas/SmtpGraphApiCredentials"},"googleMailCredentials":{"$ref":"#/components/schemas/SmtpGoogleMailCredentials"}}},"SoftwareTitleConfigurationOnDashboard":{"type":"object","properties":{"onDashboard":{"type":"boolean","nullable":false,"example":true}}},"SoftwareUpdateSettings":{"type":"object","properties":{"recommendationCadence":{"type":"string","example":"ALLOW_ALL_UPDATES","enum":["ALLOW_ALL_UPDATES","ONLY_ALLOW_LEAST_CURRENT_UPDATE","ONLY_ALLOW_MOST_CURRENT_UPDATE"]}}},"SsoFailoverData":{"type":"object","properties":{"failoverUrl":{"type":"string","example":"https://jamf.jamfcloud.com/?failover=0123456789ABCDEF"},"generationTime":{"minimum":0,"type":"integer","description":"Generation time of failover key","format":"int64","example":1674133253000}}},"SsoKeystore":{"allOf":[{"$ref":"#/components/schemas/SsoKeystoreParse"},{"required":["key","password","type"],"type":"object","properties":{"keys":{"type":"array","items":{"$ref":"#/components/schemas/CertificateKey"}},"key":{"type":"string","default":" "},"password":{"type":"string","format":"password","writeOnly":true,"example":"***"},"type":{"type":"string","example":"PKCS12","enum":["PKCS12","JKS","NONE"]},"keystoreSetupType":{"type":"string","example":"UPLOADED","enum":["NONE","UPLOADED","GENERATED"]}}}]},"SsoKeystoreCertParseResponse":{"type":"object","properties":{"key":{"type":"string","default":" "},"keys":{"type":"array","items":{"$ref":"#/components/schemas/CertificateKey"}},"type":{"type":"string","example":"PKCS12","enum":["PKCS12","JKS","NONE"]},"keystoreSetupType":{"type":"string","example":"UPLOADED","enum":["NONE","UPLOADED","GENERATED"]},"keystoreFile":{"type":"array","example":"ZXhhbXBsZSBvZiBhIGJhc2U2NCBlbmNvZGVkIHZhbGlkIHAxMi4ga2V5c3RvcmUgZmlsZQ==","items":{"pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$","type":"string","format":"byte"}},"keystoreFileName":{"type":"string","example":"keystore.p12"}}},"SsoKeystoreDetails":{"type":"object","properties":{"keys":{"type":"array","items":{"type":"string","default":""}},"serialNumber":{"type":"integer","example":2322472237},"subject":{"type":"string","example":"CN=SSO:jamf.com, OU=JSS, O=JAMF Software, L=Minneapolis, ST=MN, C=US"},"issuer":{"type":"string","example":"CN= Jamf Pro JSS Built-in Certificate Authority"},"expiration":{"type":"string","example":"2030-02-24T12:18:32.000"}}},"SsoKeystoreParse":{"required":["keystoreFile","keystoreFileName","keystorePassword"],"type":"object","properties":{"keystorePassword":{"type":"string","format":"password","writeOnly":true,"example":"***"},"keystoreFile":{"pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$","type":"string","format":"byte","example":"WlhoaGJYQnNaU0J2WmlCaElHSmhjMlUyTkNCbGJtTnZaR1ZrSUhaaGJHbGtJSEF4TWk0Z2EyVjVjM1J2Y21VZ1ptbHNaUT09"},"keystoreFileName":{"type":"string","example":"keystore.p12"}},"discriminator":{"propertyName":"certType"}},"SsoKeystoreResponse":{"type":"object","properties":{"key":{"type":"string","default":" "},"keys":{"type":"array","items":{"$ref":"#/components/schemas/CertificateKey"}},"type":{"type":"string","example":"PKCS12","enum":["PKCS12","JKS","NONE"]},"keystoreSetupType":{"type":"string","example":"UPLOADED","enum":["NONE","UPLOADED","GENERATED"]},"keystoreFileName":{"type":"string","example":"keystore.p12"}}},"SsoKeystoreResponseWithDetails":{"type":"object","properties":{"keystore":{"$ref":"#/components/schemas/SsoKeystoreResponse"},"keystoreDetails":{"$ref":"#/components/schemas/SsoKeystoreDetails"}}},"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":" "}}},"StartupStatus":{"type":"object","properties":{"step":{"type":"string","example":"Initializing"},"stepCode":{"type":"string","example":"SERVER_INIT_START","enum":["SERVER_INIT_START","SERVER_INIT_ANALYZING_WEBAPP","SERVER_INIT_POPULATING_NAVIGATION","SERVER_INIT_POPULATING_OBJECTS","SERVER_INIT_INITIALIZING_OBJ","SERVER_INIT_VERIFYING_CACHE","SERVER_INIT_INITIALIZING_CHANGE_MANAGEMENT","SERVER_INIT_INITIALIZING_COMMUNICATION_SYSTEM","SERVER_INIT_INITIALIZING_MDM_QUEUE_MONITOR","SERVER_INIT_CALCULATING_SMART_GROUPS","SERVER_INIT_DB_SCHEMA_COMPARE","SERVER_INIT_DB_TABLE_CHECK_FOR_RENAME","SERVER_INIT_DB_TABLE_ALTER","SERVER_INIT_DB_TABLE_ANALYZING","SERVER_INIT_DB_TABLE_CREATE","SERVER_INIT_DB_TABLE_DROP","SERVER_INIT_DB_TABLE_RENAME","SERVER_INIT_DB_COLUMN_RENAME","SERVER_INIT_DB_COLUMN_ENCODING_CHANGE_STEP_1","SERVER_INIT_DB_COLUMN_ENCODING_CHANGE_STEP_2","SERVER_INIT_DB_COLUMN_ENCODING_CHANGE_STEP_3","SERVER_INIT_DB_UPGRADE_CHECK","SERVER_INIT_DB_UPGRADE_COMPLETE","SERVER_INIT_SS_GENERATE_NOTIFICATIONS","SERVER_INIT_SS_GENERATE_NOTIFICATIONS_STATUS","SERVER_INIT_SS_GENERATE_NOTIFICATIONS_FINALIZE","SERVER_INIT_PKI_MIGRATION_DONE","SERVER_INIT_PKI_MIGRATION_STATUS","SERVER_INIT_MEMCACHED_ENDPOINTS_CHECK","SERVER_INIT_CACHE_FLUSHING","SERVER_INIT_COMPLETE"]},"stepParam":{"type":"string","nullable":true,"example":"buildings"},"percentage":{"type":"integer","example":50},"warning":{"type":"string","nullable":true,"example":"Converting buildings, do not restart your JSS"},"warningCode":{"type":"string","nullable":true,"example":"SERVER_INIT_WARNING_DB_TABLE_ENCODING","enum":["SERVER_INIT_WARNING_DB_TABLE_ENCODING"]},"warningParam":{"type":"string","nullable":true,"example":"13 MB"},"error":{"type":"string","nullable":true,"example":"Jamf Pro Startup Suspended"},"errorCode":{"type":"string","nullable":true,"example":"SERVER_INIT_ERROR_INITIALIZATION_FAILED","enum":["CACHE_CONFIGURATION_ERROR","SECONDARY_NODE_STARTUP_ERROR","MORE_THAN_ONE_CLUSTER_SETTINGS_ERROR","PRIMARY_NODE_NOT_SET_ERROR","DATABASE_ERROR","DATABASE_PASSWORD_MISSING","EHCACHE_ERROR","FLAG_INITIALIZATION_FAILED","MEMCACHED_ERROR","DATABASE_MYISAM_ERROR","OLD_VERSION_ERROR"]},"setupAssistantNecessary":{"type":"boolean","example":false}}},"StaticComputerGroup":{"required":["id","name"],"type":"object","properties":{"id":{"minLength":1,"type":"string","example":"1"},"name":{"minLength":1,"type":"string","example":"Test Static Computer Group"},"description":{"type":"string","nullable":true,"example":"A test static computer group"},"siteId":{"type":"string","nullable":true,"example":"-1"}}},"StaticComputerGroupAssignment":{"required":["name"],"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"1"},"name":{"maxLength":255,"minLength":1,"type":"string","example":"Test Static Computer Group"},"description":{"type":"string","nullable":true,"example":"A test static computer group"},"siteId":{"type":"string","nullable":true,"example":"-1"},"assignments":{"uniqueItems":true,"type":"array","description":"Set of computer IDs to assign to the static group","items":{"minLength":1,"type":"string","example":"1"}}}},"StaticComputerGroupSearchResults":{"required":["results","totalCount"],"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":2},"results":{"type":"array","items":{"$ref":"#/components/schemas/StaticComputerGroupSummary"}}}},"StaticComputerGroupSummary":{"required":["id","name"],"type":"object","properties":{"id":{"minLength":1,"type":"string","example":"1"},"name":{"minLength":1,"type":"string","example":"Test Static Computer Group"},"description":{"type":"string","nullable":true,"example":"A test static computer group"},"siteId":{"type":"string","nullable":true,"example":"-1"},"count":{"minimum":0,"type":"integer","example":5}}},"StaticGroup":{"type":"object","properties":{"groupId":{"type":"string","example":"6"},"groupName":{"type":"string","example":"Static iPad Group"},"groupDescription":{"type":"string","example":"A static group containing only iPads"},"siteId":{"type":"string","example":"-1"},"count":{"minimum":0,"type":"integer","description":"membership count","example":15}}},"StaticGroupAssignment":{"required":["groupName"],"type":"object","properties":{"groupId":{"minLength":1,"type":"string","readOnly":true,"example":"7"},"groupName":{"maxLength":255,"minLength":1,"type":"string","example":"Static iPads"},"groupDescription":{"type":"string","example":"Static iPads"},"siteId":{"type":"string","example":"-1"},"assignments":{"type":"array","items":{"$ref":"#/components/schemas/Assignment"}}}},"StaticGroupSearchResults":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":3},"results":{"type":"array","items":{"$ref":"#/components/schemas/StaticGroup"}}}},"StaticUserGroup":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Grade School Teachers"},"description":{"type":"string","example":"A group containing all grade school teachers"}}},"StatusItem":{"type":"object","properties":{"key":{"type":"string","description":"The StatusItem key","nullable":false,"example":"device.identifier.udid"},"value":{"type":"string","description":"The StatusItem value","nullable":false,"example":"00008103-000C51E402E2001E"},"lastUpdateTime":{"type":"string","description":"The local server time when the StatusItem was last updated","nullable":false,"example":"2024-08-25T21:09:31"}}},"StatusItems":{"type":"object","properties":{"statusItems":{"type":"array","nullable":false,"items":{"$ref":"#/components/schemas/StatusItem"},"default":[]}}},"StopMirroringCommand":{"allOf":[{"$ref":"#/components/schemas/MdmCommandBase"},{"type":"object"}]},"SupervisionIdentity":{"type":"object","properties":{"id":{"type":"integer","example":1},"displayName":{"type":"string","example":"Supervision Identity"},"commonName":{"type":"string","example":"Jamf Identity - Supervision Identity"},"expirationDate":{"type":"string","example":"2000-10-31"}}},"SupervisionIdentityCertificateUpload":{"required":["displayName","password"],"type":"object","properties":{"displayName":{"type":"string","example":"Supervision Identity"},"password":{"type":"string","format":"password","example":"jamf1234"},"certificateData":{"pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$","type":"string","description":"The base 64 encoded supervision identity certificate data","format":"byte","example":"VTI5dFpTQnlZVzVrYjIwZ1ltbDBJRzltSUhSbGVIUWdkRzhnZFhObElHRnVaQ0J6WldVZ2FXWWdZVzU1YjI1bElHRmpkSFZoYkd4NUlIUnlhV1Z6SUhSdklHUmxZMjlrWlNCcGRBPT0="}}},"SupervisionIdentityCreate":{"required":["displayName","password"],"type":"object","properties":{"displayName":{"type":"string","example":"Supervision Identity"},"password":{"type":"string","format":"password","example":"jamf1234"}}},"SupervisionIdentitySearchResults":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":1},"results":{"type":"array","items":{"$ref":"#/components/schemas/SupervisionIdentity"}}}},"SupervisionIdentityUpdate":{"required":["displayName"],"type":"object","properties":{"displayName":{"type":"string","example":"Supervision Identity"}}},"SystemHealthV2":{"type":"object","properties":{"baseband":{"maxLength":255,"type":"string","example":"ok"},"camera":{"maxLength":255,"type":"string","example":"ok"},"display":{"maxLength":255,"type":"string","example":"ok"},"faceId":{"maxLength":255,"type":"string","example":"ok"},"touchId":{"maxLength":255,"type":"string","example":"ok"},"nfc":{"maxLength":255,"type":"string","example":"ok"},"ultraWideband":{"maxLength":255,"type":"string","example":"ok"}},"description":"System health status for device components. Reported for iOS devices."},"TeacherFeatures":{"type":"object","properties":{"isAllowAppLock":{"type":"boolean","example":true},"isAllowWebLock":{"type":"boolean","example":true},"isAllowRestrictions":{"type":"boolean","example":true},"isAllowAttentionScreen":{"type":"boolean","example":true},"isAllowClearPasscode":{"type":"boolean","example":true}}},"TeacherSettingsRequest":{"type":"object","properties":{"isEnabled":{"type":"boolean","example":true},"timezoneId":{"type":"string","example":"Europe/Paris"},"autoClear":{"type":"string","nullable":true,"example":"05:30"},"maxRestrictionLengthSeconds":{"type":"integer","example":600},"safelistedApps":{"type":"array","items":{"$ref":"#/components/schemas/SafelistedApp"}}}},"TeacherSettingsResponse":{"type":"object","properties":{"isEnabled":{"type":"boolean","example":true},"timezoneId":{"type":"string","example":"Europe/Paris"},"autoClear":{"type":"string","example":"05:30"},"maxRestrictionLengthSeconds":{"type":"integer","example":600},"displayNameType":{"type":"string","example":"user"},"features":{"$ref":"#/components/schemas/TeacherFeatures"},"safelistedApps":{"type":"array","items":{"$ref":"#/components/schemas/SafelistedApp"}}}},"TimeFrame":{"type":"object","properties":{"beginTime":{"type":"string","example":"08:30:00"},"endTime":{"type":"string","example":"15:45:00"}}},"TimeZone":{"type":"object","properties":{"zoneId":{"type":"string","example":"America/Chicago"},"region":{"type":"string","example":"America","enum":["Africa","America","Asia","Atlantic","Australia","Europe","Indian","Pacific","None"]},"displayName":{"type":"string","example":"Chicago - CT (-0500)"}}},"TriggerEnhancedLogCollectionCommand":{"allOf":[{"$ref":"#/components/schemas/MdmCommandBase"},{"required":["appleCareToken"],"type":"object","properties":{"appleCareToken":{"minLength":1,"type":"string","description":"The AppleCare token the device uses for authenticating the enhanced log collection session.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"}}}]},"TvOsDetails":{"type":"object","properties":{"model":{"type":"string","example":"Apple TV 3rd Generation Rev 2"},"modelIdentifier":{"type":"string","example":"AppleTV3,2"},"modelNumber":{"type":"string","example":"MD199LL"},"supervised":{"type":"boolean","example":true},"airplayPassword":{"type":"string","format":"password","example":"1234"},"deviceId":{"type":"string","example":"1"},"locales":{"type":"string","example":"null"},"purchasing":{"$ref":"#/components/schemas/PurchasingV2"},"configurationProfiles":{"type":"array","items":{"$ref":"#/components/schemas/ConfigurationProfile"}},"certificates":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceCertificateV2"}},"applications":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceApplication"}}},"description":"will be populated if the type is appleTv."},"Udids":{"type":"object","properties":{"udids":{"type":"array","items":{"type":"string","example":"6E47EF55-5318-494F-A09E-70F613E0AFD1"}}}},"UnifiedSmartGroupCriteriaV2":{"required":["andOr","name","priority","searchType","value"],"type":"object","properties":{"name":{"minLength":1,"type":"string","description":"The field to search on (e.g., Model, OS Version, etc.)","example":"Model"},"priority":{"minimum":0,"type":"integer","description":"The priority order of this criterion","nullable":false,"example":1},"andOr":{"type":"string","description":"Whether this criterion should be ANDed or ORed with the previous criterion. Only \"and\" or \"or\" values are accepted (case-insensitive).","example":"and","enum":["and","or"]},"searchType":{"minLength":1,"type":"string","description":"The type of search to perform (e.g., is, is not, like, etc.)","example":"is"},"value":{"type":"string","description":"The value to search for","example":"iPad"},"openingParen":{"type":"boolean","description":"Whether to add an opening parenthesis before this criterion","example":false},"closingParen":{"type":"boolean","description":"Whether to add a closing parenthesis after this criterion","example":false}},"description":"V2 criteria format with strict enum validation for andOr field.\nOnly \"and\" or \"or\" values are accepted (case-insensitive).\n"},"UnlockUserAccountCommand":{"allOf":[{"$ref":"#/components/schemas/MdmCommandBase"},{"type":"object","properties":{"userName":{"type":"string","description":"The username of the user account to unlock","example":"user123"}}}]},"UnmanageMobileDeviceResponse":{"required":["commandUuid","deviceId"],"type":"object","properties":{"deviceId":{"type":"string","description":"Id of the mobile device whose MDM profile was removed","example":"1234"},"commandUuid":{"type":"string","description":"Uuid of the command queued that removes the MDM profile","example":"1234-5678-90ab-cdef-1234567890ab"}}},"UpdateIosV2":{"type":"object","properties":{"purchasing":{"$ref":"#/components/schemas/PurchasingV2"}}},"UpdateMobileDeviceV2":{"type":"object","properties":{"name":{"type":"string","description":"Mobile Device Name. When updated, Jamf Pro sends an MDM settings command to the device (device must be supervised).","example":"Jan's Mobile Device"},"enforceName":{"type":"boolean","description":"Enforce the mobile device name. Device must be supervised. If set to true, Jamf Pro will revert the Mobile Device Name to the ‘name’ value each time the device checks in.","example":true},"assetTag":{"type":"string","example":"8675309"},"siteId":{"type":"string","example":"1"},"timeZone":{"type":"string","description":"IANA time zone database name","example":"Europe/Warsaw"},"location":{"$ref":"#/components/schemas/LocationV2"},"updatedExtensionAttributes":{"type":"array","items":{"$ref":"#/components/schemas/ExtensionAttributeV2"}},"ios":{"$ref":"#/components/schemas/UpdateIosV2"},"tvos":{"$ref":"#/components/schemas/UpdateTvOs"}}},"UpdateTvOs":{"type":"object","properties":{"airplayPassword":{"type":"string","format":"password","example":"12345"},"purchasing":{"$ref":"#/components/schemas/PurchasingV2"}}},"User":{"allOf":[{"$ref":"#/components/schemas/UserInventory"},{"type":"object","properties":{"id":{"minLength":1,"type":"string","readOnly":true,"example":"1"}}}]},"UserAccount":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"1"},"plainPassword":{"type":"string","format":"password","writeOnly":true,"example":"testpassword4321"},"username":{"type":"string","example":"testusername"},"realname":{"type":"string","example":"Bob Jones"},"email":{"type":"string","example":"bob@jamf.com"},"phone":{"type":"string","example":"715-999-9999"},"ldapServerId":{"type":"integer","example":-1,"default":-1},"distinguishedName":{"type":"string","example":""},"siteId":{"type":"integer","example":-1,"default":-1},"accessLevel":{"type":"string","description":"Access level for the account","enum":["FullAccess","SiteAccess","GroupBasedAccess"],"default":"FullAccess"},"privilegeLevel":{"type":"string","description":"Privilege level for the account","enum":["ADMINISTRATOR","AUDITOR","ENROLLMENT","CUSTOM"],"default":"ADMINISTRATOR"},"lastPasswordChange":{"type":"string","format":"date-time","readOnly":true,"example":"2017-07-21T17:32:28Z"},"changePasswordOnNextLogin":{"type":"boolean","example":true},"failedLoginAttempts":{"type":"integer","readOnly":true,"example":0},"accountStatus":{"type":"string","description":"Status of the account","enum":["Enabled","Disabled"],"default":"Enabled"},"accountType":{"type":"string","description":"Type of the account","enum":["DEFAULT","FEDERATED","MIGRATED"],"default":"DEFAULT"}}},"UserAccountSearchResults":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","description":"Total number of user accounts matching the filter criteria","example":1},"results":{"minItems":0,"type":"array","description":"The collection of user accounts for the requested page","items":{"$ref":"#/components/schemas/UserAccount"}}}},"UserInventory":{"type":"object","properties":{"username":{"type":"string","example":"jsmith"},"realname":{"type":"string","example":"John Smith"},"email":{"type":"string","example":"john.smith@example.com"},"phone":{"type":"string","nullable":true,"example":"555-123-4567"},"position":{"type":"string","nullable":true,"example":"IT Manager"},"enableCustomPhotoUrl":{"type":"boolean","example":false},"customPhotoUrl":{"type":"string","example":"https://example.com/photo.jpg"},"managedAppleId":{"type":"string","example":"john@example.com"}}},"UserMappings":{"required":["building","department","emailAddress","objectClassLimitation","objectClasses","phone","position","realName","room","searchBase","searchScope","userID","userUuid","username"],"type":"object","properties":{"objectClassLimitation":{"type":"string","example":"ANY_OBJECT_CLASSES","enum":["ANY_OBJECT_CLASSES","ALL_OBJECT_CLASSES"]},"objectClasses":{"type":"string","example":"inetOrgPerson"},"searchBase":{"type":"string","example":"ou=Users"},"searchScope":{"type":"string","example":"ALL_SUBTREES","enum":["ALL_SUBTREES","FIRST_LEVEL_ONLY"]},"additionalSearchBase":{"type":"string","default":""},"userID":{"type":"string","example":"mail"},"username":{"type":"string","example":"uid"},"realName":{"type":"string","example":"displayName"},"emailAddress":{"type":"string","example":"mail"},"department":{"type":"string","example":"departmentNumber"},"building":{"type":"string","default":""},"room":{"type":"string","default":""},"phone":{"type":"string","default":""},"position":{"type":"string","example":"title"},"userUuid":{"type":"string","example":"uid"}},"description":"Cloud Identity Provider user mappings configuration"},"UserPreferencesJson":{"type":"object","description":"Valid JSON of any client-desired structure"},"UserPreferencesSettings":{"required":["key","username","values"],"type":"object","properties":{"username":{"type":"string","example":"jamfuser"},"key":{"type":"string","example":"mobileDeviceDisplayHeadings"},"values":{"type":"array","description":"List of preferences for the specific key and user.","items":{"type":"string","example":"Device name"}}},"description":"Response object."},"UserTestAttributes":{"type":"object","properties":{"fullName":{"type":"string","example":"Bob"},"emailAddress":{"type":"string","example":"bob@jamf.com"},"phoneNumber":{"type":"string","example":"123456789"},"position":{"type":"string","example":"SE"},"room":{"type":"string","example":"1"},"buildingName":{"type":"string","example":"Jamf"},"departmentName":{"type":"string","example":"Engineering"}}},"UserTestSearch":{"type":"object","properties":{"distinguishedName":{"type":"string","example":"uid=admin,ou=Users,dc=jamf,dc=com"},"id":{"type":"string","example":"admin@jamf.com"},"uuid":{"type":"string","example":"admin"},"serverId":{"type":"string","example":"1001"},"name":{"type":"string","example":"admin"},"attributes":{"$ref":"#/components/schemas/UserTestAttributes"}}},"UserTestSearchRequest":{"required":["username"],"type":"object","properties":{"username":{"type":"string","example":"admin"}}},"UserTestSearchResponse":{"type":"object","properties":{"totalCount":{"type":"integer","example":1},"results":{"type":"array","items":{"$ref":"#/components/schemas/UserTestSearch"}}}},"V1Site":{"type":"object","properties":{"id":{"type":"string","example":"1"},"divisionId":{"type":"string","description":"Platform division identifier (UUID) for this site.","nullable":true,"example":"550e8400-e29b-41d4-a716-446655440000"},"name":{"type":"string","example":"Eau Claire"}}},"V1SiteBase":{"type":"object","properties":{"id":{"type":"string","example":"1"},"divisionId":{"type":"string","description":"Platform division identifier (UUID) for this site.","nullable":true,"example":"550e8400-e29b-41d4-a716-446655440000"},"name":{"type":"string","example":"Eau Claire"}}},"ValidateApplicationsCommand":{"allOf":[{"$ref":"#/components/schemas/MdmCommandBase"},{"type":"object"}]},"VenafiCaRecord":{"required":["name"],"type":"object","properties":{"id":{"type":"integer","readOnly":true,"example":4},"name":{"type":"string","example":"Venafi Certificate Authority"},"proxyAddress":{"type":"string","example":"localhost:9443"},"revocationEnabled":{"type":"boolean","example":true},"clientId":{"type":"string","example":"jamf-pro"},"refreshToken":{"type":"string","writeOnly":true,"example":"qdkP4SrCFKd7tefAVM6N"},"refreshTokenConfigured":{"type":"boolean","readOnly":true,"example":true}}},"VenafiPkiPayloadRecord":{"type":"object","properties":{"urlPath":{"type":"string","example":"OSXConfigurationProfile.html?id=1"},"name":{"type":"string","example":"Configuration Profile Name"}}},"VenafiPkiPayloadRecordSearchResults":{"type":"object","properties":{"totalCount":{"minimum":0,"type":"integer","example":3},"results":{"type":"array","items":{"$ref":"#/components/schemas/VenafiPkiPayloadRecord"}}}},"VenafiServiceStatus":{"type":"object","properties":{"status":{"type":"string","readOnly":true,"example":"Successfully connected"}}},"VerbosePackageDeploymentResponse":{"type":"object","properties":{"queuedCommands":{"type":"array","items":{"type":"object","properties":{"device":{"type":"integer","example":1},"commandUuid":{"type":"string","example":"aaaaaaaa-3f1e-4b3a-a5b3-ca0cd7430937"}}}},"errors":{"type":"array","items":{"type":"object","properties":{"device":{"type":"integer","example":2},"group":{"type":"integer","example":3},"reason":{"type":"string","example":"Device does not support the InstallEnterpriseApplication command"}},"description":"The error will contain either the 'device' or 'group' property"}}}},"VerifyRecoveryLockCommand":{"allOf":[{"$ref":"#/components/schemas/MdmCommandBase"},{"type":"object","properties":{"password":{"minLength":1,"type":"string","description":"The password to verify.","format":"password","writeOnly":true,"example":"password123"}}}]},"VoiceRoamingSetting":{"type":"string","example":"ENABLE_VOICE_ROAMING","enum":["ENABLE_VOICE_ROAMING","DISABLE_VOICE_ROAMING"]},"VolumePurchasingContent":{"type":"object","properties":{"name":{"type":"string","readOnly":true,"example":"Example Content"},"licenseCountTotal":{"type":"integer","readOnly":true,"example":1},"licenseCountInUse":{"type":"integer","readOnly":true,"example":1},"licenseCountReported":{"type":"integer","readOnly":true,"example":1},"iconUrl":{"type":"string","readOnly":true,"example":"https://is4-ssl.mzstatic.com/image/thumb/Purple113/v4/73/d4/73/73d47332-fefc-d350-2984-5b4a4755a502/AppIcon-0-1x_U007emarketing-0-0-GLES2_U002c0-512MB-sRGB-0-0-0-85-220-0-0-0-6.png/360x216bb.png"},"deviceTypes":{"type":"array","readOnly":true,"items":{"type":"string","example":"IOS","enum":["IOS","MACOS","TVOS"]}},"contentType":{"type":"string","readOnly":true,"example":"IOS_APP","enum":["IOS_APP","MAC_APP","BOOK","UNKNOWN"]},"pricingParam":{"type":"string","readOnly":true,"example":"STDQ","enum":["STDQ","PLUS","Unknown"]},"adamId":{"type":"string","readOnly":true,"example":"748057890"}}},"VolumePurchasingContentList":{"type":"object","properties":{"totalCount":{"type":"integer","example":1},"results":{"type":"array","items":{"$ref":"#/components/schemas/VolumePurchasingContent"}}}},"VolumePurchasingLocation":{"allOf":[{"$ref":"#/components/schemas/VolumePurchasingLocationListView"},{"type":"object","properties":{"content":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/VolumePurchasingContent"}}}}]},"VolumePurchasingLocationListView":{"type":"object","properties":{"name":{"type":"string","example":"Example Location"},"totalPurchasedLicenses":{"type":"integer","readOnly":true,"example":1},"totalUsedLicenses":{"type":"integer","readOnly":true,"example":1},"id":{"type":"string","readOnly":true,"example":"1"},"appleId":{"type":"string","readOnly":true,"example":"testUser@appleId.com"},"email":{"type":"string","readOnly":true,"example":"testUser@email.com"},"organizationName":{"type":"string","readOnly":true,"example":"Jamf"},"tokenExpiration":{"type":"string","readOnly":true,"example":"2022-04-25T21:09:31.661Z"},"countryCode":{"type":"string","description":"The two-letter ISO 3166-1 code that designates the country where the Volume Purchasing account is located.","readOnly":true,"example":"US"},"locationName":{"type":"string","readOnly":true,"example":"Example Location"},"clientContextMismatch":{"type":"boolean","description":"If this is \"true\", the clientContext used by this server does not match the clientContext returned by the Volume Purchasing API.","readOnly":true,"example":false},"automaticallyPopulatePurchasedContent":{"type":"boolean","example":false},"sendNotificationWhenNoLongerAssigned":{"type":"boolean","example":false},"autoRegisterManagedUsers":{"type":"boolean","example":false},"siteId":{"type":"string","example":"1"},"siteName":{"type":"string","example":"Example Name"},"lastSyncTime":{"type":"string","readOnly":true,"example":"2022-09-25T21:09:31.661Z"}}},"VolumePurchasingLocationPatch":{"type":"object","properties":{"name":{"type":"string","nullable":false,"example":"Example Location"},"automaticallyPopulatePurchasedContent":{"type":"boolean","nullable":false,"example":false},"sendNotificationWhenNoLongerAssigned":{"type":"boolean","nullable":false,"example":false},"autoRegisterManagedUsers":{"type":"boolean","example":false,"default":false},"siteId":{"type":"string","nullable":false,"example":"1"},"serviceToken":{"type":"string","nullable":false,"example":"eyJleHBEYXRlIjoiMjAyMi0wMy0yOVQxNTozNjoyNiswMDAwIiwidG9rZW4iOiJWR2hwY3lCcGN5QnViM1FnWVNCMGIydGxiaTRnU0c5d1pXWjFiR3g1SUdsMElHeHZiMnR6SUd4cGEyVWdZU0IwYjJ0bGJpd2dZblYwSUdsMEozTWdibTkwTGc9PSIsIm9yZ05hbWUiOiJFeGFtcGxlIE9yZyJ9"}}},"VolumePurchasingLocationPost":{"required":["serviceToken"],"type":"object","properties":{"name":{"type":"string","description":"If no value is provided when creating a VolumePurchasingLocation object, the 'name' will default to the 'locationName' value","example":"Example Location"},"automaticallyPopulatePurchasedContent":{"type":"boolean","example":false,"default":false},"sendNotificationWhenNoLongerAssigned":{"type":"boolean","example":false,"default":false},"autoRegisterManagedUsers":{"type":"boolean","example":false,"default":false},"siteId":{"type":"string","example":"1","default":"-1"},"serviceToken":{"type":"string","example":"eyJleHBEYXRlIjoiMjAyMi0wMy0yOVQxNTozNjoyNiswMDAwIiwidG9rZW4iOiJWR2hwY3lCcGN5QnViM1FnWVNCMGIydGxiaTRnU0c5d1pXWjFiR3g1SUdsMElHeHZiMnR6SUd4cGEyVWdZU0IwYjJ0bGJpd2dZblYwSUdsMEozTWdibTkwTGc9PSIsIm9yZ05hbWUiOiJFeGFtcGxlIE9yZyJ9"}}},"VolumePurchasingLocations":{"type":"object","properties":{"totalCount":{"type":"integer","example":1},"results":{"type":"array","items":{"$ref":"#/components/schemas/VolumePurchasingLocationListView"}}}},"VolumePurchasingSubscription":{"allOf":[{"$ref":"#/components/schemas/VolumePurchasingSubscriptionBase"},{"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"1"}}}]},"VolumePurchasingSubscriptionBase":{"required":["name"],"type":"object","properties":{"name":{"minLength":1,"type":"string","example":"Example"},"enabled":{"type":"boolean","example":true,"default":true},"triggers":{"type":"array","items":{"type":"string","example":"NO_MORE_LICENSES","enum":["NO_MORE_LICENSES","REMOVED_FROM_APP_STORE"]}},"locationIds":{"type":"array","items":{"pattern":"^\\d+$","type":"string","example":"1"}},"internalRecipients":{"type":"array","items":{"$ref":"#/components/schemas/InternalRecipient"}},"externalRecipients":{"type":"array","items":{"$ref":"#/components/schemas/ExternalRecipient"}},"siteId":{"type":"string","example":"1","default":"-1"}}},"VolumePurchasingSubscriptions":{"type":"object","properties":{"totalCount":{"type":"integer","example":1},"results":{"type":"array","items":{"$ref":"#/components/schemas/VolumePurchasingSubscription"}}}},"WatchOsDetailsV2":{"type":"object","properties":{"model":{"type":"string","example":"Apple Watch Ultra"},"modelIdentifier":{"type":"string","example":"Watch6,18"},"modelNumber":{"type":"string","example":"A2622"},"supervised":{"type":"boolean","example":true},"batteryLevel":{"type":"integer","example":100},"capacityMb":{"type":"integer","example":27503},"availableMb":{"type":"integer","example":26646},"percentageUsed":{"type":"integer","example":3},"deviceLocatorServiceEnabled":{"type":"boolean","example":false},"doNotDisturbEnabled":{"type":"boolean","example":false},"lastCloudBackupTimestamp":{"type":"string","format":"date-time","example":"2018-10-15T16:39:56.307Z"},"iTunesStoreAccountActive":{"type":"boolean","example":false},"bleCapable":{"type":"boolean","example":false},"unlockToken":{"type":"string","example":"VU5MT0NLVE9LRU4="},"security":{"$ref":"#/components/schemas/SecurityV2"},"applications":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceApplication"}},"certificates":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceCertificateV2"}},"configurationProfiles":{"type":"array","items":{"$ref":"#/components/schemas/ConfigurationProfile"}},"provisioningProfiles":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceProvisioningProfiles"}},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/MobileDeviceAttachmentV2"}}},"description":"will be populated if the type is watchos."},"WebLink":{"type":"object","properties":{"name":{"type":"string","example":"A popular search engine"},"url":{"type":"string","example":"https://duckduckgo.com"}}},"WellKnownSetting":{"required":["enrollmentType","serverUuid"],"type":"object","properties":{"orgName":{"type":"string","description":"Organization display name","example":"Acme Corporation"},"serverUuid":{"type":"string","description":"Server UUID identifier","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},"enrollmentType":{"$ref":"#/components/schemas/ServiceDiscoveryVersion"}}},"WellKnownSettingsRequest":{"required":["wellKnownSettings"],"type":"object","properties":{"wellKnownSettings":{"type":"array","description":"Array of well-known settings to update","items":{"$ref":"#/components/schemas/WellKnownSetting"}}}},"WellKnownSettingsResponse":{"required":["wellKnownSettings"],"type":"object","properties":{"wellKnownSettings":{"type":"array","description":"Array of well-known settings for all AxM organizations","items":{"$ref":"#/components/schemas/WellKnownSetting"}}}}},"parameters":{"page":{"name":"page","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"integer","default":0}},"page-size":{"name":"page-size","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"integer","default":100}},"size":{"name":"size","in":"query","required":false,"deprecated":true,"style":"form","explode":true,"schema":{"type":"integer","default":100}},"pagesize":{"name":"pagesize","in":"query","required":false,"deprecated":true,"style":"form","explode":true,"schema":{"type":"integer","default":100}},"sort":{"name":"sort","in":"query","description":"Sorting criteria in the format: property:asc/desc. Default sort order is descending. Multiple sort criteria are supported and must be entered on separate lines in Swagger UI. In the URI the 'sort' query param is not duplicated for each sort criterion, e.g., ...&sort=name:asc,date:desc. Fields that can be sorted: status, updated","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":[]}},"filter":{"name":"filter","in":"query","description":"Query in the RSQL format, allowing to filter results. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: status, updated, version This param can be combined with paging and sorting. Example: filter=username!=admin and details==*disabled* and date<2019-12-15","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""}},"export-fields":{"name":"export-fields","in":"query","description":"Export fields parameter, used to change default order or ignore some of the response properties. Default is empty array, which means that all fields of the response entity will be serialized. Example: export-fields=id,username","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":[]}},"export-labels":{"name":"export-labels","in":"query","description":"Export labels parameter, used to customize fieldnames/columns in the exported file. Default is empty array, which means that response properties names will be used. Number of the provided labels must match the number of export-fields Example: export-labels=identifier,name with matching: export-fields=id,username","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"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":{}}}}}}}