AirWatch

AirWatch



AirWatch

AirWatch plugin steps can be used for MDM (Mobile Device Management) in AirWatch. AirWatch plugin is designed to provide your IT department with the ability to quickly enroll users, devices, Apps, Content, Email and Telecom in your enterprise environment, configure and update device settings over-the-air, enforce security policies and compliance, secure mobile access to corporate resources, and remotely lock and wipe managed devices.

Compatibility: 

This plugin has been tested with AirWatch- 19.2.0.0(On-Cloud)

Prerequisites:

AirWatch instance with access details.

1. Create REST API Keys in AirWatch:

2. Reference ‘VMware AirWatch REST API Guide’:

https://resources.workspaceone.com/view/zv5cgwjrcv972rd6fmml/en

 

3. Steps to Create REST API Keys in AirWatch:

With Admin as account type, you can access all the managed content APIs. 

To do this navigate to,          

Groups & Settings >All Settings > System > Advanced > API > REST API, and select Add, to generate an API key for the service and account type as Admin.

Enroll Device:

You can enroll Android, Apple, QNX, Chrome OS and Windows OS devices in AirWatch.

The process of enrolling devices for MDM (Mobile Device Management) is discussed in Appendix 14: Enrolling devices for MDM in AirWatch

Future Enhancement:

If required, ‘Advance Input’ tab can be introduced to accommodate the additional input parameters.

Known Issues:

We can create a child Organization Group but cannot create a user under it.


AW: Add Enrollment User (Basic)

Description

AW: Add Enrollment User (Basic) plugin step adds an enrollment user in AirWatch and sends an email to the user with enrollment instructions.


Configurations 

Configuration:

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Connection:


2

Base URL

