v1

latestOpenAPI 3.0.1Apache 2.02026-08-063494581.6 MB
tenant_DEP Tokens

Get dep token by id

Retrieves the details of a single DEP token by its UUID.

Returns metadata including the token name, current state, expiry date, and audit timestamps — useful for checking the status of a specific token before renewal or upload operations.

About Get DEP Token by ID

DEP tokens in Esper go through a two-step setup: public key generation (CSR_GENERATED) followed by ABM server token upload (COMPLETED). This endpoint lets you inspect a specific token's full record without fetching the entire list, which is especially useful in tenants with multiple active DEP tokens. The state field confirms whether the token exchange with Apple Business Manager is complete and the integration is ready for device enrollment.

Key Fields / Query Parameters

id (path, required, UUID) — The unique identifier of the DEP token record.

state — Current token state: CSR_GENERATED or COMPLETED.

token_name — The label assigned to the token during upload.

meta.token_expiry_on — Token expiry date; critical for renewal planning.

created_at / updated_at — Audit timestamps for when the token was created and last modified.

Common Use Cases

Checking whether a specific DEP token setup is complete before onboarding iOS devices

Retrieving expiry information for a single token as part of a renewal workflow

Confirming token state has transitioned to COMPLETED after uploading the ABM server token via PUT /api/tenant/v0/deptokens/{id}/

Best Practices

Call this endpoint after completing the ABM server token upload to confirm the state has transitioned to COMPLETED before attempting to enroll devices.

Use meta.token_expiry_on to set renewal reminders well in advance — expired DEP tokens block automatic device enrollment.

get/tenant/v0/deptokens/{id}/

Path parameters

idstring UUID required

ID of the token object

Response

Get DEP token by id

codeinteger
messagestring