Add a new Extensible SSO payload configuration to an existing profile

To create Ios Extensible SSO policy

Endpoints

post /api/v1/mdm/profiles/{profile_id}/payloads/iosextensiblessopolicy

Copy full URL

Request URL

https://{serverurl}/api/v1/mdm/profiles/{profile_id}/payloads/iosextensiblessopolicy

Scope

MDMOnDemand.MDMDeviceMgmt.CREATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Path Parameters

profile_idstringMandatory

Unique identifier of the profile. Obtain from the Create Profile or Get Profiles 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. Use the app_group_id from the Apps API response

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/iosextensiblessopolicy \
  --header 'Authorization: Zoho-oauthtoken  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":[{}]}'

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"))
        .header("content-type", "application/json")
        .header("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
        .method("POST", 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\":[{}]}"))
        .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\":[{}]}"

headers = {
    'content-type': "application/json",
    'Authorization': "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("POST", "/api/v1/mdm/profiles/{profile_id}/payloads/iosextensiblessopolicy", 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_hosts_and_urls=List();
    data.put("hosts_and_urls",data_hosts_and_urls);
    data.put("extension_identifier","value");
    data.put("screen_locked_behavior","1");
    data.put("extension_data","value");
    data.put("team_identifier","value");
    data.put("realm","value");
    data.put("type","1");
    data_denied_apps_details=List();
    data_denied_apps_details_item1=Map();
    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"
        type: POST
        headers: headersMap
        body: data
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("content-type", "application/json")
$headers.Add("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/iosextensiblessopolicy' -Method POST -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":[{}]}'

▼ Show full

Sample Request Body

Add Extensible SSO payload to the profile

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 for the created 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. Use the app_group_id from the Apps API response

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Extensible SSO payload successfully added

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