Waiting for engine...
Skip to main content

aiAgentProviderAccountCreate

Create a new AI Agent Registry account in the AI Agent Registry.

Description: This mutation creates a new AI Agent Provider account associated with the authenticated user’s account. Once the provider account is established, the region and authSchema fields are immutable. Furthermore, the External Provider Account Id (such as the AWS account ID) linked to the provider account cannot be modified after the account has been created. The system retrieves the External Provider Account Id using the provided credentials.

Input Parameters (AiAgentProviderAccountCreateInput):

  • providerType: AiAgentProviderType! - Required. The type of the provider (e.g., AWS_BEDROCK, BOOMI).
  • providerSubType: AiAgentProviderSubType - Optional. The sub-type of the provider (e.g., CUSTOM_PROVIDER, OPENAI, ANTHROPIC). Defaults to CUSTOM_PROVIDER if not specified.
  • providerAccountName: String! - Required. The name of the account
  • providerAccountDescription : String - Optional. Description for the provider account.
  • region: String - Optional region in which provider's account exists. Note: This field is required if the authSchema is set to a provider that requires a region.
  • metadataJson: String - Optional metadata associated with the provider in JSON format.
  • credentials: String
    • Description: External provider-specific credential used for connecting to the provider.
    • Example: API key.
  • externalAccountId: String - Optional Id of the external account that contains the Agents. e.g. AWS account ID
  • authSchema: AiProviderAuthSchema - Required. The authentication mechanism supported by this AI Agent Provider

Response:

  • Returns the newly created AiAgentProviderAccount object.

Example Request:

mutation CreateAiAgentProviderAccount {
aiAgentProviderAccountCreate(input: {
providerType: AWS_BEDROCK,
providerSubType: CUSTOM_PROVIDER ,
providerAccountName: "Provider Account Name",
providerAccountDescription: "Provider Account Description",
metadataJson: "{\"key\": \"value\"}",
region: "us-east-1"
credentials: "my-secret-key",
authSchema: AWS
}) {
id
providerType
providerSubType
providerAccountName
providerAccountDescription
externalProviderAccountId
providerAccountStatus
region
metadataJson
idpAccountId
authSchema
}
}

Example Request for Salesforce

mutation {
aiAgentProviderAccountCreate(input: {
providerAccountName: "Salesforce provider account"
providerType: SALESFORCE
authSchema: OAUTH2
credentials: "{ \"clientId\": \"client_id\", \"clientSecret\": \"client_secret\", \"authUrl\": \"auth_url\" }"
}
) {
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
}
}

aiAgentProviderAccountCreate(
input: AiAgentProviderAccountCreateInput!
): AiAgentProviderAccount

Arguments

aiAgentProviderAccountCreate.input ● AiAgentProviderAccountCreateInput! 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