Modify the configuration of a Extensible SSO payload item within a profile

To modify Ios Extensible SSO policy payload item

Endpoints

put /api/v1/mdm/profiles/{profile_id}/payloads/iosextensiblessopolicy/payloaditems/{payload_id}

Copy full URL

Request URL

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

Scope

MDMDeviceMgmt.UPDATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory

application/jsonCopied!

AcceptstringMandatory

application/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

- Request Body

application/json

JSON Object

Hide Sub-Attributes

extension_identifierstringMandatory

Extension Identifier

team_identifierstringMandatory

Team Identifier

screen_locked_behaviorintegerMandatory

Screen Locked Behavior

typeintegerMandatory

Type

extension_datastringMandatory

Extension Data

realmstringMandatory

Realm

hosts_and_urlsarrayMandatory

List of URL strings for the identity provider hosts

denied_apps_detailsJSON ArrayMandatory

List of denied apps excluded from Extensible SSO

Show Sub-Attributes

JSON Object

Show Sub-Attributes

app_group_idlongOptional

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

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request PUT \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/iosextensiblessopolicy/payloaditems/{payload_id} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"hosts_and_urls":["https://zylker.com"],"extension_identifier":"value","screen_locked_behavior":1,"extension_data":"value","team_identifier":"value","realm":"value","type":1,"denied_apps_details":[{"app_group_id":9007199254741072}]}'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/iosextensiblessopolicy/payloaditems/{payload_id}"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("PUT", HttpRequest.BodyPublishers.ofString("{\"hosts_and_urls\":[\"https://zylker.com\"],\"extension_identifier\":\"value\",\"screen_locked_behavior\":1,\"extension_data\":\"value\",\"team_identifier\":\"value\",\"realm\":\"value\",\"type\":1,\"denied_apps_details\":[{\"app_group_id\":9007199254741072}]}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomain")

payload = "{\"hosts_and_urls\":[\"https://zylker.com\"],\"extension_identifier\":\"value\",\"screen_locked_behavior\":1,\"extension_data\":\"value\",\"team_identifier\":\"value\",\"realm\":\"value\",\"type\":1,\"denied_apps_details\":[{\"app_group_id\":9007199254741072}]}"

headers = {
    'Content-Type': "application/json",
    'Accept': "application/json",
    'Authorization': " d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("PUT", "/api/v1/mdm/profiles/{profile_id}/payloads/iosextensiblessopolicy/payloaditems/{payload_id}", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    headersMap = Map();
    headersMap.put("Content-Type", "application/json");
    headersMap.put("Accept", "application/json");

    data=Map();
    data.put("extension_identifier","value");
    data.put("team_identifier","value");
    data.put("screen_locked_behavior","1");
    data.put("type","1");
    data.put("extension_data","value");
    data.put("realm","value");
    data_hosts_and_urls=List();
    data.put("hosts_and_urls",data_hosts_and_urls);
    data_denied_apps_details=List();
    data_denied_apps_details_item1=Map();
    data_denied_apps_details_item1.put("app_group_id","1");
    data_denied_apps_details.add(data_denied_apps_details_item1);
    data.put("denied_apps_details",data_denied_apps_details);

    response = invokeUrl
    [
        url: "https://appDomain/api/v1/mdm/profiles/{profile_id}/payloads/iosextensiblessopolicy/payloaditems/{payload_id}"
        type: PUT
        headers: headersMap
        body: data
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Content-Type", "application/json")
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/iosextensiblessopolicy/payloaditems/{payload_id}' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{"hosts_and_urls":["https://zylker.com"],"extension_identifier":"value","screen_locked_behavior":1,"extension_data":"value","team_identifier":"value","realm":"value","type":1,"denied_apps_details":[{"app_group_id":9007199254741072}]}'

Sample Request Body

Modify Extensible SSO payload item

Copied!

  {
    "hosts_and_urls": [
      "https://zylker.com"
    ],
    "extension_identifier": "value",
    "screen_locked_behavior": 1,
    "extension_data": "value",
    "team_identifier": "value",
    "realm": "value",
    "type": 1,
    "denied_apps_details": [
      {
        "app_group_id": 9007199254741072
      }
    ]
  }

▼ Show full

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

Extensible SSO payload item successfully modified

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: 60 | 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.