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

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

Overview

The OAuth configurations for authenticating users into your Amplify app.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#domain_prefix ⇒ String

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

Returns:

  • (String) 


3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 3170

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_type ⇒ String

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

Returns:

  • (String) 


3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 3170

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_scopes ⇒ Array<String>

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

Returns:

  • (Array<String>) 


3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 3170

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_is ⇒ Array<String>

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

Returns:

  • (Array<String>) 


3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 3170

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_is ⇒ Array<String>

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

Returns:

  • (Array<String>) 


3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 3170

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_settings ⇒ Types::SocialProviderSettings

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

Returns:



3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 3170

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