Skip to contents

Get the details of an OAuth integration

Source: R/integrations.R
get_integration.Rd

Given the GUID of an OAuth integration available on a Connect server, retrieve its details. You must have administrator or publisher privileges to perform this action.

Usage

get_integration(client, guid)

Arguments

client

A Connect R6 client object.

guid

The GUID of an integration available on the Connect server.

Value

A connect_integration object representing an OAuth integration, which has the following fields:

  • id: The internal identifier of this OAuth integration.

  • guid: The GUID of this OAuth integration.

  • created_time: The timestamp (RFC3339) indicating when this integration was created.

  • updated_time: The timestamp (RFC3339) indicating when this integration was last updated

  • name: A descriptive name to identify the OAuth integration.

  • description: A brief text to describe the OAuth integration.

  • template: The template used to configure this OAuth integration.

  • auth_type: The authentication type indicates which OAuth flow is used by this integration.

  • config: A list with the OAuth integration configuration. Fields differ between integrations.

See also

get_integrations(), get_associations(), set_integrations()

Other oauth integration functions: create_integration(), delete_integration(), get_associations(), get_integrations(), set_integrations(), update_integration()

Examples

if (FALSE) { # \dontrun{
client <- connect()
x <- get_integration(client, guid)
} # }