Add a new SSO payload configuration to an existing profile

To create Ios SSO policy

Endpoints

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

Copy full URL

Request URL

https://{server-hostname}:8383/api/v1/mdm/profiles/{profile_id}/payloads/iosssopolicy

Scope

MDMDeviceMgmt.CREATECopied!

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

- Request Body

application/json

JSON Object

Hide Sub-Attributes

account_display_namestringMandatory

Account Display Name

account_typeintegerOptional

SSO account type. Allowed values: 0=Kerberos

auth_typeintegerOptional

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

kerberos_prinicpal_namestringOptional

Kerberos Prinicpal Name

kerberos_realmstringMandatory

Kerberos Realm

client_cert_idlongOptional

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

allowed_appsJSON ArrayOptional

List of apps allowed for Single Sign-On

Show Sub-Attributes

JSON Object

Show Sub-Attributes

group_display_namestringOptional

Display name of the app group

identifierstringOptional

Bundle identifier of the app

url_detailsJSON ArrayOptional

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

Show Sub-Attributes

JSON Object

Show Sub-Attributes

urlstringOptional

URL or domain string

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/iosssopolicy \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"client_cert_id":-1,"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"}'

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/iosssopolicy"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("{\"client_cert_id\":-1,\"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\"}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

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

payload = "{\"client_cert_id\":-1,\"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\"}"

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

conn.request("POST", "/api/v1/mdm/profiles/{profile_id}/payloads/iosssopolicy", 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("account_display_name","value");
    data.put("account_type","1");
    data.put("auth_type","1");
    data.put("kerberos_prinicpal_name","value");
    data.put("kerberos_realm","value");
    data.put("client_cert_id","1");
    data_allowed_apps=List();
    data_allowed_apps_item1=Map();
    data_allowed_apps_item1.put("group_display_name","value");
    data_allowed_apps_item1.put("identifier","value");
    data_allowed_apps.add(data_allowed_apps_item1);
    data.put("allowed_apps",data_allowed_apps);
    data_url_details=List();
    data_url_details_item1=Map();
    data_url_details_item1.put("url","value");
    data_url_details.add(data_url_details_item1);
    data.put("url_details",data_url_details);

    response = invokeUrl
    [
        url: "https://appDomain/api/v1/mdm/profiles/{profile_id}/payloads/iosssopolicy"
        type: POST
        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/iosssopolicy' -Method POST -Headers $headers -ContentType 'application/json' -Body '{"client_cert_id":-1,"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"}'

Sample Request Body

Add SSO payload to the profile

Copied!

  {
    "client_cert_id": -1,
    "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

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

payload_idlong

Unique identifier for the created 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

SSO payload successfully added

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