MuleSoft IDP Universal 🌐 Rest Smart Connector 🔌 icon

MuleSoft IDP Universal 🌐 Rest Smart Connector 🔌

1.0.x
(0 reviews)

IDPOS-Authentication

Two Authentication Methods required to support both runtime:

PLEASE NOTE: This is going to be to HARD - as the connector SDK really is designed to use ONE at anyone time
but I would like the Basic Authentication to be ALWAYS used at design time to load the Action and Version dropdowns.

And then at RUNTIME the Bascic or Oauth to be used to access the resources.
Currently supported IDP Runtime Regions
  • idp-rt.us-east-1.anypoint.mulesoft.com
  • idp-rt.eu-central-1.eu1.anypoint.mulesoft.com
Currently supported Anypoint Runtime Regions
  • anypoint.mulesoft.com
  • eu1.anypoint.mulesoft.com
Runtime PlatformConnector Operation NameRequired AuthenticationURL
MuleSoft IDP Runtime ServicesIDP Submit Doc ExecutionOAuth 2.0 Client Credentialshttps://idp-rt.us-east-1.anypoint.mulesoft.com/idp/api/v1/organizations/{organizationId}/actions/{actionId}/versions/{version}/executions
MuleSoft IDP Runtime ServicesIDP Retrieve Execution ResultOAuth 2.0 Client Credentialshttps://idp-rt.us-east-1.anypoint.mulesoft.com/idp/api/v1/organizations/{organizationId}/actions/{actionId}/versions/{version}/executions/{executionId}?valueOnly=true
MuleSoft IDP Runtime ServicesIDP List Pending Review TasksBasic Authenticationhttps://idp-rt.us-east-1.anypoint.mulesoft.com/idp/api/v1/organizations/{organizationId}/reviews?page=0\&size=10
MuleSoft IDP Runtime ServicesIDP Delete a Review TaskBasic Authenticationhttps://idp-rt.us-east-1.anypoint.mulesoft.com/idp/api/v1/organizations/{organizationId}/actions/{actionId}/reviews/{executionId}
MuleSoft IDP Runtime ServicesIDP Retrieve a Review TaskBasic Authenticationhttps://idp-rt.us-east-1.anypoint.mulesoft.com/idp/api/v1/organizations/{organizationId}/actions/{actionId}/reviews/{executionId}
MuleSoft IDP Runtime ServicesIDP Update a Review TaskBasic Authenticationhttps://idp-rt.us-east-1.anypoint.mulesoft.com/idp/api/v1/organizations/{organizationId}/actions/{actionId}/reviews/{executionId}
MuleSoft Platform Services for IDPPlatform IDP List ActionsBasic Authenticationhttps://anypoint.mulesoft.com/idp/api/v1/organizations/{organizationId}/actions?page=0\&sort=updatedAt,desc
MuleSoft Platform Services for IDPPlatform IDP Retrieve Action DetailBasic Authenticationhttps://anypoint.mulesoft.com/idp/api/v1/organizations/{organizationId}/actions/{actionId}
MuleSoft Platform Services for IDPPlatform IDP List Action's VersionsBasic Authenticationhttps://anypoint.mulesoft.com/idp/api/v1/organizations/{organizationId}/actions/{actionId} /versions?page=0\&size=10\&sort=version,desc
MuleSoft Platform Services for IDPPlatform IDP List Action’s ReviewersBasic Authenticationhttps://anypoint.mulesoft.com/idp/api/v1/organizations/{organizationId}/actions/{actionId} /reviewers
securitySchemes:
  mulesoft-connectedApp-oauth:
    displayName: 🛡️ MuleSoft Connected App OAuth 2.0
    type: OAuth 2.0
    description: |

        ### [Configure Connected Apps](https://docs.mulesoft.com/idp/automate-document-processing-with-the-idp-api#create-a-connected-app)

        ```
          curl --location --request POST 'https://anypoint.mulesoft.com/accounts/api/v2/oauth2/token' \
          --header 'Content-Type: application/json' \
          --data-raw '{
            "grant_type": "client_credentials",
            "client_id": "<connected-app-client-id>",
            "client_secret": "<connected-app-client-secret>"
          }'
        ```
    settings:
      accessTokenUri: https://{mulesoftAnypointRegion}/accounts/api/v2/oauth2/token
      authorizationGrants:
        - client_credentials
    describedBy:
      headers:
        Authorization:
          description: |
            Used to send a valid OAuth 2 access token. Bearer 234235246236236326
          type: string
          example: Bearer 0695bab3-e776-4d33-b61d-092789cb8765
          pattern: ^Bearer [{]?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$
      responses:
        401:
          description: |
            Bad or expired token. This can happen if the API consumer uses a revoked or expired access token. To fix you should re-authenticate the user.
          body:
            application/problem+json:
              type: object-commonError
        403:
          description: |
            Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.
          body:
            application/problem+json:
              type: object-commonError
  mulesoft-basic-login:
    type: Basic Authentication
    displayName: 🛡️ MuleSoft Anypoint Login
    describedBy:
      responses:
        "200":
          body:
            application/json:
              properties:
                access_token:
                  example: d127e2ec-a703-4e2a-8629-e9158804748ble
                  type: string
                token_type:
                  example: bearer
                  type: string

Reviews