Salesforce Credential API

The Credential API from Salesforce — 6 operation(s) for credential.

Documentation

Specifications

Schemas & Data

OpenAPI Specification

salesforce-credential-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Salesforce Bulk API 2.0 Abort Credential API
  description: 'Salesforce Bulk API 2.0 is a simplified, REST-based interface for bulk data operations that improves on the original Bulk API. It uses a straightforward job model and supports CSV format for ingest and query jobs, enabling processing of millions of records asynchronously.

    '
  version: v63.0
  contact:
    name: Salesforce Developers
    url: https://developer.salesforce.com/
  license:
    name: Salesforce Developer Terms
    url: https://www.salesforce.com/company/legal/agreements/
servers:
- url: https://{instance}.salesforce.com/services/data/v{version}/jobs
  description: Salesforce Bulk API 2.0 jobs endpoint
  variables:
    instance:
      default: yourInstance
      description: 'The Salesforce instance identifier (e.g., na1, eu3, or a My Domain subdomain like mycompany).

        '
    version:
      default: '63.0'
      description: 'The Salesforce API version number (e.g., 63.0). Use the latest supported version for new integrations.

        '
security:
- BearerAuth: []
tags:
- name: Credential
paths:
  /data/v64.0/named-credentials/credential:
    parameters: []
    get:
      tags:
      - Credential
      summary: Salesforce Get Credential
      description: Get a credential.
      operationId: GetCredential
      parameters:
      - name: externalCredential
        in: query
        description: Fully qualified developer name of the external credential.
        required: true
        style: form
        explode: true
        schema:
          type: string
        example: example_value
      - name: principalName
        in: query
        description: Name of the external credential named principal.
        required: true
        style: form
        explode: true
        schema:
          type: string
        example: example_value
      - name: principalType
        in: query
        description: 'Type of credential principal. Values are:

          * AwsStsPrincipal

          * NamedPrincipal

          * PerUserPrincipal'
        required: true
        style: form
        explode: true
        schema:
          type: string
        example: example_value
      responses:
        '200':
          description: OK
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Wed, 22 Nov 2023 12:01:04 GMT
            Strict-Transport-Security:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: max-age=63072000; includeSubDomains
            X-Content-Type-Options:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: nosniff
            X-XSS-Protection:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: 1; mode=block
            X-Robots-Tag:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: none
            Cache-Control:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: no-cache,must-revalidate,max-age=0,no-store,private
            Vary:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Accept-Encoding
            Content-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: gzip
            Transfer-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: chunked
          content:
            application/json;charset=UTF-8:
              schema:
                allOf:
                - $ref: '#/components/schemas/SuccessfulGetCredential'
                - examples:
                  - authenticationProtocol: Custom
                    authenticationProtocolVariant: NoAuthentication
                    authenticationStatus: Configured
                    credentials: {}
                    externalCredential: Test
                    principalName: Test
                    principalType: NamedPrincipal
                contentMediaType: application/json;charset=UTF-8
              example:
                authenticationProtocol: Custom
                authenticationProtocolVariant: NoAuthentication
                authenticationStatus: Configured
                credentials: {}
                externalCredential: Test
                principalName: Test
                principalType: NamedPrincipal
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      tags:
      - Credential
      summary: Salesforce Create Credential
      description: Create a credential.
      operationId: CreateCredential
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateCredentialRequest'
              - examples:
                - authenticationProtocol: Custom
                  credentials: {}
                  externalCredential: SampleExternalCredential
                  principalName: SamplePrincipal
                  principalType: NamedPrincipal
              contentMediaType: application/json
            example:
              authenticationProtocol: Custom
              credentials: {}
              externalCredential: SampleExternalCredential
              principalName: SamplePrincipal
              principalType: NamedPrincipal
        required: true
      responses:
        '201':
          description: Created
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Wed, 22 Nov 2023 12:06:08 GMT
            Strict-Transport-Security:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: max-age=63072000; includeSubDomains
            X-Content-Type-Options:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: nosniff
            X-XSS-Protection:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: 1; mode=block
            X-Robots-Tag:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: none
            Cache-Control:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: no-cache,must-revalidate,max-age=0,no-store,private
            Vary:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Accept-Encoding
            Content-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: gzip
            Transfer-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: chunked
          content:
            application/json;charset=UTF-8:
              schema:
                allOf:
                - $ref: '#/components/schemas/successfulCreateCredential'
                - examples:
                  - authenticationProtocol: Custom
                    authenticationStatus: Unknown
                    credentials: {}
                    externalCredential: SampleExternalCredential
                    principalName: SamplePrincipal
                    principalType: NamedPrincipal
                contentMediaType: application/json;charset=UTF-8
              example:
                authenticationProtocol: Custom
                authenticationStatus: Unknown
                credentials: {}
                externalCredential: SampleExternalCredential
                principalName: SamplePrincipal
                principalType: NamedPrincipal
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      tags:
      - Credential
      summary: Salesforce Update Credential
      description: Update a credential.
      operationId: UpdateCredential
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateCredentialRequest'
              - examples:
                - externalCredential: test
                  authenticationProtocol: Custom
                  principalName: test
                  principalType: NamedPrincipal
                  credentials:
                    testCredential:
                      value: '000000'
                      encrypted: true
              contentMediaType: application/json
            example:
              externalCredential: test
              authenticationProtocol: Custom
              principalName: test
              principalType: NamedPrincipal
              credentials:
                testCredential:
                  value: '000000'
                  encrypted: true
        required: true
      responses:
        '200':
          description: ''
          headers: {}
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      tags:
      - Credential
      summary: Salesforce Delete Credential
      description: Delete a credential.
      operationId: DeleteCredential
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/DeleteCredentialRequest'
              - examples:
                - externalCredential: SampleExternalCredential
                  principalType: NamedPrincipal
                  principalName: SamplePrincipal
              contentMediaType: application/json
            example:
              externalCredential: SampleExternalCredential
              principalType: NamedPrincipal
              principalName: SamplePrincipal
        required: true
      responses:
        '200':
          description: ''
          headers: {}
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /data/v64.0/named-credentials/external-credentials:
    parameters: []
    post:
      tags:
      - Credential
      summary: Salesforce Create External Credential
      description: Create an external credential.
      operationId: CreateExternalCredential
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateExternalCredentialRequest'
              - examples:
                - developerName: SampleExternalCredential
                  masterLabel: Sample External Credential
                  authenticationProtocol: Custom
                  principals:
                  - principalName: SamplePrincipal
                    principalType: NamedPrincipal
                    sequenceNumber: 1
                  customHeaders:
                  - headerName: SampleHeader
                    headerValue: SampleHeaderValue
                    sequenceNumber: 1
              contentMediaType: application/json
            example:
              developerName: SampleExternalCredential
              masterLabel: Sample External Credential
              authenticationProtocol: Custom
              principals:
              - principalName: SamplePrincipal
                principalType: NamedPrincipal
                sequenceNumber: 1
              customHeaders:
              - headerName: SampleHeader
                headerValue: SampleHeaderValue
                sequenceNumber: 1
        required: true
      responses:
        '201':
          description: Created
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Mon, 20 Nov 2023 16:53:51 GMT
            Strict-Transport-Security:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: max-age=63072000; includeSubDomains
            X-Content-Type-Options:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: nosniff
            X-XSS-Protection:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: 1; mode=block
            X-Robots-Tag:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: none
            Cache-Control:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: no-cache,must-revalidate,max-age=0,no-store,private
            Vary:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Accept-Encoding
            Content-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: gzip
            Transfer-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: chunked
          content:
            application/json;charset=UTF-8:
              schema:
                allOf:
                - $ref: '#/components/schemas/SuccessfulCreateExternalCredential'
                - examples:
                  - authenticationProtocol: Custom
                    authenticationStatus: Unknown
                    customHeaders:
                    - headerName: SampleHeader
                      headerValue: SampleHeaderValue
                      id: 0pu2o000000KymkAAC
                      sequenceNumber: 1
                    developerName: SampleExternalCredential
                    id: 0pt2o000000CaU0AAK
                    masterLabel: Sample External Credential
                    parameters: []
                    principals:
                    - authenticationStatus: Unknown
                      id: 0pu2o000000KymjAAC
                      parameters: []
                      principalAccess: []
                      principalName: SamplePrincipal
                      principalType: NamedPrincipal
                      sequenceNumber: 1
                    relatedNamedCredentials: []
                    url: /services/data/v58.0/named-credentials/external-credentials/SampleExternalCredential
                contentMediaType: application/json;charset=UTF-8
              example:
                authenticationProtocol: Custom
                authenticationStatus: Unknown
                customHeaders:
                - headerName: SampleHeader
                  headerValue: SampleHeaderValue
                  id: 0pu2o000000KymkAAC
                  sequenceNumber: 1
                developerName: SampleExternalCredential
                id: 0pt2o000000CaU0AAK
                masterLabel: Sample External Credential
                parameters: []
                principals:
                - authenticationStatus: Unknown
                  id: 0pu2o000000KymjAAC
                  parameters: []
                  principalAccess: []
                  principalName: SamplePrincipal
                  principalType: NamedPrincipal
                  sequenceNumber: 1
                relatedNamedCredentials: []
                url: /services/data/v58.0/named-credentials/external-credentials/SampleExternalCredential
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /data/v64.0/named-credentials/named-credential-setup:
    parameters: []
    post:
      tags:
      - Credential
      summary: Salesforce Create Named Credential
      description: Create a named credential.
      operationId: CreateNamedCredential
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateNamedCredentialRequest'
              - examples:
                - developerName: SamplePrivate
                  masterLabel: SamplePrivateLabel
                  type: SecuredEndpoint
                  calloutUrl: https://api.example.com
                  externalCredentials:
                  - developerName: SampleExternalCredential
                  customHeaders:
                  - headerName: SampleHeader
                    headerValue: SampleValue
                    sequenceNumber: 1
                  calloutOptions:
                    allowMergeFieldsInBody: false
                    allowMergeFieldsInHeader: true
                    generateAuthorizationHeader: true
              contentMediaType: application/json
            example:
              developerName: SamplePrivate
              masterLabel: SamplePrivateLabel
              type: SecuredEndpoint
              calloutUrl: https://api.example.com
              externalCredentials:
              - developerName: SampleExternalCredential
              customHeaders:
              - headerName: SampleHeader
                headerValue: SampleValue
                sequenceNumber: 1
              calloutOptions:
                allowMergeFieldsInBody: false
                allowMergeFieldsInHeader: true
                generateAuthorizationHeader: true
        required: true
      responses:
        '201':
          description: Created
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Mon, 20 Nov 2023 16:54:12 GMT
            Strict-Transport-Security:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: max-age=63072000; includeSubDomains
            X-Content-Type-Options:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: nosniff
            X-XSS-Protection:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: 1; mode=block
            X-Robots-Tag:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: none
            Cache-Control:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: no-cache,must-revalidate,max-age=0,no-store,private
            Vary:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Accept-Encoding
            Content-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: gzip
            Transfer-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: chunked
          content:
            application/json;charset=UTF-8:
              schema:
                allOf:
                - $ref: '#/components/schemas/SuccessfulCreateNamedCredential'
                - examples:
                  - calloutOptions:
                      allowMergeFieldsInBody: false
                      allowMergeFieldsInHeader: true
                      generateAuthorizationHeader: true
                    calloutUrl: https://api.example.com
                    customHeaders:
                    - headerName: SampleHeader
                      headerValue: SampleValue
                      id: 0pv2o000000PAv6AAG
                      sequenceNumber: 1
                    developerName: SamplePrivate
                    externalCredentials:
                    - developerName: SampleExternalCredential
                      id: 0pt2o000000CaU0AAK
                      masterLabel: Sample External Credential
                      url: /services/data/v58.0/named-credentials/external-credentials/SampleExternalCredential
                    id: 0XA2o000000XaAQGA0
                    masterLabel: SamplePrivateLabel
                    parameters: []
                    type: SecuredEndpoint
                    url: /services/data/v58.0/named-credentials/named-credential-setup/SamplePrivate
                contentMediaType: application/json;charset=UTF-8
              example:
                calloutOptions:
                  allowMergeFieldsInBody: false
                  allowMergeFieldsInHeader: true
                  generateAuthorizationHeader: true
                calloutUrl: https://api.example.com
                customHeaders:
                - headerName: SampleHeader
                  headerValue: SampleValue
                  id: 0pv2o000000PAv6AAG
                  sequenceNumber: 1
                developerName: SamplePrivate
                externalCredentials:
                - developerName: SampleExternalCredential
                  id: 0pt2o000000CaU0AAK
                  masterLabel: Sample External Credential
                  url: /services/data/v58.0/named-credentials/external-credentials/SampleExternalCredential
                id: 0XA2o000000XaAQGA0
                masterLabel: SamplePrivateLabel
                parameters: []
                type: SecuredEndpoint
                url: /services/data/v58.0/named-credentials/named-credential-setup/SamplePrivate
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /data/v64.0/named-credentials/external-credentials/{DEVELOPER_NAME}:
    parameters: []
    put:
      tags:
      - Credential
      summary: Salesforce Update External Credential
      description: Update an external credential.
      operationId: UpdateExternalCredential
      parameters:
      - name: DEVELOPER_NAME
        in: path
        description: ''
        required: true
        schema:
          type: string
        example: example_value
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateExternalCredentialRequest'
              - examples:
                - masterLabel: Sample External Credential
                  authenticationProtocol: Custom
                  principals:
                  - principalName: SamplePrincipal
                    principalType: NamedPrincipal
                    sequenceNumber: 1
                  customHeaders:
                  - headerName: SampleHeader
                    headerValue: SampleHeaderValue
                    sequenceNumber: 1
              contentMediaType: application/json
            example:
              masterLabel: Sample External Credential
              authenticationProtocol: Custom
              principals:
              - principalName: SamplePrincipal
                principalType: NamedPrincipal
                sequenceNumber: 1
              customHeaders:
              - headerName: SampleHeader
                headerValue: SampleHeaderValue
                sequenceNumber: 1
        required: true
      responses:
        '200':
          description: OK
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Mon, 20 Nov 2023 16:55:19 GMT
            Strict-Transport-Security:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: max-age=63072000; includeSubDomains
            X-Content-Type-Options:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: nosniff
            X-XSS-Protection:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: 1; mode=block
            X-Robots-Tag:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: none
            Cache-Control:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: no-cache,must-revalidate,max-age=0,no-store,private
            Transfer-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: chunked
          content:
            application/json;charset=UTF-8:
              schema:
                allOf:
                - $ref: '#/components/schemas/SuccessfulUpdateExternalCredential'
                - examples:
                  - authenticationProtocol: Custom
                    authenticationStatus: Unknown
                    customHeaders:
                    - headerName: SampleHeader
                      headerValue: SampleHeaderValue
                      id: 0pu2o000000KymkAAC
                      sequenceNumber: 1
                    developerName: SampleExternalCredential
                    id: 0pt2o000000CaU0AAK
                    masterLabel: Sample External Credential
                    parameters: []
                    principals:
                    - authenticationStatus: Unknown
                      id: 0pu2o000000KymjAAC
                      parameters: []
                      principalAccess: []
                      principalName: SamplePrincipal
                      principalType: NamedPrincipal
                      sequenceNumber: 1
                    relatedNamedCredentials:
                    - developerName: SamplePrivate
                      id: 0XA2o000000XaAQGA0
                      masterLabel: SamplePrivateLabel
                      url: /services/data/v58.0/named-credentials/named-credential-setup/SamplePrivate
                    url: /services/data/v58.0/named-credentials/external-credentials/SampleExternalCredential
                contentMediaType: application/json;charset=UTF-8
              example:
                authenticationProtocol: Custom
                authenticationStatus: Unknown
                customHeaders:
                - headerName: SampleHeader
                  headerValue: SampleHeaderValue
                  id: 0pu2o000000KymkAAC
                  sequenceNumber: 1
                developerName: SampleExternalCredential
                id: 0pt2o000000CaU0AAK
                masterLabel: Sample External Credential
                parameters: []
                principals:
                - authenticationStatus: Unknown
                  id: 0pu2o000000KymjAAC
                  parameters: []
                  principalAccess: []
                  principalName: SamplePrincipal
                  principalType: NamedPrincipal
                  sequenceNumber: 1
                relatedNamedCredentials:
                - developerName: SamplePrivate
                  id: 0XA2o000000XaAQGA0
                  masterLabel: SamplePrivateLabel
                  url: /services/data/v58.0/named-credentials/named-credential-setup/SamplePrivate
                url: /services/data/v58.0/named-credentials/external-credentials/SampleExternalCredential
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      tags:
      - Credential
      summary: Salesforce Delete External Credential
      description: Delete an external credential.
      operationId: DeleteExternalCredential
      parameters:
      - name: DEVELOPER_NAME
        in: path
        description: ''
        required: true
        schema:
          type: string
        example: example_value
      responses:
        '204':
          description: No Content
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Wed, 22 Nov 2023 12:09:23 GMT
            Strict-Transport-Security:
              content:
                text/plain:
                  schema:
                    type: s

# --- truncated at 32 KB (74 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/salesforce/refs/heads/main/openapi/salesforce-credential-api-openapi.yml