Verified publisher certification process

  • Raksts

This process is for verified publishers (excluding independent publishers). If you're an independent publisher, go to Independent publisher certification process.

After you finish developing your custom connector, follow these steps to prepare it for certification and generate the connector files to submit to Microsoft.

Note

This topic provides information for certifying custom connectors in Azure Logic Apps, Power Automate, and Power Apps. Before following the steps in this article, read Get your connector certified and register your custom connector with Microsoft.

Basic certification process workflow

The following flowchart shows the basic certification process workflow. The numbered steps in this article correspond to the workflow. They should provide the details you need to complete the certification process.

For an expanded view of the flowchart, select the magnifying glass icon at the bottom-right.

Connector certification process workflow.

For an in-depth visual of this flowchart, go to In-depth connector certification process workflow.

Step 1: Register your connector

You don't need to finish development on your custom connector to apply for certification. To begin the certification process, register your connector for certification by filling out our registration form.

Expect an email within two business days from a Microsoft contact, who will:

  • Understand your custom connector.
  • Learn about your development progress.
  • Guide you through the certification process.

Step 2: Meet submission requirements

To maintain a high standard of quality and consistency among our certified connectors, Microsoft has a set of requirements and guidelines that your custom connector must adhere to for certification.

Give your connector a title

  • Must exist and be written in English.
  • Must be unique and distinguishable from any existing connector title.
  • Should be the name of your product or organization.
  • Should follow existing naming patterns for certified connectors. For independent publishers, the connector name should follow the pattern, Connector Name (Independent Publisher).
  • Can't be longer than 30 characters.
  • Can't contain the words API, Connector, or any of our Power Platform product names (for example, Power Apps).
  • Can't end in a nonalphanumeric character, including carriage return, new line, or blank space.

Examples

  • Good connector titles: Azure Sentinel, Office 365 Outlook
  • Poor connector titles: Azure Sentinel's Power Apps Connector, Office 365 Outlook API

Write a description for your connector

  • Must exist and be written in English.
  • Must be free of grammatical and spelling errors.
  • Should describe concisely the main purpose and value offered by your connector.
  • Can't be shorter than 30 characters or longer than 500 characters.
  • Can't contain any Power Platform product names (for example, "Power Apps").

Design an icon for your connector

