org.mule.runtime.oauth.api

Interface PlatformManagedConnectionDescriptor

@NoExtend
 @Experimental
public interface PlatformManagedConnectionDescriptor

Describes the configuration of an OAuth connection managed by the Anypoint Platform.

Platform Managed OAuth is an experimental feature. It will only be enabled on selected environments and scenarios. Backwards compatibility is not guaranteed.

Since:

4.3.0

Method Summary

Modifier and Type	Method and Description
String	getDisplayName()
String	getId()
Map<String,Object>	getParameters() Returns parameters additional to the standard OAuth ones that the user has configured for this connection.
String	getUri()

Method Detail

getId

String getId()

Returns:

the connection's unique id in the Anypoint Platform

getUri

String getUri()

Returns:

the URI that identifies this connection in the Anypoint Platform

getDisplayName

String getDisplayName()

Returns:

The friendly name that the user has given this connection in the Anypoint Platform

getParameters

Map<String,Object> getParameters()

Returns parameters additional to the standard OAuth ones that the user has configured for this connection. These usually correspond to custom parameters that the service provider accepts or requires on its requests, but may contain other parameters as well.

Returns:

A Map which keys are the parameter names