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 Ios Extensible SSO policy payload item

Request URL

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

Extension Identifier

team_identifierstring

Team Identifier

screen_locked_behaviorinteger

Screen Locked Behavior

typeinteger

Type

extension_datastring

Extension Data

realmstring

Realm

hosts_and_urlsarray

List of URL strings for the identity provider hosts

denied_apps_detailsJSON Array

List of denied apps excluded from Extensible SSO

Show Sub-Attributes
JSON Object
Show Sub-Attributes
app_group_idlong

App group ID of the denied app. Obtain the app_group_id by adding the app via the Add App to Blocklist Repository API or from the Get Apps Available for Blocklisting API response

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Full configuration details of Extensible SSO payload item

Copied!
  {
    "hosts_and_urls": [
      "https://zylker.com"
    ],
    "extension_identifier": "value",
    "payload_id": 9007199254741000,
    "screen_locked_behavior": 1,
    "extension_data": "value",
    "team_identifier": "value",
    "realm": "value",
    "type": 1,
    "denied_apps_details": [
      {
        "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.