@salesforce/lds-adapters-platform-named-credential 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,406 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '60.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v66.0
+securitySchemes:
+  OAuth2:
+    type: OAuth 2.0
+    settings:
+      authorizationUri: https://example.com/oauth/authorize
+      accessTokenUri: ''
+      authorizationGrants:
+        - implicit
+annotationTypes:
+  oas-readOnly:
+    type: boolean
+    allowedTargets: TypeDeclaration
+  oas-collectionFormat:
+    type: string
+  oas-body-name:
+    type: string
+    allowedTargets: TypeDeclaration
+types:
+  CredentialInputRepresentation:
+    description: Credential input representation
+    type: object
+    properties:
+      authenticationProtocol:
+        description: Authentication protocol of the external credential. This field
+          is optional. However if present it must match the actual protocol of the
+          External Credential.
+        type: string
+        required: false
+        enum:
+          - AwsSv4
+          - Basic
+          - Custom
+          - Jwt
+          - OAuth
+      authenticationProtocolVariant:
+        description: Authentication protocol variant of the external credential. This
+          field is optional. However if present it must match the actual protocol
+          variant of the External Credential.
+        type: string
+        required: false
+        enum:
+          - AwsSv4_STS
+          - ClientCredentialsClientSecret
+          - ClientCredentialsClientSecretBasic
+          - ClientCredentialsJwtAssertion
+          - JwtBearer
+          - NoAuthentication
+          - RolesAnywhere
+      credentials:
+        description: Protocol specific credentials
+        type: object
+        properties:
+          //:
+            type: object
+      externalCredential:
+        description: External Credential DeveloperName
+        type: string
+      principalName:
+        description: Principal Name of principals
+        type: string
+      principalType:
+        description: Principal Type of principals. Allowed values are NamedPrincipal,
+          PerUserPrincipal, or AwsStsPrincipal
+        type: string
+        enum:
+          - AwsStsPrincipal
+          - NamedPrincipal
+          - PerUserPrincipal
+  CredentialMapRepresentation:
+    description: credentials map wrapper used in CredentialInputRepresentation
+    type: object
+    properties:
+      map:
+        description: wrapped credentials map
+        type: object
+        properties:
+          //:
+            type: object
+  CredentialRepresentation:
+    description: Output representation for Credential
+    type: object
+    properties:
+      authenticationProtocol:
+        description: Authentication protocol of the external credential
+        type: string
+        required: false
+        enum:
+          - AwsSv4
+          - Basic
+          - Custom
+          - Jwt
+          - OAuth
+      authenticationProtocolVariant:
+        description: Authentication protocol variant of the external credential
+        type: string
+        required: false
+        enum:
+          - AwsSv4_STS
+          - ClientCredentialsClientSecret
+          - ClientCredentialsClientSecretBasic
+          - ClientCredentialsJwtAssertion
+          - JwtBearer
+          - NoAuthentication
+          - RolesAnywhere
+      authenticationStatus:
+        description: Authentication Status. It's authenticated if external credential
+          has all required credentials for this principal
+        type: string
+        enum:
+          - Configured
+          - NotConfigured
+          - Unknown
+      credentials:
+        description: Protocol specific credentials
+        type: object
+        properties:
+          //:
+            type: CredentialValueRepresentation
+      externalCredential:
+        description: External credential developer name
+        type: string
+      principalName:
+        description: Principal parameter name associated with these credentials
+        type: string | nil
+      principalType:
+        description: Principal Type. It's either NamedPrincipal or PerUserPrincipal
+        type: string
+        enum:
+          - AwsStsPrincipal
+          - NamedPrincipal
+          - PerUserPrincipal
+  # TODO Hand-Rolled due to issue #28 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
+  CredentialInputRepresentationWrapper:
+    description: Wrapper for CredentialInputRepresentation
+    type: object
+    properties:
+      requestBody:
+        type: CredentialInputRepresentation
+        description: Input representation to create or update credential
+  CredentialValueRepresentation:
+    description: Credential Value output representation for Credential
+    type: object
+    properties:
+      encrypted:
+        description: Credential value is encrypted
+        type: boolean
+      revision:
+        description: Revision number of the credential
+        type: integer | nil
+        required: false
+      value:
+        description: Value of the credential if not encrypted
+        type: string | nil
+        required: false
+  ExternalCredentialListRepresentation:
+    description: Output representation for External Credential List
+    type: object
+    properties:
+      externalCredentials:
+        description: List of external credentials
+        type: array
+        items:
+          type: ExternalCredentialRepresentation
+  ExternalCredentialPrincipalRepresentation:
+    description: Output representation for an External Credential principal
+    type: object
+    properties:
+      authenticationStatus:
+        description: Authentication Status for credentials
+        type: string
+        enum:
+          - Authenticated
+          - NotAuthenticated
+      principalName:
+        description: Principal name
+        type: string | nil
+      principalType:
+        description: Principal Type. It's either NamedPrincipal or PerUser
+        type: string
+        enum:
+          - NamedPrincipal
+          - PerUserPrincipal
+  ExternalCredentialRepresentation:
+    description: Output representation for External Credential
+    type: object
+    properties:
+      authenticationProtocol:
+        description: Authentication protocol of the external credential
+        type: string
+        enum:
+          - AwsSv4
+          - OAuth
+      authenticationStatus:
+        description: Authentication Status. It's authenticated if external credential
+          has all required credentials for at least one principal
+        type: string
+        enum:
+          - Authenticated
+          - NotAuthenticated
+      developerName:
+        description: External Credential developer name
+        type: string
+      masterLabel:
+        description: External Credential master label
+        type: string
+      principals:
+        description: List of principals the credential has
+        type: array
+        items:
+          type: ExternalCredentialPrincipalRepresentation
+      relatedNamedCredentials:
+        description: List of named credentials associated to the external credential
+        type: array
+        items:
+          type: NamedCredentialRepresentation
+  NamedCredentialRepresentation:
+    description: Output representation for a named credential associated to an external
+      credential
+    type: object
+    properties:
+      developerName:
+        description: NamedCredential developer name
+        type: string
+      masterLabel:
+        description: NamedCredential master label
+        type: string
+  OAuthCredentialAuthUrlInputRepresentation:
+    description: OAuth authentication flow input representation
+    type: object
+    properties:
+      externalCredential:
+        description: External Credential DeveloperName
+        type: string
+      principalName:
+        description: Principal Name of principals
+        type: string
+      principalType:
+        description: Principal Type of principals. Allowed values are NamedPrincipal,
+          PerUserPrincipal, or GlobalNamedPrincipal
+        type: string
+        enum:
+          - NamedPrincipal
+          - PerUserPrincipal
+          - GlobalNamedPrincipal
+      returnUrl:
+        description: optional return url to be applied to the authentication url
+        required: false
+        type: string
+  OAuthCredentialAuthUrlRepresentation:
+    description: Output representation for OAuth authentication url for a User's Credential
+    type: object
+    properties:
+      authenticationUrl:
+        description: OAuth authentication url for a User's Credential
+        type: string
+      externalCredential:
+        description: External Credential DeveloperName
+        type: string
+      principalName:
+        description: Credential principal name
+        type: string
+      principalType:
+        description: Credential principal type. It's either NamedPrincipal,PerUserPrincipal,
+          or GlobalNamedPrincipal
+        type: string
+        enum:
+          - NamedPrincipal
+          - PerUserPrincipal
+          - GlobalNamedPrincipal
+  # TODO Hand-Rolled due to issue #28 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
+  OAuthCredentialAuthUrlInputRepresentationWrapper:
+    description: Wrapper for OAuthCredentialAuthUrlInputRepresentation
+    type: object
+    properties:
+      requestBody:
+        type: OAuthCredentialAuthUrlInputRepresentation
+        description: Input representation to generate auth url
+/named-credentials:
+  /credential:
+    delete:
+      description: DELETE method to delete a Credential
+      responses:
+        '200':
+          description: Success
+      queryParameters:
+        externalCredential:
+          type: string
+          required: false
+        principalName:
+          type: string
+          required: false
+        principalType:
+          type: string
+          required: false
+          enum:
+            - NamedPrincipal
+            - PerUserPrincipal
+    get:
+      description: GET method to get Credential records visible to the user
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: CredentialRepresentation
+      queryParameters:
+        externalCredential:
+          type: string
+          required: false
+        principalName:
+          type: string
+          required: false
+        principalType:
+          type: string
+          required: false
+          enum:
+            - NamedPrincipal
+            - PerUserPrincipal
+    post:
+      displayName: postCredential
+      description: POST method to create a Credential
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: CredentialRepresentation
+      queryParameters:
+        action:
+          type: string
+          required: false
+          enum:
+            - Refresh
+      body:
+        application/json:
+          type: CredentialInputRepresentationWrapper
+          # TODO Hand-Rolled due to issue #28 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
+          # TODO: Hand-rolled W-8334626 due to issue #22 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
+          # required: false
+          (oas-body-name): requestBody
+    put:
+      displayName: putCredential
+      description: PUT method to replace a Credential
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: CredentialRepresentation
+      body:
+        application/json:
+          type: CredentialInputRepresentationWrapper
+          # TODO Hand-Rolled due to issue #28 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
+          # TODO: Hand-rolled W-8334626 due to issue #22 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
+          # required: false
+          (oas-body-name): requestBody
+  /credential/auth-url/o-auth:
+    post:
+      description: POST method to get the OAuth authentication url for a User External
+        Credential
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: OAuthCredentialAuthUrlRepresentation
+      body:
+        application/json:
+          type: OAuthCredentialAuthUrlInputRepresentationWrapper
+          # TODO Hand-Rolled due to issue #28 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
+          # TODO: Hand-rolled W-8334626 due to issue #22 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
+          # required: false
+          (oas-body-name): requestBody
+  /external-credentials:
+    get:
+      description: GET method to get a list of External Credential records the user
+        can authenticate to
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ExternalCredentialListRepresentation
+  /external-credentials/{developerName}:
+    get:
+      description: GET method to get basic information about External Credential
+        records the user can authenticate to
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ExternalCredentialRepresentation
+    uriParameters:
+      developerName:
+        type: string
+        required: true

