Common Fields

Field Name

Field Description

Display Name Enter display name of the task
APIM Endpoint Select the service connection (there will be only 1 choice depending upon if it is Product task or API task)
BU Select the your business unit
Feature Select your operation

For Operation : Create Product

Field Name

Field Description

Product Select the product which has been onboarded for you
Display Name Enter the display name of the product to be created in the APIM instance for your BU
Description Enter the product description
Product Published (Boolean) Check this box if you want the product to be Published

For Operation : API Onboarding

Field Name

Field Description

Product Select the product which has been created in the previous step
User have an Ad application (Boolean) Check this box if you have an Azure AD Application already created for the API If created, enter the application client id in the next field « ad application id »
BU Country Select your country (this is used for naming convention in case AD Application is not created)
API Name Name of the API (this is used for naming convention)
Grant Type Check the box for Client Credentials if you want Client Credentials as the grant type for OAuth Server

For Operation: Create/Update Users and Groups:

Field Name

Field Description

Product Select the product which has been created in the previous step
Update groups & users

Please choose the desired operation

  1. Create a group: This will create a group in the selected product)
    1. Add group name
  2. Create a user: This will create a new user. You need to supply values for first name, last name, email, principal name and the group in which you want to add this user)
  3. Add an existing group: Add an existing AD group to the selected product.

For Operation: Create/Update Subscription:

Field Name

Field Description

Product Select the product which has been created in the previous step
Add Subscriber (Boolean) Check this box to add the subscriber details
Subscriber Name Enter the name of subscription
Subscriber Email Enter the email of subscriber

For Operation: Create/Update Product policy

Field Name

Field Description

Product Select the product which has been created in the previous step
Product Policy Browse the xml policy file from your repo. (Please make sure to link artifacts before this operation)

For Operation: Create/Update Product Tags

Field Name

Field Description

Product Select the product which has been created in the previous step
Product Tag Name Add the name of the tag
Product Tag Display Name Add the display name of the tag

For Operation: Update Product

Field Name

Field Description

Product Select the product which has been created in the previous step
Display Name Enter the new display name for the product to be updated
Description Enter the new description for the product to be updated
Product published Choose if you want to keep the product published or not
Subscription Limit Set the new subscription limit