Amazon Cognito 사용자 풀 API 및 사용자 풀 엔드포인트 사용 - Amazon Cognito

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

Amazon Cognito 사용자 풀 API 및 사용자 풀 엔드포인트 사용

사용자 풀에 가입하고, 로그인하고, 사용자 풀에서 사용자를 관리할 때는 두 가지 옵션을 사용할 수 있습니다.

  1. 사용자 풀 엔드포인트에는 호스팅 UI페더레이션 엔드포인트가 포함됩니다. 이 엔드포인트는 사용자 풀에 사용할 도메인을 선택할 때 Amazon Cognito가 활성화하는 퍼블릭 웹 페이지 패키지를 구성합니다. 가입, 로그인, 암호 관리 및 다중 인증(MFA) 페이지를 비롯한 Amazon Cognito 사용자 풀의 인증 및 권한 부여 기능을 빠르게 시작하려면, 호스팅된 UI의 내장 사용자 인터페이스를 사용하세요. 다른 사용자 풀 엔드포인트는 서드 파티 ID 제공업체(idP)를 사용한 인증을 용이하게 합니다. 이들이 수행하는 서비스에는 다음이 포함됩니다.

    1. saml2/idpresponse 및 oauth2/idpresponse 등 IdP의 인증된 클레임을 위한 서비스 공급자 콜백 엔드포인트. Amazon Cognito가 앱과 IdP 사이의 중간 서비스 공급자(SP)인 경우 콜백 엔드포인트는 서비스를 나타냅니다.

    2. oauth2/userInfo 및 jwks.json 등 환경에 대한 정보를 제공하는 엔드포인트. 앱은 AWS SDK 및 OAuth 2.0 라이브러리를 사용하여 토큰을 확인하거나 사용자 프로필 데이터를 검색할 때 이러한 엔드포인트를 사용합니다.

  2. Amazon Cognito 사용자 풀 API는 웹 또는 모바일 앱이 자체 사용자 지정 프런트엔드에서 로그인 정보를 수집한 후 사용자를 인증하는 앱용 도구 집합입니다. 사용자 풀 API 인증은 다음 JSON 웹 토큰을 생성합니다.

    1. 사용자의 검증 가능한 속성 클레임이 포함된 자격 증명 토큰.

    2. AWS 서비스 엔드포인트에 대한 토큰 인증된 API 요청을 생성할 권한을 사용자에게 부여하는 액세스 토큰.

      참고

      기본적으로 사용자 풀 API 인증의 액세스 토큰에는 aws.cognito.signin.user.admin 범위만 포함되어 있습니다. 추가 범위가 포함된 액세스 토큰을 생성하려면(예: 서드 파티 API에 대한 요청 승인을 위해) 사용자 풀 엔드포인트를 통한 인증 중에 범위를 요청하거나 사전 토큰 생성 Lambda 트리거에서 사용자 지정 범위를 추가합니다. 액세스 토큰 사용자 지정 시에는 AWS 청구서에 비용이 추가됩니다.

일반적으로 사용자 풀 엔드포인트를 통해 로그인하는 페더레이션 사용자를 프로필이 사용자 풀에 로컬인 사용자와 연결할 수 있습니다. 로컬 사용자는 외부 IdP를 통한 페더레이션 없이 사용자 풀 디렉터리에만 존재합니다. AdminLinkProviderForUser API 요청에서 로컬 사용자에 페더레이션 자격 증명을 연결하면 해당 사용자가 사용자 풀 API로 로그인할 수 있습니다. 자세한 내용은 페더레이션 사용자를 기존 사용자 프로필에 연결 섹션을 참조하세요.

Amazon Cognito 사용자 풀 API는 두 가지 용도로 사용합니다. 이 API는 Amazon Cognito 사용자 풀 리소스를 생성하고 구성합니다. 예를 들어 사용자 풀을 만들고, AWS Lambda 트리거를 추가하고, 호스팅된 UI 도메인을 구성할 수 있습니다. 또한 사용자 풀 API는 로컬 및 연결된 사용자의 가입, 로그인 및 기타 사용자 작업을 수행합니다.

