OAuth2 + Connection Parameters during connection creation.

[Louis-Philippe Perras (lpperras)]

I am trying to create a custom connector that will authenticate the users using OAuth2, but also need to ask for a project URL. That pattern works fine when using API Key, but doesn't seem to be working when configured for OAuth. I have 2 specific need, the first one is to be able to as for the project URL, which would then be set as a header for requests made by the power platform using the set header policy.

The other one I would like to do, is to transform the OAuth2 requests to use the same project URL in the scopes of the OAuth2 request. Basically having dynamic scopes.

I tried this for the first requirement of the header, but no luck in getting the UI to ask for the Project URL:

{ "properties": { "connectionParameters": { "token": { "type": "oauthSetting", "oAuthSettings": { "identityProvider": "oauth2", "clientId": "c995f09f-8f94-4c92-99f7-c3c4d61bc22e", "scopes": [ "openid" ], "redirectMode": "GlobalPerConnector", "redirectUrl": "https://global.consent.azure-apim.net/redirect/experlogix-20cpq3-5f7895d93834834834-5fef17f9c88018564c", "properties": { "IsFirstParty": "False", "IsOnbehalfofLoginSupported": false }, "customParameters": { "AuthorizationUrl": { "value": "https://login.microsoftonline.com/organizations/oauth2/v2.0/authorize" }, "TokenUrl": { "value": "https://login.microsoftonline.com/organizations/oauth2/v2.0/token" }, "RefreshUrl": { "value": "https://login.microsoftonline.com/organizations/oauth2/v2.0/token" } } }, "uiDefinition": { "displayName": "OAuth Connection", "description": "OAuth Connection", "constraints": { "required": "true", "hidden": "false" } } }, "project_url": { "type": "string", "uiDefinition": { "constraints": { "required": "true", "hidden": "false" }, "description": "The URL to your CPQ project.", "displayName": "Project URL", "tooltip": "Provide the URL to your CPQ project." } } }, "iconBrandColor": "#007ee5", "capabilities": [], "publisher": "Louis-Philippe Perras", "policyTemplateInstances": [ { "templateId": "setheader", "title": "ProjectUrlHeaderPolicy", "parameters": { "x-ms-apimTemplateParameter.name": "X-PROJECT-URL", "x-ms-apimTemplateParameter.value": "@connectionParameters('project_url','')", "x-ms-apimTemplateParameter.existsAction": "override", "x-ms-apimTemplate-policySection": "Request" } } ] } }

I tried changing the order of the connection parameters but it looks like as soon as it finds a token of type oauthSetting, it won't look at the others. Is there anything I'm not seeing on how to accomplish this?

Thanks!

[Troy Simeon Taylor (troystaylor)]

Hi Louis-Philippe,
You should definitely be able to do that. Take a look at the Coupa connector:
https://github.com/microsoft/PowerPlatformConnectors/blob/dev/independent-publisher-connectors/Coupa/apiProperties.json

[Louis-Philippe Perras (lpperras)]

Thanks for the quick reply! Never saw documentation on the 'token:' syntax for parameters, I will give it a shot.

[Louis-Philippe Perras (lpperras)]

I tried to mimic the pattern but it didn't work. I then tried to simply create a new custom connector, copy the apiProperties from the Coupa connector and update the custom connector using paconn. I know the oauth settings were not right but was expecting to be prompted with the parameters, but it went directly to oauth authentication.

I did try to create a connection with the certified Coupa connector and it behaves exactly as I would've expected. I'm sure there is something obvious I'm not seeing but can't figure it out. Should what I tried be prompting me for the parameters?

[Troy Simeon Taylor (troystaylor)]

Is this for a certified connector or for an internal connector? Let me alert the connector team to see if something has changed on the backend.

[Louis-Philippe Perras (lpperras)]

My intent is to have it certified, but for now this is only an internal connector. I want to play with the different settings first and then I can try getting it certified. I tried this in two environments and got the same results on my end.

[Troy Simeon Taylor (troystaylor)]

Have you tried creating the connection in the new designer and the old designer? From the designer is a slightly different experience than the connector editor

[Louis-Philippe Perras (lpperras)]

That's a good catch, I was pressing the + to create a connection from the Custom Connector view, and I see to be having a different behavior when I go into connection and create one from there. I think the properties are shown if I go from the Connections menu. Really appreciate the quick replies, I'll see if I can get farther.

Do you know if when using the connectionParameterSets instead of connectionPartameters, I can use parameters defined in the selected connection in the policy template instance?

[Breno Ludgerio (ludgerios)]

Yes, policy expressions can read connection parameters. Microsoft's Set HTTP Header policy documents @connectionParameters(...), and the Experlogix CPQ connector shows fields from connectionParameterSets referenced by setheader policies.

For your schema, if project_url is defined directly in the selected set's parameters, try:

"x-ms-apimTemplateParameter.value": "@connectionParameters('project_url', '')"

Make sure every set that needs the header defines that parameter. Your observation that the field appears when creating the connection from the Connections page is a useful clue; I'd test the connection through that path and verify the resulting header in a run. This confirms the request-policy use case; I would test dynamic OAuth scopes separately, since the cited expression documentation covers policy values, not scope configuration.

See also Microsoft's multi-auth documentation.