Skip to content

Creates an authorization code for the specified Connect Customer instance

Description

Creates an authorization code for the specified Connect Customer instance. The authorization code can be used to establish a session with scoped permissions defined by the specified scope parameters.

Usage

connect_create_auth_code(InstanceId, Scope, MaxSessionDurationMinutes,
  SessionInactivityDurationMinutes)

Arguments

  • InstanceId

[required] The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • Scope

[required] The scope for the authorization code. Defines the permissions and access boundaries for the session.

  • MaxSessionDurationMinutes

The maximum duration of the session, in minutes. Minimum value of 1440 (24 hours). Maximum value of 43200 (30 days). If no value is provided, the session will expire after 400 days.

  • SessionInactivityDurationMinutes

[required] The duration of inactivity, in minutes, after which the session expires. Minimum value of 1440 (24 hours). Maximum value of 20160 (14 days).

Value

A list with the following syntax:

list(
  AuthCode = "string",
  SessionId = "string",
  EntityType = "CUSTOMER_PROFILE",
  EntityId = "string"
)

Request syntax

svc$create_auth_code(
  InstanceId = "string",
  Scope = list(
    SecurityProfileIds = list(
      "string"
    ),
    EntityType = "CUSTOMER_PROFILE",
    EntityId = "string",
    DomainName = "string"
  ),
  MaxSessionDurationMinutes = 123,
  SessionInactivityDurationMinutes = 123
)