Get list of admVppUser

GET

/v1/organizations/:organizationId/mdm/apple/enterprise/vpp/locations/:admVppLocationId/users/

Get list of admVppUser

Required Permission: mdm.apple.vppUser.list

Get list of admVppUser

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,}))$

admVppLocationId string

required

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

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

activeOnly boolean

optional

clientUserId string

optional

≤ 256 characters

pageIndex integer

optional

retiredOnly boolean

optional

sinceVersionId string

optional

≤ 256 characters

Responses

200 Response application/json

status boolean optional

data object optional

items array [object] optional

organization string optional

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

admEnterprise string optional

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

admVppLocation string optional

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

clientUserId string optional

≤ 256 characters

email string optional

≤ 256 characters

idHash string optional

≤ 256 characters

inviteCode string optional

≤ 256 characters

status string optional

Registered Associated Retired Deleted

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": [
            {
                "organization": "string",
                "admEnterprise": "string",
                "admVppLocation": "string",
                "clientUserId": "string",
                "email": "string",
                "idHash": "string",
                "inviteCode": "string",
                "status": "Registered"
            }
        ],
        "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"
    }
}