Seamlessly integrate Addigy device management with Okta Workflows to automate critical user lifecycle processes, reducing manual errors and enhancing operational efficiency. Begin by authorizing your Addigy tenant within Okta Workflows. Once connected, you’ll have access to Addigy-specific actions that make it easy to streamline and automate essential tasks.
Overview
| Connector Action Cards |
Description |
|---|---|
|
Makes an authenticated HTTP request to the Addigy API v2. |
|
|
Sends a lock device MDM command to macOS, iOS, and iPadOS devices. |
|
|
Gets a user's identity email address given an agent ID. |
|
|
Gets details about a policy given a policy ID. |
|
|
Gets all policies in an Addigy organization. |
|
|
Gets identity user attributes given an agent ID. |
|
|
Gets details about a device given a serial number. |
|
|
Gets device information for a given user email address. |
Custom API Action
Makes an authenticated HTTP request to the Addigy API v2.
Options
| Field | Definition | Type | Required |
|---|---|---|---|
| Request Type |
This is one of the supported HTTP request methods, or HTTP verbs, in a custom API call (seeHTTP request methods).
|
Dropdown | TRUE |
Inputs
| Field | Definition | Type | Required |
|---|---|---|---|
| Relative URL | Specify the relative URL to the Addigy API. The input value is the text that follows /v2 in the URL. For example, the full API endpoint URL https://api.addigy.com/api/v2/devices has the input value /devices. This is consistent with the API documentation relative path examples. You can include query parameters in the relative URL using ? or as object key pairs in the Query input. | String | TRUE |
| Query | Specify any additional query parameters that should be included in object format (key-value pairs). | Object | FALSE |
| Headers | Specify any headers required in addition to authorization or content-type (these are already handled by this connector). | Object | FALSE |
| Body | Specify a request body in JSON format. | Object |
FALSE |
Outputs
| Field | Definition | Type |
|---|---|---|
| Status Code | Result of the operation. The Addigy connector returns the HTTP status and indicates whether the action taken by the card succeeded or failed. | Number |
| Headers | Detailed context for the status code unrelated to the output body. Response headers are dependent on your selected HTTP request option. Note that not all headers are response headers. This will usually be similar to {"Content-type":"application/json"}. | Object |
| Body | Data returned from the HTTP request. For example, the data from a GET request. | Object |
Lock Device
Sends a lock device MDM command to macOS, iOS, and iPadOS devices.
Note: Lock device command is only supported for
- iOS 4.0 +
- iPadOs 4.0+
- MacOs 10.7+
- (Apple Tv is not supported)
Note: will require an api key with View Devices and Execute Lock Device Command permissions.
Input
| Field | Description | Type | Required |
|---|---|---|---|
| Device UUID | Addigy-specific unique device id of the device to send the MDM command to. | String | TRUE |
| 6 Digit Pin | A 6-digit PIN that will be required to unlock the device(Available in macOS 10.8 and later). | String | FALSE |
| Phone Number | Phone number to display on the lock screen (optional). This doesn’t apply to a shared iPad device. This value is available in iOS 7 and later and macOS 11.5 and later (for Apple silicon devices only). | String | FALSE |
| Lock Message | Message to display on the lock screen (optional). This doesn’t apply to a shared iPad device. This value is available in iOS 4 and later, and macOS 10.14 and later. | String | FALSE |
Outputs
| Field | Description | Type |
|---|---|---|
| Device UDID | Unique Device Identifier. | String |
| Device Name | Name of the device. | String |
| Device Model Name | Specific device model name (Ex.macOS 10.14). | String |
| Serial Number | Serial number of the device. | String |
| Current User | Current User's Username. | String |
| Message | Message indicating the result of the command. | String |
| Lock PIN | Lock PIN for the device.For a Mac computer, Returned only if a PIN was set prior to the lock command. PIN is required to unlock the device. | String |
Get Identity User Email
Gets a user's identity email address given an agent ID.
Note: This flow does require users to have identity configured in Addigy and will require enabling collecting user attributes data to retrieve the device's identity user Attributes . For more information, refer to the following articles:
Input
| Field | Description | Type | Required |
|---|---|---|---|
| Agent ID | The agent ID of the device to retrieve the identity email for. | String | True |
Outputs
| Field | Description | Type |
|---|---|---|
| Identity Email | The email attribute of the identity user associated with the device. | String |
| Status Code |
Result of the operation. The HTTP status code is returned by the connector and indicates whether the action taken by the card succeeded or failed. For example:
For a full list of possible status codes, see HTTP status codes. |
Number |
| Message | Message indicating the result of the command. | String |
Get Policy
Gets details about a policy given a policy ID
Input
| Field | Description | Type | Required |
|---|---|---|---|
| Policy ID | The unique identifier of the policy to retrieve information for. | String | True |
Outputs
| Field | Description | Type |
|---|---|---|
| Organization ID | The identifier for the organization to which the policy belongs. | String |
| Policy ID | The unique identifier of the retrieved policy. | String |
| Name | The name of the policy. | String |
| Parent | The ID of the parent policy, if applicable. Null if no parent exists. | String |
| Download Path | The URL for downloading the associated agent for the policy. | String |
| Agent Path | The installer pkg associated to the policy. | String |
| Instructions | A json list of instruction IDs associated with the policy. | List of Strings |
| Color | The color code associated with the policy. | String |
| Icon | The icon representation for the policy. | String |
| Last Deployed | The timestamp of the last deployment of the policy. | String |
| Creation Time | The timestamp when the policy was created. | String |
| Agent Version | The version of the agent associated with the policy. | String |
| Ignore Updates | Indicates whether updates should be ignored for this policy. | Boolean |
| Self Service Instruction IDs | A map of Self Service instruction IDs and their enablement status. | Object |
| VNC Settings | Configuration details for VNC settings within the policy. | Object |
| Splashtop Settings | Configuration details for Splashtop settings within the policy. | Object |
| SSH Settings | Configuration details for SSH settings within the policy. | Object |
| System Update Settings | Configuration details for system updates as defined by the policy. | Object |
| Collector Settings | Configuration details for collector settings within the policy. | Object |
List Policies
Gets all policies in an Addigy organization.
Note: No input fields are required from the users, and there is no limit to the number of policies this card can return. It will display all the policies available in your environment.
Outputs
| Field | Description | Type |
|---|---|---|
| Policies | List of policies. Reference the Get Policy connector card documentation for additional information on policy attributes. | List of Objects |
Get Identity User Attributes
Gets Identity user attributes given an agent ID.
Note: This flow does require users to have Identity configured in Addigy and will require enabling collecting user attributes data to retrieve the device's identity user Attributes . For more information, refer to the following articles:
Input
| Field | Description | Type | Required |
|---|---|---|---|
| Agent ID | The unique identifier of the Agent to retrieve information. | String | True |
Outputs
| Field | Description | Type |
|---|---|---|
| Message | Message indicating the result of the command. | String |
| Identity User Email |
Email address for the user; for example: ["j@companyname.com"]. NOTE: This property cannot contain accent characters. |
String |
| Identity Employee Department | The name of the department in which the user works. | String |
| Identity Employee Hire Date | The date and time when the user was hired or will start work in case of a future hire. | Datetime |
|
Identity Employee Type |
Captures enterprise worker type. For example, Employee, Contractor, Consultant, or Vendor. | String |
|
Identity Mobile Phone |
The primary cellular telephone number for the user. | String |
|
Identity Provider Name |
The name of the Identity Provider. | String |
|
Identity User Display Name |
The name is displayed in the directory for the user. This is usually the combination of the user's first and middle initial and last names. This property is required when a user is created and cannot be cleared during updates. | String |
|
Identity Username |
The UPN is an Internet-style login name for the user based on the Internet standard RFC 822. By convention, this should map to the user's email name. The general format is alias@domain, where the domain must be present in the tenant's collection of verified domains. This property is required when a user is created. | String |
|
Identity Office Location |
A two letter country code (ISO standard 3166). Examples include: US, JP, and GB. | String |
|
Identity Usage Location |
The office location in the user's place of business. | String |
|
Identity Password Set Date |
The time when this Azure AD user last changed their password or when their password was created, whichever date the latest action was performed. | Datetime |
Get Device Facts
Gets details about a device given a serial number.
Note: will require an api key with View Devices permissions.
Input
| Field | Description | Type | Required |
|---|---|---|---|
| Serial Number | Device Serial Number. | String | True |
Outputs
| Field | Description | Type |
|---|---|---|
| 32 Bit Applications | Lists 32bit apps and returns a list separated by new lines. Catalina or newer returns N/A. | List of Strings |
| Active Managed Users | Lists a UDID of the active managed user who are a special type of users on macOS Devices in 10.15 or later. | List of Strings |
| Addigy Splashtop Installed | Returns if Splashtop is installed. | Boolean |
| Admin Users | List all Users who are type admin. | List of Strings |
| Agent Version | Lists the current Agent Version installed on the Device. | String |
| Agent ID | The unique identifier of the Agent. | String |
|
Awaiting Configuration |
Lists if the device is Awaiting Device Configuration in Automated Device Enrollment. | Boolean |
| Battery Capacity Loss Percentage |
Lists the Battery Capacity Loss Percentage of a Device. This is to indicate Device Battery Health Status. | Number |
| Battery Charging | Returns if current device is charging. | Boolean |
| Battery Cycles | Lists the number of Battery Cycles of a Device. This is to indicate Device Battery Health Status. | Number |
| Battery Failures | Lists the number of Battery Failures of a Device. This is to indicate Device Battery Health Status. | Number |
| Battery Life Remaining Percentage | Returns the devices battery percentage. | String |
| Battery Percentage | Returns the devices battery temperature in Celsius. | String |
| Battery Temperature Celsius | Returns the devices battery temperature in Celsius. | Number |
| Battery Temperature Fahrenheit | Returns the devices battery temperature in Fahrenheit. | Number |
| Bluetooth Mac | Returns True/False if the device's bluetooth is on/off. | String |
| Build Version | Lists the macOS Build Version for the Device. | String |
| Cpu Speed Ghz | Returns CPU speed in GHz. | Number |
| Cpu Type | Returns CPU specifications. | String |
| Crashplan Days Since Last Backup | Returns the days since last crashplan backup. | Number |
| Current User | Lists the Current User's Username. | String |
| Device Model Name | Lists the Device Model Name for the Device. | String |
| Device Name | Lists the Host Name of the Device as the Device Name. | String |
| Disk Free Percentage | Returns percentage of free disk space. | Number |
| Disk Free Space Gb | Returns number of free disk space in Gb. | Number |
| Disk Total Space Gb | Return total number of free disk space in Gb. | Number |
| Display On | Lists if the Display is turned on for the device. | Boolean |
| Ethernet Mac Address | Lists the Ethernet MAC Address for the device if Applicable. | String |
| Filevault Enabled | Returns True/False if the Device is FileVault Enabled. | Boolean |
| Firewall Allowed Applications | Returns list of firewall's whitelisted applications. | List of Strings |
| Firewall Block All Incoming Connections | Returns True/False depending if Device has the option "Block all incoming connections" enabled/disabled. | Boolean |
| Firewall Blocked Applications | Returns list of firewall's blocked applications. | List of Strings |
| Firewall Enabled | Returns True/False if firewall is enabled. | Boolean |
| Firewall Stealth Mode Enabled | Returns True/False depending if Device has "stealth mode" is enabled/disabled. | Boolean |
| Firmware Password Allow Oroms | Returns if optional roms are allowed. | Boolean |
| Firmware Password Change Pending | Returns if firmware password change is pending. | Boolean |
| Firmware Password Exists | Returns if firmware password is set. | Boolean |
| Gatekeeper Enabled | Returns True/False if Gatekeeper is enabled. | Boolean |
| Hardware Model | Lists the Devices Hardware Model information. | String |
| Has Mdm | Returns True/False if Addigy MDM is installed. | Boolean |
| Has Mdm Profile Approved | Returns True/False if Addigy MDM is User Approved (10.13.4 or higher). | Boolean |
| Has Wireless | Returns True/False if device has wireless interface. | Boolean |
| Host Name | Returns hostname of the device, if set. | String |
| Installed Profiles | Returns a list of installed profiles on device. | List of Strings |
| Java Vendor | Returns the creator/maintainer of the JVM. | String |
| Java Version | Returns the version of Java. | String |
| Kernel Panic | Returns if Device had experienced a kernel panic. | Boolean |
| Lan Cache Size Bytes | Returns size of lan cache folder in Bytes. | Number |
| Languages | Returns language set on device (returns language of logged in user). | List of Strings |
| Last Reboot Timestamp | Returns date and time of last reboot. | Number |
| Local Ip | Returns local IP based on interface priority. | String |
| Locales | Returns UTF language and country code(s) of all preferred languages for logged in use. | List of Strings |
| Localhost Name | Returns local hostname of the device. | String |
| Management Status Enrolled Via Dep | Returns if the device was enrolled via ADE / DEP (10.13.4 or higher). | Number |
| Manufactured Date | Returns manufactured date of device (Only valid for devices manufactured before March 2021). | String |
| Os Platform | Returns the macOS platform. | String |
| Os Version | Returns major, minor, patch version of macOS. | Number |
| Peer Count | Returns other clients nearby for lan cache. | Number |
| Product Description | Returns specific device type. | String |
| Product Name | Returns model identifier of the hardware. | String |
| Remote Desktop Enabled | Returns True/False status of Apple Remote Desktop. | Boolean |
| Remote Login Enabled | Returns True/False status of Remote Login (ssh). | Boolean |
| Serial Number | Returns device serial number. | String |
| Smart Failing | Returns if primary drive has a SMART error. | Boolean |
| Splashtop Id | Returns Splashtop id of device (Splashtop must be installed). | String |
| Splashtop Installation Date | Returns Splashtop installation date. | Datetime |
| System Integrity Protection Enabled | Returns if SIP is enabled (10.11 or higher). | String |
| System Version | Returns os_version and build_version. | String |
| Third Party Agents | Returns a list of device level launch agents. | List of Strings |
| Third Party Daemons | Returns a list of device level launch daemons. | List of Strings |
| Third Party Kernel Extensions | Returns a list of third party kernels. | List of Strings |
| Time Machine Days Since Last Backup | Returns last date of time machine backup. | Number |
| Timezone | Returns the current timezone. | String |
| Tmp Size Mb | Returns size of tmp folder in mb. | Number |
| Total Memory Gb | Returns total installed memory. | Number |
| Udid | Returns unique device id. | String |
| Uptime Days | Returns number of uptime in days (if less than 1 day fact returns 0. | Number |
| Used Memory | Returns memory currently in use. | Number |
| Warranty Expiration Date | Returns date of Apple warranty expiration of device (Only valid for devices manufactured before March 2021). | String |
| Watchman Monitoring Install | Returns True/False if watchman monitoring is installed. | Boolean |
| Wifi Mac Address | Returns Wi-Fi MAC address. | String |
| Xcode Installed | Returns if Xcode is installed on device. | Boolean |
Get Device Information
Gets device information for a given user email address.
Input
| Field | Description | Type | Required |
|---|---|---|---|
|
Email address for the user; for example: ["j@companyname.com"] NOTE: This property cannot contain accent characters. |
String | True |
Outputs
| Field | Description | Type |
|---|---|---|
| Device UUID | Unique Device Identifier. | String |
| Serial Number | Serial number of the device. | String |
| Agent ID | The unique identifier of the Agent to retrieve information. | String |