Waiting for engine...
Skip to main content

aiAgentProviderAccountUpdate

Update an existing AI Agent Provider account in the AI Agent Registry.

Description: This mutation modifies the metadata and credentials of an existing AI Agent Provider account linked to the authenticated user's account. The credentials must correspond to the same external provider account ID associated with the account being updated.

Input Parameters (AiAgentProviderAccountUpdateInput):

  • id: ID! - Required. The unique identifier of the provider account to be updated.
  • providerAccountName: String - Optional. The name of the account
  • providerSubType: AiAgentProviderSubType - Optional. The sub-type of the provider (e.g., CUSTOM_PROVIDER, OPENAI, ANTHROPIC).
  • metadataJson: String - Optional new metadata associated with the provider in JSON format.
  • credentials: String
    • Description: Optional external provider-specific credential used for connecting to the provider.
    • Example: API key.
  • providerAccountStatus: AiAgentProviderAccountStatus - (Optional) - The new status of the provider (e.g., ENABLED, DISABLED, CONNECTED).

Response:

  • Returns the updated AiAgentProviderAccount object.

Example Request:

mutation UpdateAiAgentProviderAccount {
aiAgentProviderAccountUpdate(input: {
id: "ai-provider-account-12345",
providerSubType = CUSTOM_PROVIDER
metadataJson: "{ \"newKey\": \"newValue\" }",
credentials: "new-secret-key",
providerAccountStatus: ENABLED
}) {
id
providerType
providerSubType
providerAccountName
externalProviderAccountId
providerAccountStatus
metadataJson
region
idpAccountId
authSchema
}
}

Example Request for Salesforce

mutation {
aiAgentProviderAccountUpdate(input: {
id: "ai-provider-account-12345",
providerAccountName: "Salesforce provider account"
credentials: "{ \"clientId\": \"new_client_id\", \"clientSecret\": \"new_client_secret\" }"
}
) {
id
providerType
providerSubType
providerAccountName
providerAccountDescription
externalProviderAccountId
region
metadataJson
idpAccountId
providerAccountStatus
auditData {
createdByUserId
createdTime
modifiedByUserId
modifiedTime
updatedByOrigin
updatedAtProviderTime
}
authSchema
isDeleted
trustLevel
numberOfAgents
syncData {
lastSyncStatus
lastSyncStartDate
lastSyncEndDate
}
clientId
authUrl
}
}

aiAgentProviderAccountUpdate(
input: AiAgentProviderAccountUpdateInput!
): AiAgentProviderAccount

Arguments

aiAgentProviderAccountUpdate.input ● AiAgentProviderAccountUpdateInput! non-null input agent-control-tower

Type

AiAgentProviderAccount object agent-control-tower

Represents an AI Agent Provider Account in the AI Agent Registry.

On this Page