Retrieve the full configuration details of a Extensible SSO 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 Extensible SSO policy payload item

Request URL

https://{server-hostname}:8383/api/v1/mdm/profiles/{profile_id}/payloads/macextensiblessopolicy/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/macextensiblessopolicy/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

extension_identifierstring

Bundle identifier of the app extension that provides Single Sign-On

team_identifierstring

Apple Developer Team identifier of the app extension

typeinteger

SSO extension type. Allowed values: 0=Credential (Kerberos), 1=Redirect

realmstring

Kerberos realm name. Empty when type is 1 (Redirect)

authentication_methodinteger

Authentication method for Platform SSO. Allowed values: -1=Not Configured, 0=Password, 1=User Secure Enclave Key

screen_locked_behaviorinteger

Behavior when SSO is requested while the screen is locked. Allowed values: -1=Not Configured, 0=Cancel, 1=Do Not Handle

extension_datastring

Custom configuration data for the SSO extension in Apple property list XML format

registration_tokenstring

Token used for Platform SSO registration

hosts_and_urlsarray

List of identity provider URL prefixes that the SSO extension handles

denied_apps_detailsJSON Array

List of apps excluded from using this SSO extension, with resolved app details

Show Sub-Attributes
JSON Object
Show Sub-Attributes
app_group_idlong

App group ID of the denied app

identifierstring

Bundle identifier of the denied app

group_display_namestring

Display name of the denied app

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Full configuration details of Extensible SSO payload item

Copied!
  {
    "authentication_method": -1,
    "hosts_and_urls": [
      "https://login.zylker.com"
    ],
    "extension_identifier": "com.apple.AppSSOKerberos.KerberosExtension",
    "payload_id": 9007199254741000,
    "screen_locked_behavior": -1,
    "extension_data": "<dict><key>helpURL</key><string>https://zylker.com/help</string></dict>",
    "team_identifier": "apple",
    "realm": "ZYLKER.COM",
    "registration_token": "",
    "type": 0,
    "denied_apps_details": [
      {
        "identifier": "com.zylker.deniedapp",
        "group_display_name": "Denied App",
        "app_group_id": 9007199254741072
      }
    ]
  }
                
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.