# Add a new SSO payload configuration to an existing profile

To create Ios SSO policy

## Endpoint

**POST** `/api/v1/mdm/profiles/{profile_id}/payloads/iosssopolicy`

## Request URL

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

## Scope

`MDMDeviceMgmt.CREATE`

## Header

`Authorization: d92d4xxxxxxxxxxxxx15f52`

## Request Parameters

### Request Headers

- **Content-Type** `string` **Mandatory**: `application/json`
- **Accept** `string` **Mandatory**: `application/json`

### Path Parameters

- **profile_id** `string` **Mandatory**: Unique identifier of the profile. Obtain from the [Create Profile](https://www.manageengine.com/products/desktop-central/help/api/onpremise/mdm-profiles-create-profile.html) or [Get Profiles](https://www.manageengine.com/products/desktop-central/help/api/onpremise/mdm-profiles-get-profile.html) response

### Request Body

`application/json`

- `JSON Object`
  - **account_display_name** `string` **Mandatory**: Account Display Name
  - **account_type** `integer` Optional: SSO account type. Allowed values: 0=Kerberos
  - **auth_type** `integer` Optional: SSO authentication type. Allowed values: 0=Password/Username, 1=Certificate
  - **kerberos_prinicpal_name** `string` Optional: Kerberos Prinicpal Name
  - **kerberos_realm** `string` **Mandatory**: Kerberos Realm
  - **client_cert_id** `long` Optional: Client identity certificate ID obtained from the [Certificates API](https://www.manageengine.com/products/desktop-central/help/api/onpremise/certificates-get-certificates.html). Must be an identity certificate (`is_identity` = true)
  - **allowed_apps** `JSON Array` Optional: List of apps allowed for Single Sign-On
  - **url_details** `JSON Array` Optional: List of URL prefixes that must be matched for SSO to work

## Sample Request

```curl
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"}'
```

## Sample Request Body

Add SSO payload to the profile

```json
{
  "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"
}
```

## Response Parameters

### HTTP code 200

Response Body: `application/json`

- `JSON Object`
  - **payload_id** `long`: Unique identifier for the created payload item
  - **account_display_name** `string`: Account Display Name
  - **account_type** `integer`: SSO account type. Allowed values: 0=Kerberos
  - **auth_type** `integer`: SSO authentication type. Allowed values: 0=Password/Username, 1=Certificate
  - **kerberos_prinicpal_name** `string`: Kerberos Prinicpal Name
  - **kerberos_realm** `string`: Kerberos Realm
  - **client_cert_id** `long`: Client identity certificate ID obtained from the [Certificates API](https://www.manageengine.com/products/desktop-central/help/api/onpremise/certificates-get-certificates.html). Must be an identity certificate (`is_identity` = true)
  - **allowed_apps** `JSON Array`: List of apps allowed for Single Sign-On
  - **url_details** `JSON Array`: List of URL prefixes that must be matched for SSO to work

## Possible Response Codes

- **200** `HTTP code`

## Sample Response: HTTP 200

SSO payload successfully added

```json
{
  "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"
}
```

![ ](https://www.zohowebstatic.com/sites/zweb/images/people/ico-help.png)

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