Favicon

You are here: Home > API Reference > Apple > Apple Locations > Get list all of admVppUser

GET /organizations/:organizationId/mdm/apple/enterprise/vpp/locations/:admVppLocationId/users/all

Required Permission: mdm.apple.vppUser.list

Get list all of admVppUser

GET
https://api.applivery.io/v1/organizations/{organizationId}/mdm/apple/enterprise/vpp/locations/{admVppLocationId}/users/all 
curl -X GET "https://api.applivery.io/v1/organizations/{organizationId}/mdm/apple/enterprise/vpp/locations/{admVppLocationId}/users/all" \
  -H "Authorization: Bearer <YOUR_API_KEY>"
const response = await fetch("https://api.applivery.io/v1/organizations/{organizationId}/mdm/apple/enterprise/vpp/locations/{admVppLocationId}/users/all", {
  method: "GET",
  headers: {
    Authorization: "Bearer <YOUR_API_KEY>",
  },
});

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

response = requests.get(
    "https://api.applivery.io/v1/organizations/{organizationId}/mdm/apple/enterprise/vpp/locations/{admVppLocationId}/users/all",
    headers={"Authorization": "Bearer <YOUR_API_KEY>"},
)

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,}))$
admVppLocationId string
required
Match pattern: ^[a-fA-F0-9]{24}$

activeOnly boolean
optional
clientUserId string
optional
≤ 256 characters
retiredOnly boolean
optional
sinceVersionId string
optional
≤ 256 characters

Responses

200 Response application/json
status boolean optional
data 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
{
    "status": true,
    "data": [
        {
            "organization": "string",
            "admEnterprise": "string",
            "admVppLocation": "string",
            "clientUserId": "string",
            "email": "string",
            "idHash": "string",
            "inviteCode": "string",
            "status": "Registered"
        }
    ]
}
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"
    }
}