Amazon Cognito 사용자 풀 API를 사용한 예제 시나리오

  1. 앱에서 생성한 “Create an account(계정 만들기)” 버튼을 사용자가 선택합니다. 사용자가 이메일 주소와 암호를 입력합니다.

  2. 앱에서 SignUp API 요청을 보내고 사용자 풀에 새 사용자를 생성합니다.

  3. 앱에서 사용자에게 이메일 확인 코드를 입력하라는 메시지를 표시합니다. 사용자가 이메일 메시지로 받은 코드를 입력합니다.

  4. 앱은 ConfirmSignUp API 요청과 사용자의 확인 코드를 전송합니다.

  5. 앱이 사용자 이름과 암호를 입력하라는 메시지를 표시하고, 사용자가 자신의 정보를 입력합니다.

  6. 앱은 InitiateAuth API 요청을 보내고 ID 토큰, 액세스 토큰 및 새로 고침 토큰을 저장합니다. 앱은 OIDC 라이브러리를 호출하여 사용자의 토큰을 관리하고 해당 사용자의 영구 세션을 유지합니다.

Amazon Cognito 사용자 풀 API에서는 IdP를 통해 페더레이션하는 사용자를 로그인할 수 없습니다. 사용자 풀 엔드포인트를 통해 이러한 사용자를 인증해야 합니다. 호스팅 UI를 포함하는 사용자 풀 엔드포인트에 대한 자세한 내용은 사용자 풀 페더레이션 엔드포인트 및 호스팅 UI 참조 섹션을 참조하세요. 페더레이션 사용자는 호스팅 UI에서 시작하여 IdP를 선택하거나, 호스팅 UI를 건너뛰고 사용자를 IdP로 직접 보내 로그인하게 할 수 있습니다. 권한 부여 엔드포인트에 대한 API 요청에 IdP 파라미터가 포함되면, Amazon Cognito는 사용자를 자동으로 IdP 로그인 페이지로 리디렉션합니다.

사용자 풀 엔드포인트 예제 시나리오

  1. 앱에서 생성한 “Create an account(계정 만들기)” 버튼을 사용자가 선택합니다.

  2. 개발자 보안 인증 정보를 등록한 소셜 ID 공급자 목록을 사용자에게 제시합니다. 사용자가 Apple을 선택합니다.

  3. 앱에서 공급자 이름 SignInWithApple권한 부여 엔드포인트에 대한 요청을 시작합니다.

  4. 사용자의 브라우저에서 Apple OAuth 인증 페이지가 열립니다. 사용자가 Amazon Cognito가 자신의 프로필 정보를 읽도록 허용합니다.

  5. Amazon Cognito가 Apple 액세스 토큰을 확인하고 사용자의 Apple 프로필을 쿼리합니다.

  6. 사용자가 앱에 Amazon Cognito 인증 코드를 제시합니다.

  7. 앱이 인증 코드를 Token 엔드포인트와 교환하고 ID 토큰, 액세스 토큰 및 새로 고침 토큰을 저장합니다. 앱은 OIDC 라이브러리를 호출하여 사용자의 토큰을 관리하고 해당 사용자의 영구 세션을 유지합니다.

사용자 풀 API와 사용자 풀 엔드포인트는 이 안내서에서 설명하는 다양한 시나리오를 지원합니다. 다음 섹션에서는 사용자 풀 API를 가입, 로그인, 리소스 관리 요구 사항을 지원하는 클래스로 구분하는 방법을 살펴봅니다.

Amazon Cognito 사용자 풀 인증 및 미인증 API 작업

리소스 관리 인터페이스이자 사용자 대면 인증 및 권한 부여 인터페이스인 Amazon Cognito 사용자 풀 API는 운영에 동반되는 권한 부여 모델을 결합합니다. API 작업에 따라 IAM 보안 인증 정보, 액세스 토큰, 세션 토큰, 클라이언트 암호 또는 이들의 조합을 통해 인증을 제공해야 할 수 있습니다. 대부분의 사용자 인증 및 권한 부여 작업의 경우, 요청의 인증 버전과 미인증 버전을 선택할 수 있습니다. 모바일 앱처럼 사용자에게 배포하는 앱의 경우 미인증 작업이 모범 사례입니다. 코드에 암호를 포함하지 않아도 됩니다.

IAM 인증 관리 작업IAM 인증 사용자 작업에 대한 IAM 정책에서만 권한을 할당할 수 있습니다.

IAM 인증 관리 작업은 AWS Management Console에서처럼 사용자 풀 및 앱 클라이언트 구성을 수정하고 확인합니다.

