Retrieve the full configuration details of a Login Window payload item

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

To get Mac Login Window policy PayloadItem

Request URL

https://{server-hostname}:8383/api/v1/mdm/profiles/{profile_id}/payloads/macloginwindow/payloaditems/{payload_id}

Scope

MDMDeviceMgmt.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Path Parameters

profile_idstringMandatory

Unique identifier of the profile. Obtain from the Create Profile or Get Profiles response

payload_idstringMandatory

Unique identifier of the payload item. Obtain from the Get Payload Item IDs response

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/macloginwindow/payloaditems/{payload_id} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
payload_idlong

Unique identifier of the payload item

show_full_nameboolean

Show Full Name. Default: false

show_admin_usersboolean

Show Admin Users. Default: true

show_local_usersboolean

Show Local Users. Default: true

show_mobile_accountsboolean

Show Mobile Accounts. Default: true

include_network_userboolean

Include Network User. Default: false

show_other_usersboolean

Show Other Users. Default: true

show_sleep_buttonboolean

Show Sleep Button. Default: true

show_restart_buttonboolean

Show Restart Button. Default: true

show_shutdown_buttonboolean

Show Shutdown Button. Default: true

disable_restart_on_loginboolean

Disable Restart On Login. Default: false

disable_shutdown_on_loginboolean

Disable Shutdown On Login. Default: false

disable_logout_menu_itemboolean

Disable Logout Menu Item. Default: false

disable_sleep_on_loginboolean

Disable Sleep On Login. Default: false

show_input_menuboolean

Show Input Menu. Default: true

disable_immediate_lockboolean

Disable Immediate Lock. Default: false

disable_auto_loginboolean

Disable Auto Login. Default: false

disable_fde_auto_loginboolean

Disable Fde Auto Login. Default: false

enable_console_loginboolean

Enable Console Login. Default: true

enable_external_accountsboolean

Enable External Accounts. Default: true

admin_may_disable_managementboolean

Admin May Disable Management. Default: false

set_computer_name_to_record_nameboolean

Set Computer Name To Record Name. Default: false

allow_guest_accountboolean

Allow Guest Account. Default: true

allow_multiple_sessionboolean

Allow Multiple Session. Default: true

show_password_hint_afterstring

Number of failed login attempts after which password hint is shown

auto_logout_delaystring

Auto-logout delay in minutes. 0 means disabled

window_idle_time_for_screen_saverstring

Idle time in minutes before screen saver activates

login_window_textstring

Login Window Text

ask_for_password_in_screen_saverboolean

Ask For Password In Screen Saver. Default: true

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Full configuration details of Login Window payload item

Copied!
  {
    "include_network_user": false,
    "show_other_users": true,
    "payload_id": 6967000001030056,
    "show_full_name": false,
    "disable_restart_on_login": false,
    "show_mobile_accounts": true,
    "show_admin_users": true,
    "show_shutdown_button": true,
    "show_local_users": true,
    "show_sleep_button": true,
    "show_restart_button": true
  }
                
Show full

Duration: 1 minute | Threshold: 120 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.