getOAuthIntegration: Get a Specific OAuth Integration

In rstudioapi: Safely Access the RStudio API

Get a Specific OAuth Integration

Description

Retrieve metadata for a specific OAuth integration by its globally unique identifier. This is a convenience function that calls findOAuthIntegration(guid = guid).

Usage

getOAuthIntegration(guid)

Arguments

guid	The globally unique identifier (GUID) of the OAuth integration to retrieve.

Value

A list containing the integration metadata:

type

The integration type (e.g., "custom").

name

The integration name.

display_name

The display name (may be NULL).

client_id

The OAuth client ID.

auth_url

The authorization URL.

token_url

The token URL.

scopes

A character vector of OAuth scopes.

issuer

The OAuth issuer URL.

authenticated

Boolean indicating if currently authenticated.

guid

The globally unique identifier for this integration.

Returns NULL if no integration with the specified GUID is found.

Note

This function requires Posit Workbench version 2026.01.0 or later. It works in any IDE running within a Posit Workbench session (not just RStudio).

Examples

## Not run: 
# Get a specific integration by GUID
integration <- getOAuthIntegration("4c1cfecb-1927-4f19-bc2f-d8ac261364e0")

if (!is.null(integration)) {
  cat("Found integration:", integration$name, "\n")
  cat("Authenticated:", integration$authenticated, "\n")

  # Get credentials if authenticated
  if (integration$authenticated) {
    creds <- getOAuthCredentials(audience = integration$guid)
  }
}

## End(Not run)

rstudioapi documentation built on Jan. 16, 2026, 5:18 p.m.