rstudioapi (version 0.18.0)

findOAuthIntegration: Find OAuth Integration by Criteria

Description

Search for an OAuth integration that matches the specified criteria. Returns the first integration that matches all provided filter parameters. If no parameters are provided, returns the first available integration.

Usage

findOAuthIntegration(
  name = NULL,
  display_name = NULL,
  guid = NULL,
  authenticated = NULL
)

Value

A list containing the integration metadata, or NULL if no matching integration is found.

Arguments

name

Optional integration name to match. Supports regular expressions. For exact matches, use anchors like ^github-main$.

display_name

Optional display name to match. Supports regular expressions. For exact matches, use anchors like ^GitHub Production$.

guid

Optional globally unique identifier (GUID) to match. Exact match only.

authenticated

Optional logical indicating whether to match only authenticated integrations (TRUE), only unauthenticated integrations (FALSE), or either (NULL, the default). Exact match only.

Examples

if (FALSE) {
# Find by exact name
integration <- findOAuthIntegration(name = "^my-github-integration$")

# Find by name pattern (any integration with "github" in the name)
integration <- findOAuthIntegration(name = "github")

# Find authenticated integration by display name pattern
integration <- findOAuthIntegration(display_name = "GitHub.*", authenticated = TRUE)

# Find by exact GUID
integration <- findOAuthIntegration(guid = "4c1cfecb-1927-4f19-bc2f-d8ac261364e0")
}