API Reference
ToolAuthenticationContract
Declares authentication requirements and argument conventions for a tool definition.
Inheritance
- Object
- ToolAuthenticationContract
Usage
Explore 5 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 4
Accepted by parameters 1
- Constructor ToolDefinition.ToolDefinition
Constructors
public ToolAuthenticationContract() #Methods
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public Boolean IsAuthenticationAware { get; set; } #True when tool exposes authentication behavior/requirements.
public Boolean RequiresAuthentication { get; set; } #True when authentication is required for normal operation.
public String AuthenticationContractId { get; set; } #Stable authentication contract identifier.
public ToolAuthenticationMode Mode { get; set; } #Strategy used for authentication source selection.
public String ProfileIdArgumentName { get; set; } #Argument name used by ToolAuthenticationMode.ProfileReference.
public String RunAsProfileIdArgumentName { get; set; } #Argument name used by ToolAuthenticationMode.RunAsReference.
public Boolean SupportsConnectivityProbe { get; set; } #True when tool should expose a preflight connectivity/auth probe flow.
public String ProbeToolName { get; set; } #Optional probe tool name to validate authentication before mutating operations.
public String ProbeIdArgumentName { get; set; } #Argument name used when ToolAuthenticationContract.SupportsConnectivityProbe is enabled.
Fields
public const String DefaultContractId #Default contract id for IX tool authentication metadata.
ix.tool-auth.v1