connect.oauth.integrations

connect.oauth.integrations

OAuth integration resources.

Classes

Name	Description
Integration	OAuth integration resource.
Integrations	Integrations resource.

Integration

connect.oauth.integrations.Integration(ctx, /, **kwargs)

OAuth integration resource.

Attributes

Name	Description
associations

Methods

Name	Description
delete	Delete the OAuth integration.
update	Update the OAuth integration.

delete

connect.oauth.integrations.Integration.delete()

Delete the OAuth integration.

update

connect.oauth.integrations.Integration.update(*args, **kwargs)

Update the OAuth integration.

Integrations

connect.oauth.integrations.Integrations(ctx)

Integrations resource.

Methods

Name	Description
create	Create an OAuth integration.
find	Find OAuth integrations.
find_by	Find an OAuth integration by various criteria.
get	Get an OAuth integration.

create

connect.oauth.integrations.Integrations.create(**kwargs)

Create an OAuth integration.

Parameters

Name	Type	Default
name	str	required
description	`Optional`[str]	required
template	str	required
config	dict	required

Returns

Name	Type	Description
	Integration

find

connect.oauth.integrations.Integrations.find()

Find OAuth integrations.

Returns

Name	Type	Description
	`List`[Integration]

find_by

connect.oauth.integrations.Integrations.find_by(
    integration_type=None,
    auth_type=None,
    name=None,
    description=None,
    guid=None,
    config=None,
)

Find an OAuth integration by various criteria.

Parameters

Name	Type	Description	Default
integration_type	`Optional`[`types`.`OAuthIntegrationType` \| str]	The type of the integration (e.g., “aws”, “azure”).	`None`
auth_type	`Optional`[`types`.`OAuthIntegrationAuthType` \| str]	The authentication type of the integration (e.g., “Viewer”, “Service Account”).	`None`
name	`Optional`[str]	A regex pattern to match the integration name. For exact matches, use `^` and `$`. For example, `^My Integration$` will match only “My Integration”.	`None`
description	`Optional`[str]	A regex pattern to match the integration description. For exact matches, use `^` and `$`. For example, `^My Integration Description$` will match only “My Integration Description”.	`None`
guid	`Optional`[str]	The unique identifier of the integration.	`None`
config	`Optional`[dict]	A dictionary of configuration key-value pairs to match against the integration’s config. This will vary based on the integration type.	`None`

Returns

Name	Type	Description
	Integration \| None	The first matching integration, or None if no match is found.

get

connect.oauth.integrations.Integrations.get(guid)

Get an OAuth integration.

Parameters

Name	Type	Description	Default
guid	str		required

Returns

Name	Type	Description
	Integration