package/src/raml/luvio.raml

@@ -0,0 +1,53 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'named-credential'
+(luvio.ttl): 300000
+
+types:
+  ExternalCredentialRepresentation:
+    (luvio.key):
+      developerName: developerName
+  OAuthCredentialAuthUrlRepresentation:
+    (luvio.key):
+      authenticationUrl: authenticationUrl
+  CredentialRepresentation:
+    (luvio.ttl): 100
+    (luvio.opaque): true
+    (luvio.key):
+      externalCredential: externalCredential
+      principalType: principalType
+      principalName: principalName
+
+/named-credentials/credential:
+  delete:
+    (luvio.adapter):
+      name: deleteCredential
+    (luvio.key):
+      externalCredential: queryParams.externalCredential || ''
+      principalType: queryParams.principalType || ''
+      principalName: queryParams.principalName || ''
+  get:
+    (luvio.adapter):
+      name: getCredential
+    (luvio.key):
+      externalCredential: queryParams.externalCredential || ''
+      principalType: queryParams.principalType || ''
+      principalName: queryParams.principalName || ''
+  post:
+    (luvio.adapter):
+      name: createCredential
+  put:
+    (luvio.adapter):
+      name: updateCredential
+/named-credentials/credential/auth-url/o-auth:
+  post:
+    (luvio.adapter):
+      name: getOAuthCredentialAuthUrl
+/named-credentials/external-credentials:
+  get:
+    (luvio.adapter):
+      name: getExternalCredentials