Specify the AirWatch instance Server URL (e.g. https://cn1106.awmdm.com) or IP address of the AirWatch instance. This field is mandatory.

4

Username 

Specify a username to authenticate to the AirWatch instance (e.g. xx.xx@automationedge.com). This field is mandatory.


Password:


5

Accept Values from fields

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

6

Password

Provide the password of the username to authenticate.

Password is entered using a widget. The widget handles both Text (static value or environment variable) and Combo (drop down containing values from previous steps). This field is mandatory.

If checkbox above is enabled Password field appears as Text box and accepts static values or variables. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.


API Key:


5

Accept Values from fields

Leave checkbox unchecked to accept API Key value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for API Key field to appear as Text box.

6

API Key

API Key is entered using a widget. The widget handles both Text (static value or environment variable) and Combo (drop down containing values from previous steps). This field is mandatory. 

If checkbox above is enabled API Key field appears as Text box and accepts static values or variables. Else if checkbox above is disabled API Key field appears as a drop down to select fields from previous steps.

API Key is available in system settings when REST API access is enabled in AirWatch.  

API Key is needed to integrate VMware Identity Manager with AirWatch.

Steps to Create REST API Keys in AirWatch:

With Admin as account type, you can access all the managed content APIs. To do this navigate to,          

Groups & Settings >All Settings > System > Advanced > API > REST API, and select Add, to generate an API key for the service and account type as Admin.

Username, Password and API Key for AirWatch instance are validated.


Input Tab:

No.

Field Name

Description


Input Fields:


1

New Username

Specify a desired unique new username of the enrollment user. This field is mandatory.

2

New Password

Specify a desired password of the enrollment user. This field is mandatory.

3

First name

Specify First name of the enrollment user. This field is mandatory.

4

Last name

Specify a Last name of the enrollment user. This field is mandatory.

5

Email

Specify the desired email address of the enrollment user

6

Security Type

Allowed values are ‘1’ for Directory and ‘2’ for Basic as seen on the Tooltip.



Optional Input Tab: 

(You may optionally provide values for fields in this tab. Default values will be set if values are not provided explicitly.)

No.

Field Name

Description

1

Organization Group

Specify the unique identification of the Organization Group to be associated with the enrollment user. 

Organization Group is visible on the top of the screen once you login to an AirWatch instance as shown below. 

2

Status

Status is the state of the Enrollment user for activation and deactivation. Allowed values are "True" for creating an Active user, "False" for creating an Inactive user

3

Contact Number

Specify a desired contact number of the enrollment User.

4

Mobile Number

Specify a desired mobile number of the enrollment user.

5

Role

Role associated with the user. Allowed values are "Basic Access", "Full Access" and “External Access”.

6

Message Type

Type of the message sent to the enrollment user. Allowed values are: Email, SMS, NONE.

7

Message Template ID

Unique ID of the template of the confirmation Email/SMS sent to the User.



Output Tab:

No.

Field Name

Description

1

UUID

Specify an output fieldname to hold the UUID (Universal Unique Identifier) generated as a result of the step execution.

2

User ID

Specify an output fieldname to hold the User ID generated as a result of the step execution.


AW: Add Enrollment User To User Group

Description

AW: Add Enrollment User To User Group plugin step adds an enrollment user to an AirWatch User Group.

Configurations 

Configuration:

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Connection:


2

Base URL

Specify the AirWatch instance Server URL (e.g. https://cn1106.awmdm.com) or IP address of the AirWatch instance. This field is mandatory.

4

Username 

Specify a username to authenticate to the AirWatch instance (e.g. xx.xx@automationedge.com). This field is mandatory.


Password:


5

Accept Values from fields

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

6

Password

Provide the password of the username to authenticate.

Password is entered using a widget. The widget handles both Text (static value or environment variable) and Combo (drop down containing values from previous steps). This field is mandatory.

If checkbox above is enabled Password field appears as Text box and accepts static values or variables. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.

Username, Password and API Key for AirWatch instance are validated.


API Key:


5

Accept Values from fields

Leave checkbox unchecked to accept API Key value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for API Key field to appear as Text box.

6

API Key

API Key is entered using a widget. The widget handles both Text (static value or environment variable) and Combo (drop down containing values from previous steps). This field is mandatory. 

If checkbox above is enabled API Key field appears as Text box and accepts static values or variables. Else if checkbox above is disabled API Key field appears as a drop down to select fields from previous steps.

API Key is available in system settings when REST API access is enabled in AirWatch.  API Key is needed to integrate VMware Identity Manager with AirWatch.

Steps to Create REST API Keys in AirWatch:

With Admin as account type, you can access all the managed content APIs. To do this navigate to,          

Groups & Settings >All Settings > System > Advanced > API > REST API, and select Add, to generate an API key for the service and account type as Admin.


Input Tab:

No.

Field Name

Description


Input Fields:


1

Enrollment Username

Specify an Enrollment username which is to be added to a User Group.

2

Custom User Group

Specify the name of the Custom User Group in which enrollment user is to be added.

The available Custom User Groups can be found by navigating to AccountsUser GroupsList View menu in AirWatch.



AW: Deactivate Enrollment User

Description

AW: Deactivate Enrollment User plugin step deactivates an AirWatch Enrollment User.

Configurations 

Configuration:

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Connection:


2

Base URL

Provide Fully Qualified Domain Name/IP address of machine 

Specify the AirWatch instance Server name

Specify the AirWatch instance Server URL (e.g. https://cn1106.awmdm.com) or IP address of the AirWatch instance. This field is mandatory.

4

Username 

Specify a username to authenticate to the AirWatch instance (e.g. xx.xx@automationedge.com). This field is mandatory.


Password:


5

Accept Values from fields

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

6

Password

Provide the password of the username to authenticate.

Password is entered using a widget. The widget handles both Text (static value or environment variable) and Combo (drop down containing values from previous steps). This field is mandatory.

If checkbox above is enabled Password field appears as Text box and accepts static values or variables. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.

Username, Password and API Key for AirWatch instance are validated.


API Key:


5

Accept Values from fields

Leave checkbox unchecked to accept API Key value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for API Key field to appear as Text box.

6

API Key

API Key is entered using a widget. The widget handles both Text (static value or environment variable) and Combo (drop down containing values from previous steps). This field is mandatory. 

If checkbox above is enabled API Key field appears as Text box and accepts static values or variables. Else if checkbox above is disabled API Key field appears as a drop down to select fields from previous steps.

API Key is available in system settings when REST API access is enabled in AirWatch.  API Key is needed to integrate VMware Identity Manager with AirWatch.

Steps to Create REST API Keys in AirWatch:

With Admin as account type, you can access all the managed content APIs. To do this navigate to,          

Groups & Settings >All Settings > System > Advanced > API > REST API, and select Add, to generate an API key for the service and account type as Admin.

Username, Password and API Key for AirWatch instance are validated.


Input Tab:

No.

Field Name

Description


Input Fields:


1

Enrollment Username

Specify the Enrollment username which is to be deactivated in AirWatch.

Existing Enrollment users can be found by navigating to AccountsUsersList View menu in AirWatch.



AW: Remove Enrollment User from User Group

Description

AW: Remove Enrollment User From User Group plugin step removes an Enrollment User from an AirWatch User Group.

Configurations 

Configuration:

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Connection:


2

Base URL

Specify the AirWatch instance Server URL (e.g. https://cn1106.awmdm.com) or IP address of the AirWatch instance. This field is mandatory.

4

Username 

Specify a username to authenticate to the AirWatch instance (e.g. xx.xx@automationedge.com). This field is mandatory.


Password:


5

Accept Values from fields

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

6

Password

Provide the password of the username to authenticate.

Password is entered using a widget. The widget handles both Text (static value or environment variable) and Combo (drop down containing values from previous steps). This field is mandatory.

If checkbox above is enabled Password field appears as Text box and accepts static values or variables. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.

Username, Password and API Key for AirWatch instance are validated.


API Key:


5

Accept Values from fields

Leave checkbox unchecked to accept API Key value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for API Key field to appear as Text box.

6

API Key

API Key is entered using a widget. The widget handles both Text (static value or environment variable) and Combo (drop down containing values from previous steps). This field is mandatory. 

If checkbox above is enabled API Key field appears as Text box and accepts static values or variables. Else if checkbox above is disabled API Key field appears as a drop down to select fields from previous steps.

API Key is available in system settings when REST API access is enabled in AirWatch.  API Key is needed to integrate VMware Identity Manager with AirWatch.

Steps to Create REST API Keys in AirWatch:

With Admin as account type, you can access all the managed content APIs. To do this navigate to,          

Groups & Settings >All Settings > System > Advanced > API > REST API, and select Add, to generate an API key for the service and account type as Admin.


Input Tab:

No.

Field Name

Description


Input Fields:


1

Enrollment Username

Specify an Enrollment username which is to be removed from a User Group.

2

Custom User Group

Specify the name of the Custom User Group from which enrollment user is to be removed



      Links to better reach 

            Bot Store

             EPD