Class: Aws::AmplifyBackend::Types::UpdateBackendAuthOAuthConfig

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb

Overview

Note:

When making an API call, you may pass UpdateBackendAuthOAuthConfig data as a hash:

{
  domain_prefix: "__string",
  o_auth_grant_type: "CODE", # accepts CODE, IMPLICIT
  o_auth_scopes: ["PHONE"], # accepts PHONE, EMAIL, OPENID, PROFILE, AWS_COGNITO_SIGNIN_USER_ADMIN
  redirect_sign_in_ur_is: ["__string"],
  redirect_sign_out_ur_is: ["__string"],
  social_provider_settings: {
    facebook: {
      client_id: "__string",
      client_secret: "__string",
    },
    google: {
      client_id: "__string",
      client_secret: "__string",
    },
    login_with_amazon: {
      client_id: "__string",
      client_secret: "__string",
    },
    sign_in_with_apple: {
      client_id: "__string",
      key_id: "__string",
      private_key: "__string",
      team_id: "__string",
    },
  },
}

The OAuth configurations for authenticating users into your Amplify app.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#domain_prefixString

The Amazon Cognito domain prefix used to create a hosted UI for authentication.

Returns:

  • (String)


3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 3477

class UpdateBackendAuthOAuthConfig < Struct.new(
  :domain_prefix,
  :o_auth_grant_type,
  :o_auth_scopes,
  :redirect_sign_in_ur_is,
  :redirect_sign_out_ur_is,
  :social_provider_settings)
  SENSITIVE = []
  include Aws::Structure
end

#o_auth_grant_typeString

The OAuth grant type to allow app users to authenticate from your Amplify app.

Returns:

  • (String)


3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 3477

class UpdateBackendAuthOAuthConfig < Struct.new(
  :domain_prefix,
  :o_auth_grant_type,
  :o_auth_scopes,
  :redirect_sign_in_ur_is,
  :redirect_sign_out_ur_is,
  :social_provider_settings)
  SENSITIVE = []
  include Aws::Structure
end

#o_auth_scopesArray<String>

The list of OAuth-related flows that can allow users to authenticate from your Amplify app.

Returns:

  • (Array<String>)


3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 3477

class UpdateBackendAuthOAuthConfig < Struct.new(
  :domain_prefix,
  :o_auth_grant_type,
  :o_auth_scopes,
  :redirect_sign_in_ur_is,
  :redirect_sign_out_ur_is,
  :social_provider_settings)
  SENSITIVE = []
  include Aws::Structure
end

#redirect_sign_in_ur_isArray<String>

Redirect URLs that OAuth uses when a user signs in to an Amplify app.

Returns:

  • (Array<String>)


3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 3477

class UpdateBackendAuthOAuthConfig < Struct.new(
  :domain_prefix,
  :o_auth_grant_type,
  :o_auth_scopes,
  :redirect_sign_in_ur_is,
  :redirect_sign_out_ur_is,
  :social_provider_settings)
  SENSITIVE = []
  include Aws::Structure
end

#redirect_sign_out_ur_isArray<String>

Redirect URLs that OAuth uses when a user signs out of an Amplify app.

Returns:

  • (Array<String>)


3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 3477

class UpdateBackendAuthOAuthConfig < Struct.new(
  :domain_prefix,
  :o_auth_grant_type,
  :o_auth_scopes,
  :redirect_sign_in_ur_is,
  :redirect_sign_out_ur_is,
  :social_provider_settings)
  SENSITIVE = []
  include Aws::Structure
end

#social_provider_settingsTypes::SocialProviderSettings

Describes third-party social federation configurations for allowing your users to sign in with OAuth.



3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 3477

class UpdateBackendAuthOAuthConfig < Struct.new(
  :domain_prefix,
  :o_auth_grant_type,
  :o_auth_scopes,
  :redirect_sign_in_ur_is,
  :redirect_sign_out_ur_is,
  :social_provider_settings)
  SENSITIVE = []
  include Aws::Structure
end