Skip to content

[ENG-4086] feat(provider-apps): providerInputs on create/update + customInputs metadata #384

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
RajatPawar wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[ENG-4086] feat(provider-apps): providerInputs on create/update + customInputs metadata #384

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions api/api.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -489,6 +489,13 @@ paths:
- write
metadata:
$ref: "#/components/schemas/ProviderAppMetadata"
providerInputs:
type: object
description: Builder-supplied custom-auth input values keyed by CustomAuthInput.name (excluding the reserved clientId/clientSecret). Routed by fieldType — sensitive (password) values are stored encrypted, non-sensitive (text/select) values are stored in metadata.
additionalProperties:
type: string
example:
subscriptionKey: my-subscription-key
required: true
responses:
200:
Expand Down Expand Up @@ -591,6 +598,7 @@ paths:
- provider
- scopes
- metadata
- providerInputs
example: ["externalRef", "clientId"]
providerApp:
type: object
Expand Down Expand Up @@ -623,6 +631,13 @@ paths:
- write
metadata:
$ref: "#/components/schemas/ProviderAppMetadata"
providerInputs:
type: object
description: Builder-supplied custom-auth input values keyed by CustomAuthInput.name (excluding the reserved clientId/clientSecret). A providerInputs update replaces the full set. Routed by fieldType — sensitive (password) values are stored encrypted, non-sensitive (text/select) values are stored in metadata.
additionalProperties:
type: string
example:
subscriptionKey: my-subscription-key
description:
The provider app fields to update. (Only include the
fields you'd like to update.)
Expand Down Expand Up @@ -5247,6 +5262,10 @@ components:
packageInstallURL: https://login.salesforce.com/packaging/installPackage.apexp?p0=04t123456789
gcpProjectId: my-gcp-project
gcpPubSubTopicName: my-topic
customInputs:
description: Non-sensitive builder ProviderInput values (fieldType text/select), keyed by input name. Read-only in responses; set via the request's providerInputs field.
allOf:
- $ref: "#/components/schemas/ProviderMetadata"
Integration:
title: Integration
required:
Expand Down
Loading