예를 들어 UpdateUserPool API 요청에서 사용자 풀을 수정하려면 AWS 보안 인증 정보와 IAM 권한을 제시하여 리소스를 업데이트해야 합니다.

AWS Command Line Interface(AWS CLI) 또는 AWS SDK에서 이러한 요청을 승인하려면, 요청에 IAM 자격 증명을 추가하는 환경 변수 또는 클라이언트 구성으로 환경을 구성합니다. 자세한 내용은 AWS 일반 참조AWS 보안 인증 정보를 사용하여 AWS에 액세스를 참조하세요. Amazon Cognito 사용자 풀 API의 서비스 엔드포인트로 바로 요청을 보낼 수도 있습니다. 요청의 헤더에 삽입한 AWS 보안 인증 정보를 사용하여 이러한 요청을 승인하거나 서명해야 합니다. 자세한 내용은 AWS API 요청 서명을 참조하세요.

IAM 인증 관리 작업
AddCustomAttributes
CreateGroup
CreateIdentityProvider
CreateResourceServer
CreateUserImportJob
CreateUserPool
CreateUserPoolClient
CreateUserPoolDomain
DeleteGroup
DeleteIdentityProvider
DeleteResourceServer
DeleteUserPool
DeleteUserPoolClient
DeleteUserPoolDomain
DescribeIdentityProvider
DescribeResourceServer
DescribeRiskConfiguration
DescribeUserImportJob
DescribeUserPool
DescribeUserPoolClient
DescribeUserPoolDomain
GetCSVHeader
GetGroup
GetIdentityProviderByIdentifier
GetSigningCertificate
GetUICustomization
GetUserPoolMfaConfig
ListGroups
ListIdentityProviders
ListResourceServers
ListTagsForResource
ListUserImportJobs
ListUserPoolClients
ListUserPools
ListUsers
ListUsersInGroup
SetRiskConfiguration
SetUICustomization
SetUserPoolMfaConfig
StartUserImportJob
StopUserImportJob
TagResource
UntagResource
UpdateGroup
UpdateIdentityProvider
UpdateResourceServer
UpdateUserPool
UpdateUserPoolClient
UpdateUserPoolDomain

IAM 인증 사용자 작업은 사용자의 가입, 로그인, 보안 인증 정보 관리, 수정 및 보기를 수행합니다.

예를 들어 웹 프런트 엔드를 지원하는 서버 측 애플리케이션 계층을 보유할 수 있습니다. 서버 측 앱은 Amazon Cognito 리소스에 대한 액세스 권한이 있는 신뢰하는 OAuth 기밀 클라이언트입니다. 앱에서 사용자를 등록하려면 서버에서 AdminCreateUser API 요청에 AWS 보안 인증 정보를 포함하면 됩니다. OAuth 클라이언트 유형에 대한 자세한 내용은 OAuth 2.0 인증 프레임워크클라이언트 유형을 참조하세요.

AWS CLI 또는 AWS SDK에서 이러한 요청을 승인하려면, 요청에 IAM 자격 증명을 추가하는 환경 변수 또는 클라이언트 구성으로 서버 측 앱 환경을 구성합니다. 자세한 내용은 AWS 일반 참조AWS 보안 인증 정보를 사용하여 AWS에 액세스를 참조하세요. Amazon Cognito 사용자 풀 API의 서비스 엔드포인트로 바로 요청을 보낼 수도 있습니다. 요청의 헤더에 삽입한 AWS 보안 인증 정보를 사용하여 이러한 요청을 승인하거나 서명해야 합니다. 자세한 내용은 AWS API 요청 서명을 참조하세요.

앱 클라이언트에 클라이언트 암호가 있는 경우 AuthParameters에 IAM 보안 인증 정보와, 작업에 따라 SecretHash 파라미터 또는 SECRET_HASH 값을 입력해야 합니다. 자세한 내용은 암호 해시 값 컴퓨팅 섹션을 참조하세요.

IAM 인증 사용자 작업
AdminAddUserToGroup
AdminConfirmSignUp
AdminCreateUser
AdminDeleteUser
AdminDeleteUserAttributes
AdminDisableProviderForUser
AdminDisableUser
AdminEnableUser
AdminForgetDevice
AdminGetDevice
AdminGetUser
AdminInitiateAuth
AdminLinkProviderForUser
AdminListDevices
AdminListGroupsForUser
AdminListUserAuthEvents
AdminRemoveUserFromGroup
AdminResetUserPassword
AdminRespondToAuthChallenge
AdminSetUserMFAPreference
AdminSetUserPassword
AdminSetUserSettings
AdminUpdateAuthEventFeedback
AdminUpdateDeviceStatus
AdminUpdateUserAttributes
AdminUserGlobalSignOut

