Get list of admProfile

GET

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

Get list of admProfile

Required Permission: mdm.apple.profile.list

Get list of admProfile

Request

Add parameter in header authorization

Example: Authorization: Bearer <token>

organizationId string

required

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

page integer

optional

Sequential page index for navigating large datasets, enabling systematic access to specific record subsets within the total collection.

limit integer

optional

Maximum number of records returned per request to control data density, optimize interface performance, and manage payload size

sort string

optional

Ordering criteria using a field-to-direction mapping to organize results based on specific attributes like creation date, name, or status.

Match pattern: ^[\w.]*((:asc)|(:desc))?$

name string

optional

≤ 256 characters

Responses

200 Response application/json

status boolean optional

data object optional

items array [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

uuid string optional

uuid

base64 string optional

base64

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

id string optional

Match pattern: ^[a-fA-F0-9]{24}$

name string optional

≤ 256 characters

devices array [object] optional

id string optional

Match pattern: ^[a-fA-F0-9]{24}$

displayName string optional

≤ 256 characters

useCustomFileVaultCertificates boolean optional

parentAdmProfileId string optional

Match pattern: ^[a-fA-F0-9]{24}$

totalDocs integer optional

limit integer optional

hasPrevPage boolean optional

hasNextPage boolean optional

page integer optional

totalPages integer optional

prevPage integer optional

nextPage integer optional

lean boolean optional

{
    "status": true,
    "data": {
        "items": [
            {
                "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"
            }
        ],
        "totalDocs": 0,
        "limit": 0,
        "hasPrevPage": true,
        "hasNextPage": true,
        "page": 0,
        "totalPages": 0,
        "prevPage": 0,
        "nextPage": 0,
        "lean": true
    }
}

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"
    }
}