• management
• Management
• ConnectionOptionsAmazon

Interface ConnectionOptionsAmazon

Options for the 'amazon' connection

interface ConnectionOptionsAmazon {
client_id?: string;
client_secret?: string;
freeform_scopes?: ConnectionScopeArray;
postal_code?: boolean;
profile?: boolean;
scope?: ConnectionScopeArray;
set_user_root_attributes?: Management.ConnectionSetUserRootAttributesEnum;
upstream_params?: ConnectionUpstreamParams;
non_persistent_attrs?: ConnectionNonPersistentAttrs;
key: string: any;
}

Hierarchy (View Summary)

• ConnectionOptionsCommon
  • ConnectionOptionsAmazon

Indexable

Accepts any additional properties

Index

Properties

client_id?client_secret?freeform_scopes?postal_code?profile?scope?set_user_root_attributes?upstream_params?non_persistent_attrs?

Properties

Optionalclient_id

client_id?: string

Optionalclient_secret

client_secret?: string

Optionalfreeform_scopes

freeform_scopes?: ConnectionScopeArray

Optionalpostal_code

postal_code?: boolean

When enabled, requests the user's postal code from Amazon during authentication. This adds the 'postal_code' scope to the authorization request.

Optionalprofile

profile?: boolean

When enabled, requests the user's basic profile information (name, email, user ID) from Amazon during authentication. This scope is always enabled for Amazon connections.

Optionalscope

scope?: ConnectionScopeArray

Optionalset_user_root_attributes

set_user_root_attributes?: Management.ConnectionSetUserRootAttributesEnum

Optionalupstream_params

upstream_params?: ConnectionUpstreamParams

Optionalnon_persistent_attrs

non_persistent_attrs?: ConnectionNonPersistentAttrs

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Properties client_idclient_secretfreeform_scopespostal_codeprofilescopeset_user_root_attributesupstream_paramsnon_persistent_attrs