Favicon

You are here: Home > API Reference > Apple > Apple Profiles > Create admProfile

POST /organizations/:organizationId/mdm/apple/enterprise/profiles

Required Permission: mdm.apple.profile.create

Create admProfile

POST
https://api.applivery.io/v1/organizations/{organizationId}/mdm/apple/enterprise/profiles 
curl -X POST "https://api.applivery.io/v1/organizations/{organizationId}/mdm/apple/enterprise/profiles" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "config": {},
  "name": "string",
  "targetType": "device",
  "certificates": [
    {}
  ],
  "useCustomFileVaultCertificates": true
}'
const response = await fetch("https://api.applivery.io/v1/organizations/{organizationId}/mdm/apple/enterprise/profiles", {
  method: "POST",
  headers: {
    Authorization: "Bearer <YOUR_API_KEY>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "config": {},
    "name": "string",
    "targetType": "device",
    "certificates": [
      {}
    ],
    "useCustomFileVaultCertificates": true
  }),
});

const data = await response.json();
import requests

response = requests.post(
    "https://api.applivery.io/v1/organizations/{organizationId}/mdm/apple/enterprise/profiles",
    headers={"Authorization": "Bearer <YOUR_API_KEY>"},
    json={
      "config": {},
      "name": "string",
      "targetType": "device",
      "certificates": [
        {}
      ],
      "useCustomFileVaultCertificates": true
    },
)

data = response.json()

Request

Send your API key in the request header authorization
Example: Authorization: Bearer <token>

organizationId string
required
Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$

Body Params application/json
config object required
name string required
≤ 256 characters
targetType string required
device deviceUser
certificates array [object] optional
mdmAssetId string required
Match pattern: ^[a-fA-F0-9]{24}$
format string required
uuid base64
location string optional
≤ 256 characters
password string optional
≤ 256 characters
allowAllAppsAccess boolean optional
keyIsExtractable boolean optional
useCustomFileVaultCertificates boolean optional 
{
    "config": {},
    "name": "string",
    "targetType": "device",
    "certificates": [
        {
            "mdmAssetId": "string",
            "format": "uuid",
            "location": "string",
            "password": "string",
            "allowAllAppsAccess": true,
            "keyIsExtractable": true
        }
    ],
    "useCustomFileVaultCertificates": true
}

Responses

200 Response application/json
status boolean optional
data object optional
id string optional
Match pattern: ^[a-fA-F0-9]{24}$
organization string optional
Match pattern: ^[a-fA-F0-9]{24}$
admEnterprise string optional
Match pattern: ^[a-fA-F0-9]{24}$
admPolicy string optional
Match pattern: ^[a-fA-F0-9]{24}$
targetType string optional
device deviceUser
name string optional
≤ 256 characters
config object optional
certificates array [object] optional
mdmAssetId string optional
Match pattern: ^[a-fA-F0-9]{24}$
format object optional
location string optional
≤ 256 characters
password string optional
≤ 256 characters
allowAllAppsAccess boolean optional
keyIsExtractable boolean optional
type string optional
attached single
UUID string optional
≤ 128 characters
version integer optional
≥ 0
updatedAt string optional
Format: date-time
createdAt string optional
Format: date-time
assignedTo object optional
policies array [object] optional
devices array [object] optional
useCustomFileVaultCertificates boolean optional
parentAdmProfileId string optional
Match pattern: ^[a-fA-F0-9]{24}$
{
    "status": true,
    "data": {
        "id": "string",
        "organization": "string",
        "admEnterprise": "string",
        "admPolicy": "string",
        "targetType": "device",
        "name": "string",
        "config": {},
        "certificates": [
            {
                "mdmAssetId": "string",
                "format": {
                    "uuid": "uuid",
                    "base64": "base64"
                },
                "location": "string",
                "password": "string",
                "allowAllAppsAccess": true,
                "keyIsExtractable": true
            }
        ],
        "type": "attached",
        "UUID": "string",
        "version": 0,
        "updatedAt": "2024-01-01T00: 00:00Z",
        "createdAt": "2024-01-01T00: 00:00Z",
        "assignedTo": {
            "policies": [
                {
                    "id": "string",
                    "name": "string"
                }
            ],
            "devices": [
                {
                    "id": "string",
                    "displayName": "string"
                }
            ]
        },
        "useCustomFileVaultCertificates": true,
        "parentAdmProfileId": "string"
    }
}
400 Response application/json
status boolean optional
false
error object optional
code number optional
5085
message string optional
Single profiles only allow one property
{
    "status": false,
    "error": {
        "code": 5085,
        "message": "Single profiles only allow one property"
    }
}
401 Response application/json
status boolean optional
false
error object optional
code number optional
4004
message string optional
Invalid Token
{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}
404 Response application/json
status boolean optional
false
error object optional
code number optional
3001
message string optional
Entity not found
{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}