2단계: 인증 코드가 첨부된 URL 가져오기
중요
Amazon QuickSight는 분석 기능을 포함하기 위한 새로운 API, 즉 GenerateEmbedUrlForAnonymousUser
와(과) GenerateEmbedUrlForRegisteredUser
을(를) 제공합니다.
여전히 GetDashboardEmbedUrl
및 GetSessionEmbedUrl
API를 사용하여 대시보드와 QuickSight 콘솔을 내장할 수 있지만, 여기에는 최신 임베딩 기능이 포함되어 있지 않습니다. 최신 임베딩 환경에 대한 자세한 내용은 애플리케이션에 QuickSight 분석 임베딩을(를) 참조하세요.
다음 단원에서는 사용자를 인증하고 애플리케이션 서버에서 임베딩 가능한 콘솔 세션 URL을 가져오는 방법을 알아볼 수 있습니다.
사용자가 앱에 액세스할 때, 앱은 사용자를 대신하여 IAM 역할을 맡습니다. 그런 다음 사용자가 아직 없는 경우, 사용자를 QuickSight에 추가해야 합니다. 다음으로 식별자를 고유한 역할 세션 ID로 전달합니다.
설명된 단계를 수행하면 콘솔 세션의 각 뷰어가 QuickSight에서 고유하게 프로비전됩니다. 또한 사용자 단위 설정(예: 파라미터에 대한 동적 기본값 및 행 수준 보안)을 적용합니다.
다음 예는 사용자를 대신하여 IAM 인증을 수행합니다. 이 코드는 앱 서버에서 실행됩니다.
- Java
-
import com.amazonaws.auth.AWSCredentials; import com.amazonaws.auth.BasicAWSCredentials; import com.amazonaws.auth.AWSCredentialsProvider; import com.amazonaws.regions.Regions; import com.amazonaws.services.quicksight.AmazonQuickSight; import com.amazonaws.services.quicksight.AmazonQuickSightClientBuilder; import com.amazonaws.services.quicksight.model.GetSessionEmbedUrlRequest; import com.amazonaws.services.quicksight.model.GetSessionEmbedUrlResult; /** * Class to call QuickSight AWS SDK to get url for session embedding. */ public class GetSessionEmbedUrlQSAuth { private final AmazonQuickSight quickSightClient; public GetSessionEmbedUrlQSAuth() { this.quickSightClient = AmazonQuickSightClientBuilder .standard() .withRegion(Regions.US_EAST_1.getName()) .withCredentials(new AWSCredentialsProvider() { @Override public AWSCredentials getCredentials() { // provide actual IAM access key and secret key here return new BasicAWSCredentials("access-key", "secret-key"); } @Override public void refresh() {} } ) .build(); } public String getQuicksightEmbedUrl( final String accountId, // YOUR AWS ACCOUNT ID final String userArn // REGISTERED USER ARN TO USE FOR EMBEDDING. REFER TO GETEMBEDURL SECTION IN DEV PORTAL TO FIND OUT HOW TO GET USER ARN FOR A QUICKSIGHT USER ) throws Exception { GetSessionEmbedUrlRequest getSessionEmbedUrlRequest = new GetSessionEmbedUrlRequest() .withAwsAccountId(accountId) .withEntryPoint("/start") .withUserArn(userArn); GetSessionEmbedUrlResult sessionEmbedUrl = quickSightClient.getSessionEmbedUrl(getSessionEmbedUrlRequest); return sessionEmbedUrl.getEmbedUrl(); } }
- JavaScript
-
global.fetch = require('node-fetch'); const AWS = require('aws-sdk'); function getSessionEmbedURL( accountId, // YOUR AWS ACCOUNT ID userArn, // REGISTERED USER ARN TO USE FOR EMBEDDING. REFER TO GETEMBEDURL SECTION IN DEV PORTAL TO FIND OUT HOW TO GET USER ARN FOR A QUICKSIGHT USER getEmbedUrlCallback, // GETEMBEDURL SUCCESS CALLBACK METHOD errorCallback // GETEMBEDURL ERROR CALLBACK METHOD ) { const getSessionParams = { AwsAccountId: accountId, EntryPoint: "/start", UserArn: userArn, SessionLifetimeInMinutes: 600, }; const quicksightGetSession = new AWS.QuickSight({ region: process.env.AWS_REGION, }); quicksightGetSession.getSessionEmbedUrl(getSessionParams, function(err, data) { if (err) { console.log(err, err.stack); errorCallback(err); } else { const result = { "statusCode": 200, "headers": { "Access-Control-Allow-Origin": "*", // USE YOUR WEBSITE DOMAIN TO SECURE ACCESS TO GETEMBEDURL API "Access-Control-Allow-Headers": "Content-Type" }, "body": JSON.stringify(data), "isBase64Encoded": false } getEmbedUrlCallback(result); } }); }
- Python3
-
import json import boto3 from botocore.exceptions import ClientError import time # Create QuickSight and STS clients qs = boto3.client('quicksight',region_name='us-east-1') sts = boto3.client('sts') # Function to generate embedded URL # accountId: YOUR AWS ACCOUNT ID # userArn: REGISTERED USER ARN TO USE FOR EMBEDDING. REFER TO GETEMBEDURL SECTION IN DEV PORTAL TO FIND OUT HOW TO GET USER ARN FOR A QUICKSIGHT USER def getSessionEmbedURL(accountId, userArn): try: response = qs.get_session_embed_url( AwsAccountId = accountId, EntryPoint = "/start", UserArn = userArn, SessionLifetimeInMinutes = 600 ) return { 'statusCode': 200, 'headers': {"Access-Control-Allow-Origin": "*", "Access-Control-Allow-Headers": "Content-Type"}, 'body': json.dumps(response), 'isBase64Encoded': bool('false') } except ClientError as e: print(e) return "Error generating embeddedURL: " + str(e)
- Node.js
-
다음 예제는 앱 서버에서 임베디드 콘솔 세션에 대한 URL를 가져오는데 사용할 수 있는 JavaScript(Node.js)를 코드를 보여줍니다. 웹 사이트 또는 앱에서 이 URL을 사용하여 콘솔 세션을 표시할 수 있습니다.
const AWS = require('aws-sdk'); const https = require('https'); var quicksight = new AWS.Service({ apiConfig: require('./quicksight-2018-04-01.min.json'), region: 'us-east-1', }); quicksight.GetSessionEmbedUrl({ 'AwsAccountId': '
111122223333
', 'EntryPoint': 'https://url-for-console-page-to-open
', 'SessionLifetimeInMinutes':600
, 'UserArn': 'USER_ARN
' }, function(err, data) { console.log('Errors: '); console.log(err); console.log('Response: '); console.log(data); });//The URL returned is over 900 characters. For this example, we've shortened the string for //readability and added ellipsis to indicate that it's incomplete. { Status: 200, EmbedUrl: 'https://dashboards.example.com/embed/620bef10822743fab329fb3751187d2d… RequestId: '7bee030e-f191-45c4-97fe-d9faf0e03713' }
- .NET/C#
-
다음 예제는 앱 서버에서 임베디드 콘솔 세션에 대한 URL를 가져오는데 사용할 수 있는 .NET/C# 코드를 보여줍니다. 웹 사이트 또는 앱에서 이 URL을 사용하여 콘솔을 표시할 수 있습니다.
var client = new AmazonQuickSightClient( AccessKey, SecretAccessKey, sessionToken, Amazon.RegionEndpoint.USEast1); try { Console.WriteLine( client.GetSessionEmbedUrlAsync(new GetSessionEmbedUrlRequest { 'AwsAccountId': '
111122223333
', 'EntryPoint': 'https://url-for-console-page-to-open
', 'SessionLifetimeInMinutes': 600, 'UserArn': 'USER_ARN
' AwsAccountId =111122223333
, EntryPoint =https://url-for-console-page-to-open
, SessionLifetimeInMinutes =600
, UserArn = 'USER_ARN
' }).Result.EmbedUrl ); } catch (Exception ex) { Console.WriteLine(ex.Message); } - AWS CLI
-
역할을 수임하려면 다음의 AWS Security Token Service(AWS STS) API 작업 중 하나를 선택합니다.
-
AssumeRole - IAM 자격 증명을 사용하여 역할을 수임하는 경우 사용합니다.
-
AssumeRoleWithWebIdentity - 웹 ID 공급자를 사용하여 사용자를 인증하는 경우 이 작업을 사용하세요.
-
AssumeRoleWithSaml - SAML을 사용하여 사용자를 인증할 때 이 작업을 사용하세요.
다음 예에서는 IAM 역할을 설정하는 CLI 명령을 보여줍니다. 역할은
quicksight:GetSessionEmbedUrl
에 대한 권한이 활성화되어 있어야 합니다. 사용자가 QuickSight를 처음 열 때 사용자를 추가하는 적시 접근 방식을 취하는 경우, 역할이quicksight:RegisterUser
에 대해 사용할 수 있는 권한도 필요합니다.aws sts assume-role \ --role-arn "
arn:aws:iam::111122223333:role/embedding_quicksight_dashboard_role
" \ --role-session-namejohn.doe@example.com
assume-role
작업은 액세스 키, 보안 키 및 세션 토큰의 세 가지 출력 파라미터를 반환합니다.참고
AssumeRole
작업을 호출할 때ExpiredToken
오류가 발생할 경우, 이는 아마도 이전의SESSION TOKEN
이(가) 환경 변수에 남아 있기 때문입니다. 다음 변수를 설정하여 이를 삭제합니다.-
AWS_ACCESS_KEY_ID
-
AWS_SECRET_ACCESS_KEY
-
AWS_SESSION_TOKEN
다음 예에서는 CLI에서 세 파라미터를 설정하는 방법을 보여줍니다. Microsoft Windows 컴퓨터를 사용하는 경우
export
대신set
을 사용하십시오.export AWS_ACCESS_KEY_ID = "
access_key_from_assume_role
" export AWS_SECRET_ACCESS_KEY = "secret_key_from_assume_role
" export AWS_SESSION_TOKEN = "session_token_from_assume_role
"이러한 명령을 실행하여 웹 사이트를 방문하는 사용자의 역할 세션 ID를
embedding_quicksight_console_session_role/john.doe@example.com
으로 설정합니다. 역할 세션 ID는role-arn
의 역할 이름과role-session-name
값으로 구성됩니다. 각 사용자에 대해 적절한 권한을 설정하려면 각 사용자에 대해 고유한 역할 세션 ID를 사용해야 합니다. 또한 사용자 액세스 조절을 방지할 수 있습니다. 조절은 동일한 사용자가 여러 위치에서 QuickSight에 액세스하는 것을 방지하는 보안 기능입니다.또한 역할 세션 ID는 QuickSight에서 사용자 이름으로 사용됩니다. 이 패턴을 사용하여 QuickSight에서 사용자를 미리 프로비저닝하거나 사용자가 콘솔 세션에 처음으로 액세스할 때 사용자를 프로비저닝할 수 있습니다.
다음 예에서는 사용자를 프로비저닝하는 데 사용할 수 있는 CLI 명령을 보여줍니다. RegisterUser, DescribeUser 및 기타 QuickSight API 작업에 대한 자세한 내용은 QuickSight API 참조를 확인하세요.
aws quicksight register-user \ --aws-account-id
111122223333
\ --namespacedefault
\ --identity-typeIAM
\ --iam-arn "arn:aws:iam::111122223333:role/embedding_quicksight_dashboard_role
" \ --user-roleREADER
\ --user-namejhnd
\ --session-name "john.doe@example.com
" \ --emailjohn.doe@example.com
\ --regionus-east-1
\ --custom-permissions-nameTeamA1
사용자가 Microsoft AD를 통해 인증된 경우에는 설정을 위해
RegisterUser
를 사용하지 않아도 됩니다. 대신, 처음 QuickSight에 액세스할 때 자동으로 가입되어야 합니다. Microsoft AD 사용자의 경우 사용자 ARN을 얻는 데DescribeUser
를 사용할 수 있습니다.사용자가 QuickSight에 처음 액세스할 때, 이 사용자를 적절한 그룹에 추가할 수도 있습니다. 다음 예에서는 사용자를 그룹에 추가하는 CLI 명령을 보여줍니다.
aws quicksight create-group-membership \ --aws-account-id=
111122223333
\ --namespace=default
\ --group-name=financeusers
\ --member-name="embedding_quicksight_dashboard_role/john.doe@example.com
"이제 QuickSight의 사용자인 앱 사용자가 QuickSight 콘솔 세션에 액세스할 수 있습니다.
마지막으로 콘솔 세션에 대해 서명된 URL을 가져오려면, 앱 서버에서
get-session-embed-url
을(를) 호출합니다. 그러면 임베드 가능한 콘솔 세션 URL이 반환됩니다. 다음 예는 AWS Managed Microsoft AD 또는 Single Sign-on(IAM 자격 증명 센터)를 통해 인증된 사용자를 위해 서버 측 호출을 사용하여 임베디드 콘솔 세션의 URL을 가져오는 방법을 보여줍니다.aws quicksight get-dashboard-embed-url \ --aws-account-id
111122223333
\ --entry-pointthe-url-for--the-console-session
\ --session-lifetime-in-minutes600
\ --user-arn arn:aws:quicksight:us-east-1
:111122223333
:user/default/embedding_quicksight_dashboard_role
/embeddingsession이 작업의 사용에 대한 자세한 내용은 GetSessionEmbedUrl 단원을 참조하십시오. 자체 코드에서 이 작업 및 다른 API 작업을 사용할 수 있습니다.
-