About ADE Token Management
Automated Device Enrollment (ADE) tokens require periodic renewal and management to maintain device enrollment capabilities. This process allows you to efficiently manage multiple ADE tokens using API automation, reducing manual effort and ensuring consistent token lifecycle management.How It Works
ADE token management involves using the Iru Endpoint API through Postman to perform bulk operations on multiple tokens. The process includes configuring API access, setting up environment variables, downloading tokens from Apple Business or Apple School Manager, and using automated workflows to renew, update, or delete tokens efficiently.Prerequisites
- Access to Iru Endpoint with API token creation permissions
- Postman application installed and configured
- Access to Apple Business or Apple School Manager
- Multiple ADE tokens that need renewal or management
- Basic understanding of API operations and Postman workflows
Configuring an Iru Endpoint API token
Prepare an API token and store it in a secure location. You can read more about this in our Iru Endpoint API article. You can skip this section if you already have an API token prepared.Create or modify an API token
Open API tokens
Configure Permissions
Preparing Postman
Most of the steps moving forward will be performed inside the Postman application on your device. You can skip this section if you already have Postman configured.Verify Collection Structure
Define API URL
Configure Environment Variables
Configuring Postman Environment Variables
Now that the basics of Postman have been configured, you will need to define some Environment Variables in Postman to keep track of the Automated Device Enrollment servers.Create Environment Variables
- Variable:
base_url- Initial Value:
https://<subdomain>.api.iru.com/api/v1 - Current Value:
https://<subdomain>.api.iru.com/api/v1
- Initial Value:
<subdomain> with your tenant’s actual subdomain, or copy the base URL directly from your tenant. The URL shown in your tenant may use the api.kandji.io domain. Both <subdomain>.api.iru.com and <subdomain>.api.kandji.io will work without modification.- Variable:
token- Initial Value:
your_api_token_here - Current Value:
your_api_token_here
- Initial Value:
Add to Existing Variables
List ADE Integrations
Execute Request
Copy Token IDs
Create Token Variables
ade_token_1, ade_token_2, etc., incrementing the number for each token.Note Server Names
server_name for each token. You will need this information when downloading the tokens from Apple Business or Apple School Manager.Set Variable Values
ade_token_# variable (e.g., ade_token_1, ade_token_2).Secure Variables
Downloading ADE Tokens
Access Apple Business or Apple School Manager
Open the Devices tab
Open Management
Select the matching device management service
server_name from the list you made earlier in Postman.Open the service actions menu
Download the token
Repeat for All Tokens
Creating Postman Folder Template
Creating folders in Postman will make it easier to keep track of your Automated Device Enrollment tokens.Access Folder Options
Add New Folder
Name the Folder
Select Integration Items
Copy Items
Access New Folder
Paste Items
Modifying Renew Item
Select Renew Item
Rename Item
Update Address Bar
Update Token Variable
{{ade_token_ade}} and update it to {{ade_token_1}} (or {{ade_token_2}}, etc., based on your token number).Configure Body
Enter Token Details
blueprint_id, phone, and email that should be associated with the token.Select Token File
Choose P7M File
Save Changes
Modifying Update Item
Select Update Item
Rename Item
Update Address Bar
Update Token Variable
{{ade_token_ade}} and update it to {{ade_token_1}} (or {{ade_token_2}}, etc., based on your token number).Configure Body
Enter Update Information
blueprint_id, phone, and email information.Save Changes
Duplicating ADE_Token Folder
Access Folder Options
Duplicate Folder
Update Folder Contents
Create Additional Folders
Renewing ADE Integration
Now that everything is configured, you can send the Renew command.Select Renew Command
Execute Command
Updating ADE Integration
Updating the ADE Integration will allow you to change the associated Blueprint ID, phone number, and email address.Select Update Command
Update Details
Execute Command
Checking Current Integrations
Iru Endpoint API > Automated Device Enrollment Integrations > GET List ADE Integrations command will give us all current ADE integrations so that we can verify that the integration was Renewed or Updated successfully.Select List Command
Execute Command
Verify Renewal
days_left variable should be 364 if the Renew command was successful.Verify Updates
Deleting Integration
Iru Endpoint API > Automated Device Enrollment Integrations > DEL Delete ADE Integration command will delete the ADE integration associated with the supplied ADE Token ID.Select Delete Command
Set Token ID
ade_token_id variable with the ID of the ADE Token.Execute Command
Considerations
API security, Postman, and environment setup
API security, Postman, and environment setup
- API Token Security: Ensure API tokens are stored securely and have appropriate permissions for ADE operations
- Postman Configuration: Proper Postman setup is essential for successful API operations
- Environment Variables: Use environment variables to manage multiple token IDs efficiently
- Error Handling: Be prepared to troubleshoot API errors and token validation issues
Tokens, files, and Apple portal access
Tokens, files, and Apple portal access
- Token Lifecycle: ADE tokens have expiration dates and require periodic renewal to maintain enrollment capabilities
- Token File Management: Keep track of downloaded .p7m files and associate them with correct token IDs
- Apple Business or Apple School Manager access: Ensure you can sign in to the portal and download tokens
- Verification Process: Always verify successful operations by checking integration status and token expiration
Bulk operations and access control
Bulk operations and access control
- Bulk Operations: Use folder templates to efficiently manage multiple tokens
- Access Control: Ensure only authorized personnel have access to token management operations
Testing, monitoring, and continuity
Testing, monitoring, and continuity
- Testing: Test operations on a small scale before performing bulk operations
- Monitoring: Regularly monitor token expiration dates and renewal schedules
- Documentation: Keep records of token configurations and associated server names
- Backup Strategy: Maintain backups of token configurations and API settings