This section doesn't apply to independent publishers.

  • Create a logo of with 1:1 dimensions within a range of 100 x 100 to 230 × 230 pixels (no rounded edges).
  • Use a non-transparent, nonwhite color (#ffffff) background, and not-default color (#007ee5) that matches your specified icon background color.
  • Ensure the icon is unique to any other certified connector icon.
  • Submit the logo in PNG format as <icon>.png.
  • Set logo dimensions below 70% for the image's height & width with a consistent background.
  • Ensure brand color is a valid hexadecimal color and shouldn't be white (#ffffff) or default (#007ee5).

Define operation and parameter summaries and descriptions

  • Must exist and be written in English.
  • Must be free of grammatical and spelling errors.
  • Operation and parameter summaries should be phrases of 80 characters or shorter, and contain only alphanumeric characters or parentheses.
  • Operation and parameter descriptions should be full, descriptive sentences, and end in punctuation.
  • Can't contain any of the Microsoft Power Platform product names (for example, "Power Apps").

Define exact operation responses

  • Define operation responses with an exact schema only with expected responses.
  • Don't use default responses with an exact schema definition.
  • Provide valid response schema definitions for all operations in the swagger.
  • Empty response schemas aren't allowed except in special cases where the response schema is dynamic. This means no dynamic content is shown in the output and makers must use JSON to parse the response.
  • Empty operations aren't allowed.
  • Remove empty properties unless they're required.

Verify swagger properties

  • Ensure the "openapidefinition" is in a correctly formatted JSON file.
  • Ensure swagger definition complies with the OpenAPI 2.0 standard and the connectors’ extended standard.

Verify connection parameters

  • Ensure the property is updated with appropriate values for "UIDefinition" (display name, description).

  • If your connection parameter uses Basic authentication, ensure JSON is formatted correctly as the following example.

    {
  "username": {
    "type": "securestring",
    "uiDefinition": {
      "displayName": "YourUsernameLabel",
      "description": "The description of YourUsernameLabel for this api",
      "tooltip": "Provide the YourUsernameLabel tooltip text",
      "constraints": {
        "tabIndex": 2,
        "clearText": true,
        "required": "true"
        }
  }
},
  "password": {
    "type": "securestring",
    "uiDefinition": {
      "displayName": "YourPasswordLabel",
      "description": "The description of YourPasswordLabel for this api",
      "tooltip": "Provide the YourPasswordLabel tooltip text",
      "constraints": {
        "tabIndex": 3,
        "clearText": false,
        "required": "true"
      }
    }
  }
}

  • If your connection parameter has APIKey as authentication, ensure JSON is formatted correctly as the following example.

    {
  "api_key": {
    "type": "securestring",
    "uiDefinition": {
      "displayName": "YourApiKeyParameterLabel",
      "tooltip": "Provide your YourApiKeyParameterLabel tooltip text",
      "constraints": {
        "tabIndex": 2,
        "clearText": false,
        "required": "true"
      }
    }
  }
}

  • If your connection parameter has Generic OAuth as authentication, ensure JSON is formatted correctly as the following example.

    {
  "token": {
    "type": "oAuthSetting",
    "oAuthSettings": {
      "identityProvider": "oauth2",
      "scopes": [
        "scope1"
      ],
      "redirectMode": "GlobalPerConnector",
      "customParameters": {
        "AuthorizationUrl": {
          "value": "https://contoso.com"
        },
        "TokenUrl": {
          "value": "https://contoso.com"
        },
        "RefreshUrl": {
          "value": "https://contoso.com"
        }
      },
      "clientId": "YourClientID"
    },
    "uiDefinition": null
  }
}

  • If your connection parameter has OAuth2 identity provider, ensure the identity provider is from the list of supported OAuth2 providers. Following is the example of GitHub OAuth2 identity provider:

    {
  "token": {
    "type": "oAuthSetting",
    "oAuthSettings": {
      "identityProvider": "github",
      "scopes": [
        "scope1"
      ],
      "redirectMode": "GlobalPerConnector",
      "customParameters": {},
      "clientId": "YourClientId"
    },
    "uiDefinition": null
  }
}

  • If your connection parameter has Microsoft Entra ID as authentication, ensure JSON is formatted correctly as the following example.

    {
  "token": {
    "type": "oAuthSetting",
    "oAuthSettings": {
      "identityProvider": "aad",
      "scopes": [
        "scope1"
      ],
      "redirectMode": "GlobalPerConnector",
      "customParameters": {
        "LoginUri": {
          "value": "https://login.microsoftonline.com"
        },
        "TenantId": {
          "value": "common"
        },
        "ResourceUri": {
          "value": "resourceUri"
        },
        "EnableOnbehalfOfLogin": {
          "value": false
        }
      },
      "clientId": "AzureActiveDirectoryClientId"
    },
    "uiDefinition": null
  }
}

Create quality English language strings

Connectors are localized as part of Power Automate localization; therefore, when you're developing a connector, the quality of the English language strings is key to the translation quality. Here are some major areas to focus on as you create the values of the strings you provide.

  • To ensure all string values are free of typographical errors, make sure to run a spell check program. If there's any incomplete English language string, the translation result is incomplete or incorrect in context.

  • Make sure the sentence is in complete form. If the sentence isn't complete, that can also generate lower quality translations.

  • Make sure the meaning of the sentence is clear. If the meaning of the sentence is ambiguous, that can also generate lower quality or incorrect translations.

  • Make sure summaries, x-ms-summaries, and descriptions are grammatically correct. Don't copy and paste them. To learn how they're shown within the product, go to Connector string guidance.

  • Avoid runtime composite strings, if possible. Use fully formed sentences instead. Concatenated strings or sentences make it difficult to translate, or can cause a wrong translation.

  • If you use abbreviations, make sure to capitalize them to make it clear. This reduces the chance of it being mistaken for a typographical error.

  • Strings in CaMel form (ex. minimizeHighways or MinimizeHighways) are typically considered nontranslatable. If you want to localize the string value, you should fix the CaMel form string.

Step 3: Run the Solution Checker to validate your connector

Solution Checker is a mechanism to conduct static analysis to ensure your connector is adhering to the standards required by Microsoft for certification. Add your connector to a solution in Power Automate or Power Apps and run the solution checker by following the instructions at Validate a custom connector with solution checker.

Watch this video to learn how to run the Solution Checker!

Step 4: Add metadata

Your connector artifacts (files) must contain specific metadata describing the connector and its end service. The information provided in metadata is published in our connector documentation and is publicly accessible by all users. Don't provide any private or confidential information, and let us know through your Microsoft contact if there are any issues in providing us with this information. To learn how the metadata is documented, visit any one of the connector-specific documentation pages under Connector reference.

Step 4a: publisher and stackOwner properties

  • "publisher" is the name of your company or organization. Provide the full company name (for example, "Contoso Corporation"). This must be in alphanumeric format.

  • "stackOwner" is the owning company or organization of the back-end service stack that the connector is connecting to. This must be in alphanumeric format.

Publisher Description Example
Verified The publisher and stackOwner are the same, unless the ISV is building a connector on behalf of a stackOwner. "publisher": "Tesla",
"stackOwner": "Tesla"
Independent You must provide stack owner and publisher owner. "publisher": "Nirmal Kumar",
"stackOwner": "ITGlue"

File Location: apiProperties.json
To learn more, go to API Properties file.

Syntax: The publisher and stackOwner properties exist as top-level properties within the apiProperties.json file. Add the following highlighted lines as shown. Ensure that you enter the property name and schema exactly as shown.

Screenshot showing publisher and stackOwner properties, which are available in Sample code snippets.

Step 4b: Product or end service metadata

  • "contact" describes how users can contact the product or end service support resources for assistance or troubleshooting. Provide one value for each of the following:

    • Name of your support team
    • URL of your support website
    • Support email

  • "Website" is the product or end service website. It gives users information about the product or end service they're using with the connector. This should be a URL.

  • "Privacy policy" refers to the public privacy policy of the product or end service, or its company or organization. This should be a URL.

  • "Categories" refer to a logical classification of your connector using a maximum of two of the following categories: AI, Business Management, Business Intelligence, Collaboration, Commerce, Communication, Content and Files, Finance, Data, Human Resources, Internet of Things, IT Operations, Lifestyle and Entertainment, Marketing, Productivity, Sales and CRM, Security, Social Media, Website.

File Location: apiDefinition.swagger.json

Syntax: The contact object is a standard field defined by the OpenAPI contract under the top-level info property. Website, Privacy policy, and Categories are defined in a custom top-level extension called x-ms-connector-metadata. The Categories property value is a semicolon-delimited string. Add the red-lined code snippets as shown. Ensure you enter the schema exactly as shown; don't change the propertyName.

Screenshot showing x-ms-connector-metadata, which is available as a usable example in Sample code snippets

Step 4c: Sample code snippets

You can use the following code snippets to copy and enter your information. Ensure that you add the snippets to the correct files in the correct locations as described in the preceding section.

    "publisher": "_____",
    "stackOwner": "_____"

    "contact": {
      "name": "_____",
      "url": "_____",
      "email": "_____"
    }

    "x-ms-connector-metadata": [
      {
        "propertyName": "Website",
        "propertyValue": "_____"
      },
      {
        "propertyName": "Privacy policy",
        "propertyValue": "_____"
      },
      {
        "propertyName": "Categories",
        "propertyValue": "_____;_____"
      }
    ]

Note

There is a current limitation in the use of the stackOwner property and the Paconn CLI tool. For more information, go to Limitations in the README file.

Step 4d: JSON file formatting and limitations

  • Make sure your properties are correctly aligned.

  • Paste your JSON into Visual Studio Code. Feel free to use extensions such as spell checkers, and plugins such as JSON plugins.

  • Swagger files shouldn't be greater than 1 MB.

    • Consider the design of your connector before your start building it. Evaluate if the connector should be broken down into two (2) or more connectors.
    • Larger swagger files might cause a delay when using the connector.

    For example, there are three (3) different HubSpot connectors on the platform.

    Screenshot of folders for the three HubSpot connectors.

Step 4e: Validate your custom connector files

Run paconn validate --api-def [Location of apiDefinition.swagger.json]. This tool validates your connector definition and lets you know of any errors you need to fix before submission.

If your connector uses OAuth as its authentication type, add these allowed redirect URLs to your app:

  • https://global.consent.azure-apim.net/redirect/{apiname}

  • https://global-test.consent.azure-apim.net/redirect/{apiname}

Step 5: Prepare the connector artifacts

This step should take you about one week to complete.

Note

  • Ensure that you've followed the specifications and have ensured the quality of your connector before certification. Failure to do so will result in delays in certification because you'll be asked to make changes.
  • Provide a production version of the host URL. Staging, dev, and test host URLs aren't allowed.

You're submitting to Microsoft a set of files called connector artifacts, downloaded by using a command-line interface (CLI) tool provided by Microsoft. This tool validates your connector for any breaking errors.

Follow these steps to get started:

  1. Install the Microsoft Power Platform Connectors CLI tool by following the installation instructions.

  2. Sign in to Microsoft Power Platform using your command line by running paconn login. Follow the instructions to sign in using Microsoft's Device Code process.

  3. After you're authenticated, download your custom connector files:

    • Run paconn download. Select the environment your custom connector is located in by specifying its number in the command line, and then select the custom connector name.

    The tool downloads your connector artifacts in a folder to the file system location where you ran paconn. Depending on the type of publisher, you find various artifacts:

Publisher Artifact
Verified apiDefinition.swagger.json
apiProperties.json
settings.json
The connector icon
Independent apiDefinition.swagger.json
apiProperties.json

Both verified publishers and independent publishers download apiProperties.json in their artifacts. You need to set the IconBrandColor in this file.

  • Verified publishers: Set iconBrandColor to your brand color in the apiProperties file.
  • Independent publishers: Set iconBrandColor to "#da3b01" in the apiProperties file.
    Screenshot of a vivid orange (da3b01) icon.

Create a Readme file artifact

A Readme.md file is necessary for both independent publishers and verified publishers. You need to create a Readme.md file to document your connector's features and functionality. For an example of documentation to include, go to the Readme.md example. To learn about writing a Readme.md file, look at other Readme.md files in our GitHub repository.

If you’re an independent publisher and your connector uses OAuth, make sure you include instructions for how to obtain credentials.

Tip

Known Issues and Limitations is a great section to maintain to keep your users up-to-date.

Step 6: Submit your connector for deployment

During the submission process, you're open-sourcing your connector to our Microsoft Power Platform Connectors repository.

  1. Follow the instructions in Submit your connector for Microsoft certification to submit to GitHub and the Connector Certification Portal (Preview).

    If you're a verified publisher, you need to submit a script.csx file if you're using custom code.

  2. Once you submit a pull request to the open-source repository, Microsoft deploys and validates your connector within one to two weeks. If updates are required, allow an extra one to two weeks.

    If your connector has OAuth, submit the package in the Connector Certification Portal (Preview). Also, get the APIname from your connector submission request to update your app.

    As part of submission, Microsoft validates your connector by using the CLA-bot, Swagger Validator, and Breaking Change Detector tools. If you need to troubleshoot swagger errors, go to Fix Swagger Validator errors.

Step 7: Expectations for testing done by verified publishers

After we validate your connector, we ask you to perform thorough testing.

  1. To create an environment in the preview region in preparation for your testing, follow the instructions in Test your connector in certification.

  2. Within one week, notify your Microsoft contact that you completed testing so we can begin deployment.

  3. After you and Microsoft validate your connector's functionality and content, we stage the connector for deployment in the preview region for testing.

Step 8: Wait for deployment

After your connector is validated for testing, we deploy it across all products and regions.

Important

On average, it takes three to four weeks to deploy the connector. This is required regardless of the size or complexity of your connector, whether it's new or an update. In order to protect integrity, the connector is subjected to the same validation tasks to test functionality and content that are followed in every deployment.

We notify you by email with the names of the regions the connector will be deployed to, as deployment to regions is done in steps. If there's a deployment delay or freeze, verified publishers can find the status in the Activity Control in the Connector Certification Portal (Preview). Independent publishers are notified by email.

Production deployment

Our connector deployment schedules for production start Friday mornings, Pacific Standard Time/Pacific Daylight Time. You need to let Microsoft know that you're ready for production deployment at least 24 hours in advance for us to include your connector in the next scheduled deployment. Verified publishers can notify us in the Activity Control of the Connector Certifcation Portal (Preview). Independent publishers can notify their Microsoft contact.

Region deployment

Deployment to various regions takes place in a predetermined daily sequence. The regions are:

  • Testing.
  • US preview.
  • Asia, except Japan and India.
  • Europe, except UK.
  • Brazil, Canada, Japan, and India.
  • Australia, UK, and US.

For example, if your connector is scheduled to deploy on Monday, it deploys to the Testing region on day 1. Then, it deploys to the US preview region on Day 2. Deployment continues daily until the connector is deployed to all six regions.

We don't deploy on Saturdays, Sundays, and US holidays.

As your connector is finishing certification, we engage you about a marketing opportunity for the connector on the Power Automate blog.

Step 9: Explore post-deployment options

Here are some options you can explore after your connector is deployed:

  • Submit updates to your connector. For more information, go to Update your certified connector.

  • Monitor your connector on the community discussion forum to discover if customers encounter any issues or have feature requests for your connector.

  • Request removal of the preview tag. After the connector is publicly available for some time and meets certain requirements, it can qualify to be reassigned the general availability tag. This tag shows that the connector is a production-ready product. To learn more, go to Move your connector from preview to general availability.

Checklist before submitting

Before moving on to Submit your connector for Microsoft certification, ensure that:

Tip

  • Create YouTube videos, blogs, or other content to share samples or screenshots for how to get started with the connector.
    - Include the links in the Readme.md file so that we can add to our docs.
  • Add tooltips to your swagger file to help your users be more successful.

If you're a verified publisher (and not an independent publisher), you're asked to agree to our Partner Agreement and non-disclosure agreement when you submit for Microsoft certification. If you'd like to review these terms and language before submission, connect with your Microsoft contact.

Next step

Submit your connector for Microsoft certification

Provide feedback

We greatly appreciate feedback on issues with our connector platform, or new feature ideas. To provide feedback, go to Submit issues or get help with connectors and select your feedback type.