ConnectorAuthenticationSecretInput

A run input that chooses the secret a tool sends with its calls: a run gives the id of a secret, such as one per customer, and the tool sends its value in an HTTP header.

Kind: an object, used in requests and responses. In a request it is called ConnectorAuthenticationSecretInputInput.

In a request

Field	Type	Required	Description
externalOperationId	uuid		The id of the tool whose calls send the secret.
agentId	uuid | null		Only the participant filled by this agent sends the secret. Null: every participant does.
defaultSecretId	uuid | null		The id of the secret sent when a run does not choose one. Null: none.
headerName	string		The HTTP header the secret’s value is sent in, such as Authorization.
name	string	yes	The input’s name: a run gives the input’s value under this name. Constraints: required (empty or whitespace-only strings are rejected).
description	string | null		What the input is for, shown to whoever starts a run. Constraints: minLength: 1.
isRequired	boolean		Whether a run must give the input. A run started without a required input is refused.

{
  "externalOperationId": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
  "agentId": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
  "defaultSecretId": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
  "headerName": "...",
  "name": "...",
  "description": "...",
  "isRequired": false
}

In a response

Every field is present in a response; empty ones are null.

Field	Type	Description
externalOperationId	uuid	The id of the tool whose calls send the secret.
agentId	uuid | null	Only the participant filled by this agent sends the secret. Null: every participant does.
defaultSecretId	uuid | null	The id of the secret sent when a run does not choose one. Null: none.
headerName	string	The HTTP header the secret’s value is sent in, such as Authorization.
name	string	The input’s name: a run gives the input’s value under this name. Constraints: required (empty or whitespace-only strings are rejected).
description	string | null	What the input is for, shown to whoever starts a run. Constraints: minLength: 1.
isRequired	boolean	Whether a run must give the input. A run started without a required input is refused.

{
  "externalOperationId": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
  "agentId": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
  "defaultSecretId": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
  "headerName": "...",
  "name": "...",
  "description": "...",
  "isRequired": false
}

Where it’s used

• Inside CodePipelineCreateRequest
• Inside CodePipelineUpdateRequest
• Inside CodePipelineVersion
• Inside ManagedInteractionCreateRequest
• Inside ManagedInteractionUpdateRequest
• Inside ManagedInteractionVersion
• Inside OneShotInteractionCreateRequest
• Inside OneShotInteractionUpdateRequest
• Inside OneShotInteractionVersion
• Inside RoundRobinInteractionCreateRequest
• Inside RoundRobinInteractionUpdateRequest
• Inside RoundRobinInteractionVersion