미인증 사용자 작업은 사용자의 가입, 로그인 및 암호 재설정 시작 작업을 수행합니다. 인터넷에 있는 모든 사용자가 앱에 가입하고 로그인할 수 있게 하려면 미인증, 즉 공개 API 작업을 사용해야 합니다.

예를 들어 앱에 사용자를 등록하려면 암호에 대한 어떠한 권한 액세스도 제공하지 않는 OAuth 공개 클라이언트를 배포하면 됩니다. 미인증 API 작업 SignUp을 이용해 이 사용자를 등록할 수 있습니다.

AWS SDK로 개발한 공개 클라이언트에서 이러한 요청을 보내려는 경우에는 보안 인증 정보를 구성하지 않아도 됩니다. 추가 인증 없이 Amazon Cognito 사용자 풀 API의 서비스 엔드포인트로 바로 요청을 보낼 수도 있습니다.

앱 클라이언트에 클라이언트 암호가 있는 경우 작업에 따라 AuthParametersSecretHash 파라미터 또는 SECRET_HASH 값을 입력해야 합니다. 자세한 내용은 암호 해시 값 컴퓨팅 섹션을 참조하세요.

미인증 사용자 작업
SignUp
ConfirmSignUp
ResendConfirmationCode
ForgotPassword
ConfirmForgotPassword
InitiateAuth

토큰으로 권한이 부여된 사용자 작업은 사용자가 로그인하거나 로그인 프로세스를 시작한 후 사용지 로그아웃, 보안 인증 정보 관리, 수정 및 확인 작업을 수행합니다. 앱에서 암호를 배포하지 않고 사용자 자신의 보안 인증 정보로 요청을 승인하고 싶다면, 토큰으로 권한이 부여된 API 작업을 사용해야 합니다. 사용자가 로그인을 완료한 경우 액세스 토큰을 사용하여 토큰으로 권한이 부여된 API 요청을 승인해야 합니다. 사용자가 로그인 프로세스를 진행 중이라면, Amazon Cognito가 이전 요청에 대한 응답으로 반환한 세션 토큰을 사용하여 토큰으로 권한이 부여된 API 요청을 승인해야 합니다.

예를 들어 공개 클라이언트에서는 사용자 자신의 프로필에 대한 쓰기 권한만 제한하는 방식으로 사용자 프로필을 업데이트해야 할 수 있습니다. 이 업데이트를 수행하기 위해 클라이언트는 UpdateUserAttributes API 요청에 사용자의 액세스 토큰을 포함할 수 있습니다.

AWS SDK로 개발한 공개 클라이언트에서 이러한 요청을 보내려는 경우에는 보안 인증 정보를 구성하지 않아도 됩니다. 요청에 AccessToken 또는 Session 파라미터를 포함합니다. Amazon Cognito 사용자 풀 API의 서비스 엔드포인트로 바로 요청을 보낼 수도 있습니다. 서비스 엔드포인트에 대한 요청을 승인하려면 요청의 POST 본문에 액세스 또는 세션 토큰을 포함합니다.

토큰으로 권한이 부여된 작업을 위한 API 요청에 서명하려면 액세스 토큰을 Bearer <Base64-encoded access token> 형식의 Authorization 헤더로 요청에 포함하세요.

토큰 권한 부여 사용자 작업 AccessToken 세션
RespondToAuthChallenge
ChangePassword
GetUser
UpdateUserAttributes
DeleteUserAttributes
DeleteUser
ConfirmDevice
ForgetDevice
GetDevice
ListDevices
UpdateDeviceStatus
GetUserAttributeVerificationCode
VerifyUserAttribute
SetUserSettings
SetUserMFAPreference
GlobalSignOut
AssociateSoftwareToken
UpdateAuthEventFeedback
VerifySoftwareToken
RevokeToken¹

¹ RevokeToken은 새로 고침 토큰을 파라미터로 사용합니다. 새로 고침 토큰은 인증 토큰 및 대상 리소스 역할을 합니다.