Skip to content

Create App Authorization

appfabric_create_app_authorization R Documentation

Creates an app authorization within an app bundle, which allows AppFabric to connect to an application

Description

Creates an app authorization within an app bundle, which allows AppFabric to connect to an application.

Usage

appfabric_create_app_authorization(appBundleIdentifier, app, credential,
  tenant, authType, clientToken, tags)

Arguments

appBundleIdentifier

[required] The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.

app

[required] The name of the application.

Valid values are:

  • SLACK

  • ASANA

  • JIRA

  • M365

  • M365AUDITLOGS

  • ZOOM

  • ZENDESK

  • OKTA

  • GOOGLE

  • DROPBOX

  • SMARTSHEET

  • CISCO

credential

[required] Contains credentials for the application, such as an API key or OAuth2 client ID and secret.

Specify credentials that match the authorization type for your request. For example, if the authorization type for your request is OAuth2 (oauth2), then you should provide only the OAuth2 credentials.

tenant

[required] Contains information about an application tenant, such as the application display name and identifier.

authType

[required] The authorization type for the app authorization.

clientToken

Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.

If you don't provide this value, then Amazon Web Services generates a random one for you.

If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

tags

A map of the key-value pairs of the tag or tags to assign to the resource.

Value

A list with the following syntax:

list(
  appAuthorization = list(
    appAuthorizationArn = "string",
    appBundleArn = "string",
    app = "string",
    tenant = list(
      tenantIdentifier = "string",
      tenantDisplayName = "string"
    ),
    authType = "oauth2"|"apiKey",
    status = "PendingConnect"|"Connected"|"ConnectionValidationFailed"|"TokenAutoRotationFailed",
    createdAt = as.POSIXct(
      "2015-01-01"
    ),
    updatedAt = as.POSIXct(
      "2015-01-01"
    ),
    persona = "admin"|"endUser",
    authUrl = "string"
  )
)

Request syntax

svc$create_app_authorization(
  appBundleIdentifier = "string",
  app = "string",
  credential = list(
    oauth2Credential = list(
      clientId = "string",
      clientSecret = "string"
    ),
    apiKeyCredential = list(
      apiKey = "string"
    )
  ),
  tenant = list(
    tenantIdentifier = "string",
    tenantDisplayName = "string"
  ),
  authType = "oauth2"|"apiKey",
  clientToken = "string",
  tags = list(
    list(
      key = "string",
      value = "string"
    )
  )
)