Class: Aws::AmplifyBackend::Types::CreateBackendAuthOAuthConfig
- Inherits:
-
Struct
- Object
- Struct
- Aws::AmplifyBackend::Types::CreateBackendAuthOAuthConfig
- Defined in:
- gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb
Overview
When making an API call, you may pass CreateBackendAuthOAuthConfig data as a hash:
{
domain_prefix: "__string",
o_auth_grant_type: "CODE", # required, accepts CODE, IMPLICIT
o_auth_scopes: ["PHONE"], # required, accepts PHONE, EMAIL, OPENID, PROFILE, AWS_COGNITO_SIGNIN_USER_ADMIN
redirect_sign_in_ur_is: ["__string"], # required
redirect_sign_out_ur_is: ["__string"], # required
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",
},
},
}
Creates the OAuth configuration for your Amplify project.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#domain_prefix ⇒ String
The domain prefix for your Amplify app.
-
#o_auth_grant_type ⇒ String
The OAuth grant type that you use to allow app users to authenticate from your Amplify app.
-
#o_auth_scopes ⇒ Array<String>
List of OAuth-related flows used to allow your app users to authenticate from your Amplify app.
-
#redirect_sign_in_ur_is ⇒ Array<String>
The redirected URI for signing in to your Amplify app.
-
#redirect_sign_out_ur_is ⇒ Array<String>
Redirect URLs that OAuth uses when a user signs out of an Amplify app.
-
#social_provider_settings ⇒ Types::SocialProviderSettings
The settings for using social providers to access your Amplify app.
Instance Attribute Details
#domain_prefix ⇒ String
The domain prefix for your Amplify app.
1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 1025 class CreateBackendAuthOAuthConfig < 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 that you use to allow app users to authenticate from your Amplify app.
1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 1025 class CreateBackendAuthOAuthConfig < 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>
List of OAuth-related flows used to allow your app users to authenticate from your Amplify app.
1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 1025 class CreateBackendAuthOAuthConfig < 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>
The redirected URI for signing in to your Amplify app.
1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 1025 class CreateBackendAuthOAuthConfig < 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.
1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 1025 class CreateBackendAuthOAuthConfig < 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
The settings for using social providers to access your Amplify app.
1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 1025 class CreateBackendAuthOAuthConfig < 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 |