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

Request URL

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

account_display_namestring

Account Display Name

account_typeinteger

SSO account type. Allowed values: 0=Kerberos

auth_typeinteger

SSO authentication type. Allowed values: 0=Password/Username, 1=Certificate

kerberos_prinicpal_namestring

Kerberos Prinicpal Name

kerberos_realmstring

Kerberos Realm

client_cert_idlong

Client identity certificate ID obtained from the Certificates API. Must be an identity certificate (is_identity = true)

allowed_appsJSON Array

List of apps allowed for Single Sign-On

Show Sub-Attributes
JSON Object
Show Sub-Attributes
group_display_namestring

Display name of the app group

identifierstring

Bundle identifier of the app

url_detailsJSON Array

List of URL prefixes that must be matched for SSO to work

Show Sub-Attributes
JSON Object
Show Sub-Attributes
urlstring

URL or domain string

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Full configuration details of SSO payload item

Copied!
  {
    "client_cert_id": -1,
    "payload_id": 9007199254741000,
    "account_type": 1,
    "auth_type": 1,
    "url_details": [
      "https://zylker.com/auth"
    ],
    "account_display_name": "Zylker User",
    "allowed_apps": [
      {
        "group_display_name": "Zylker App",
        "identifier": "com.zylker.app"
      }
    ],
    "kerberos_realm": "value",
    "kerberos_prinicpal_name": "Zylker User"
  }
                
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.