@salesforce/lds-adapters-platform-named-credential 1.247.0 → 1.248.0

package/src/raml/api.raml

@@ -2,7 +2,7 @@
 securedBy:
   - OAuth2
 title: Salesforce Connect API
-version: '56.0'
+version: '60.0'
 mediaType: application/json
 protocols:
   - https
@@ -30,17 +30,37 @@ types:
     type: object
     properties:
       authenticationProtocol:
-        description: Authentication protocol of the external credential
+        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: string
+            type: object
       externalCredential:
         description: External Credential DeveloperName
         type: string
@@ -48,10 +68,11 @@ types:
         description: Principal Name of principals
         type: string
       principalType:
-        description: Principal Type of principals. Allowed values are NamedPrincipal
-          or PerUserPrincipal
+        description: Principal Type of principals. Allowed values are NamedPrincipal,
+          PerUserPrincipal, or AwsStsPrincipal
         type: string
         enum:
+          - AwsStsPrincipal
           - NamedPrincipal
           - PerUserPrincipal
   CredentialMapRepresentation:
@@ -63,7 +84,7 @@ types:
         type: object
         properties:
           //:
-            type: string
+            type: object
   CredentialRepresentation:
     description: Output representation for Credential
     type: object
@@ -71,22 +92,39 @@ types:
       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:
-          - Authenticated
-          - NotAuthenticated
+          - Configured
+          - NotConfigured
+          - Unknown
       credentials:
         description: Protocol specific credentials
         type: object
         properties:
           //:
-            type: string
+            type: CredentialValueRepresentation
       externalCredential:
         description: External credential developer name
         type: string
@@ -97,8 +135,32 @@ types:
         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
@@ -260,6 +322,7 @@ types:
             - NamedPrincipal
             - PerUserPrincipal
     post:
+      displayName: postCredential
       description: POST method to create a Credential
       responses:
         '200':
@@ -267,13 +330,21 @@ types:
           body:
             application/json:
               type: CredentialRepresentation
+      queryParameters:
+        action:
+          type: string
+          required: false
+          enum:
+            - Refresh
       body:
         application/json:
-          type: CredentialInputRepresentation
+          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':
@@ -283,7 +354,8 @@ types:
               type: CredentialRepresentation
       body:
         application/json:
-          type: CredentialInputRepresentation
+          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

package/src/raml/luvio.raml

@@ -15,6 +15,8 @@ types:
     (luvio.key):
       authenticationUrl: authenticationUrl
   CredentialRepresentation:
+    (luvio.ttl): 100
+    (luvio.opaque): true
     (luvio.key):
       externalCredential: externalCredential
       principalType: principalType
@@ -28,6 +30,19 @@ types:
       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):