Skip to main content

IntegrationsApi

Struct IntegrationsApi 

Source
pub struct IntegrationsApi { /* private fields */ }
Expand description

OAuth integrations and connector management

Implementations§

Source§

impl IntegrationsApi

Source

pub async fn complete_o_auth( &self, provider: &StartOAuthProvider, body: &OAuthCompleteRequest, ) -> Result<AgentIntegration>

Complete OAuth after callback (exchange code for tokens, create connection)

POST /api/v1/integrations/{provider}/oauth/complete

Required scopes: agents:write.

Source

pub async fn create( &self, body: &CreateIntegrationRequest, ) -> Result<Integration>

Create integration

POST /api/v1/integrations

Required scopes: agents:write.

Source

pub async fn delete(&self, id: &str) -> Result<DeleteIntegrationResponse>

Delete integration

DELETE /api/v1/integrations/{id}

Required scopes: agents:write.

Source

pub async fn delete_agent_integration( &self, agent_id: &str, integration_id: &str, ) -> Result<Value>

Remove an integration from an agent

DELETE /api/v1/agents/{agentId}/integrations/{integrationId}

Required scopes: agents:write.

Source

pub async fn list(&self) -> Result<ListIntegrationsResponse>

List tenant integrations

GET /api/v1/integrations

Required scopes: agents:read.

Source

pub async fn list_agent_integrations( &self, agent_id: &str, ) -> Result<ListAgentIntegrationsResponse>

List integrations for an agent

GET /api/v1/agents/{agentId}/integrations

Required scopes: agents:read.

Source

pub async fn list_integrations_catalog( &self, ) -> Result<ListIntegrationsCatalogResponse>

List available integration types (connectors)

GET /api/v1/integrations/catalog

Required scopes: agents:read.

Source

pub async fn oauth_callback( &self, provider: &StartOAuthProvider, params: &OauthCallbackParams, ) -> Result<Value>

OAuth callback (redirect from provider); returns HTML that posts to complete

GET /api/v1/integrations/{provider}/oauth/callback

Required scopes: agents:read.

Source

pub async fn set_agent_integrations( &self, agent_id: &str, body: &SetAgentIntegrationsRequest, ) -> Result<SetAgentIntegrationsResponse>

Replace the set of integrations assigned to an agent

The write operation this path actually has. Integrations are CREATED tenant-wide (POST /api/v1/integrations) and then ASSIGNED here; the assignment is a replace, so ids omitted from the array are unassigned.

This document declared POST on this path until 2026-08-30, and the route answers that with 405 — it was removed in the assignment refactor and its handler exists only to name the replacement. A declared operation the server refuses is worse than an undeclared one: a generated client has the method, calls it, and reads the failure as a fault in its own request.

Owner/admin only: assignment is a tenant-policy decision, not a developer-level config change. Each assigned and unassigned id is audit-logged.

PUT /api/v1/agents/{agentId}/integrations

Required scopes: agents:write.

Source

pub async fn start_o_auth( &self, provider: &StartOAuthProvider, body: &StartOAuthRequest, ) -> Result<OAuthStartResponse>

Start OAuth flow for an integration provider

POST /api/v1/integrations/{provider}/oauth/start

Required scopes: agents:write.

Source

pub async fn test_agent_integration( &self, agent_id: &str, integration_id: &str, ) -> Result<TestAgentIntegrationResponse>

Test connectivity for an agent integration

POST /api/v1/agents/{agentId}/integrations/{integrationId}/test

Required scopes: agents:write.

Source

pub async fn test_integration( &self, id: &str, ) -> Result<TestIntegrationResponse>

Test integration

POST /api/v1/integrations/{id}/test

Required scopes: agents:write.

Source

pub async fn update( &self, id: &str, body: &UpdateIntegrationRequest, ) -> Result<Integration>

Update integration

PATCH /api/v1/integrations/{id}

Required scopes: agents:write.

Source

pub async fn update_agent_integration( &self, agent_id: &str, integration_id: &str, body: &UpdateAgentIntegrationRequest, ) -> Result<AgentIntegration>

Update an agent integration (e.g. name, config)

PATCH /api/v1/agents/{agentId}/integrations/{integrationId}

Required scopes: agents:write.

Trait Implementations§

Source§

impl Clone for IntegrationsApi

Source§

fn clone(&self) -> IntegrationsApi

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for IntegrationsApi

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more