application_authentication_methods

Creates, updates, deletes, gets or lists an application_authentication_methods resource.

Overview

Name	application_authentication_methods
Type	Resource
Id	aws.sso_admin.application_authentication_methods

Fields

The following fields are returned by SELECT queries:

get_application_authentication_method

Name	Datatype	Description
iam	object	A structure that describes details for IAM authentication.

list_application_authentication_methods

Name	Datatype	Description
authentication_method	object	A structure that describes an authentication method. The contents of this structure is determined by the AuthenticationMethodType.
authentication_method_type	string	The type of authentication that is used by this method. (IAM)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_application_authentication_method	select	region		Retrieves details about an authentication method used by an application.
list_application_authentication_methods	select	region		Lists all of the authentication methods supported by the specified application.
put_application_authentication_method	replace	region, ApplicationArn, AuthenticationMethodType, AuthenticationMethod		Adds or updates an authentication method for an application.
delete_application_authentication_method	delete	region		Deletes an authentication method from an application.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_application_authentication_method

Retrieves details about an authentication method used by an application.

SELECT
iam
FROM aws.sso_admin.application_authentication_methods
WHERE region = '{{ region }}' -- required
;

list_application_authentication_methods

Lists all of the authentication methods supported by the specified application.

SELECT
authentication_method,
authentication_method_type
FROM aws.sso_admin.application_authentication_methods
WHERE region = '{{ region }}' -- required
;

REPLACE examples

put_application_authentication_method

Adds or updates an authentication method for an application.

REPLACE aws.sso_admin.application_authentication_methods
SET 
ApplicationArn = '{{ ApplicationArn }}',
AuthenticationMethodType = '{{ AuthenticationMethodType }}',
AuthenticationMethod = '{{ AuthenticationMethod }}'
WHERE 
region = '{{ region }}' --required
AND ApplicationArn = '{{ ApplicationArn }}' --required
AND AuthenticationMethodType = '{{ AuthenticationMethodType }}' --required
AND AuthenticationMethod = '{{ AuthenticationMethod }}' --required;

DELETE examples

delete_application_authentication_method

Deletes an authentication method from an application.

DELETE FROM aws.sso_admin.application_authentication_methods
WHERE region = '{{ region }}' --required
;