Embed Token - Dashboards GenerateTokenInGroup

참조

Service:: Power BI REST APIs

API Version:: v1.0

지정된 작업 영역에서 지정된 dashboard 볼 수 있는 포함 토큰을 생성합니다.

중요

이 API 호출은 고객에 대한 포함 시나리오와 만 관련이 있습니다. 이 API 사용에 대한 자세한 내용은 포함 토큰을 생성할 때 고려 사항을 참조하세요.

사용 권한

인증에 서비스 주체를 사용하는 경우 서비스 주체와 고려 사항 및 제한 사항이 포함된 Power BI 콘텐츠 포함을 참조하세요.
이 API 호출은 서비스 주체 프로필에서 호출할 수 있습니다. 자세한 내용은 Power BI Embedded 서비스 주체 프로필을 참조하세요.

필수 범위

다음을 모두 수행합니다.

Dashboard.ReadWrite.All 또는 Dashboard.Read.All
Report.ReadWrite.All 또는 Report.Read.All
Dataset.ReadWrite.All 또는 Dataset.Read.All

POST https://api.powerbi.com/v1.0/myorg/groups/{groupId}/dashboards/{dashboardId}/GenerateToken

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
dashboardId	path	True	string uuid	dashboard ID
groupId	path	True	string uuid	작업 영역 ID

요청 본문

Name	형식	Description
accessLevel	TokenAccessLevel	포함 토큰 생성에 필요한 액세스 수준
allowSaveAs	boolean	포함된 보고서를 새 보고서로 저장할 수 있는지 여부입니다. 기본값은 `false`입니다. 보고서 포함에 대한 포함 토큰을 생성할 때만 적용됩니다.
datasetId	string	보고서 만들기에 사용되는 데이터 세트 ID입니다. 보고서 만들기를 위해 포함 토큰을 생성할 때만 적용됩니다.
identities	EffectiveIdentity[]	행 수준 보안 규칙에 사용할 ID 목록
lifetimeInMinutes	integer	토큰이 생성된 시간부터 시작하여 토큰의 최대 수명(분)입니다. 토큰의 만료 시간을 단축하는 데 사용할 수 있지만 토큰을 확장하는 데는 사용할 수 없습니다. 값은 양의 정수여야 합니다. 0(0)은 null과 동일하며 무시되어 기본 만료 시간이 발생합니다.

응답

Name	형식	Description
200 OK	EmbedToken	확인

예제

Generate a dashboard embed token using an effective identity with an identity blob example

Generate a dashboard embed token with multiple identities example

Generate a dashboard embed token using an effective identity with an identity blob example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/dashboards/69ffaa6c-b36d-4d01-96f5-1ed67c64d4af/GenerateToken

Request Body

{
  "accessLevel": "View",
  "identities": [
    {
      "datasets": [
        "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
      ],
      "identityBlob": {
        "value": "eyJ0eX....AAA="
      }
    }
  ]
}

Sample Response

Status code:: 200

{
  "token": "H4sI....AAA=",
  "tokenId": "49ae3742-54c0-4c29-af52-619ff93b5c80",
  "expiration": "2018-07-29T17:58:19Z"
}

Generate a dashboard embed token with multiple identities example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/dashboards/69ffaa6c-b36d-4d01-96f5-1ed67c64d4af/GenerateToken

Request Body

{
  "accessLevel": "View",
  "identities": [
    {
      "username": "john@contoso.com",
      "roles": [
        "sales"
      ],
      "datasets": [
        "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
      ]
    },
    {
      "username": "john_contoso",
      "roles": [
        "product"
      ],
      "datasets": [
        "a8b062ca-5730-468f-9df7-43c2ba76bf5e"
      ]
    }
  ]
}

Sample Response

Status code:: 200

{
  "token": "H4sI....AAA=",
  "tokenId": "49ae3742-54c0-4c29-af52-619ff93b5c80",
  "expiration": "2018-07-29T17:58:19Z"
}

정의

Name	Description
EffectiveIdentity	사용자 ID 및 역할을 정의합니다. 자세한 내용은 Power BI Embedded 행 수준 보안을 참조하세요.
EmbedToken	Power BI 포함 토큰
GenerateTokenRequest	Power BI 토큰 요청 생성
IdentityBlob	ID를 지정하기 위한 Blob입니다. Azure SQL DirectQuery 연결이 있는 데이터 세트에 대해서만 지원됩니다.
TokenAccessLevel	포함 토큰 생성에 필요한 액세스 수준

EffectiveIdentity

사용자 ID 및 역할을 정의합니다. 자세한 내용은 Power BI Embedded 행 수준 보안을 참조하세요.

Name	형식	Description
auditableContext	string	EffectiveIdentity 감사 가능한 컨텍스트입니다. 이 매개 변수가 제공되고 비어 있지 않으면 EffectiveIdentity에 대한 감사를 사용하도록 설정하고 해당 값은 감사 레코드의 사용자 이름으로 설정됩니다. 그렇지 않으면 EffectiveIdentity 컨텍스트가 GenerateToken 감사 레코드에서 생략됩니다.
customData	string	행 수준 보안 규칙을 적용하는 데 사용되는 사용자 지정 데이터입니다. Azure Analysis Services 모델 및 클라우드 모델에 대한 라이브 연결에만 지원됩니다.
datasets	string[]	이 ID가 적용되는 데이터 세트의 배열
identityBlob	IdentityBlob	ID를 지정하는 Blob 입니다. Azure SQL DirectQuery 연결이 있는 데이터 세트에 대해서만 지원됩니다.
reports	string[]	이 ID가 적용되는 보고서 배열입니다. 페이지를 매긴 보고서에 대해서만 지원됩니다.
roles	string[]	RLS 규칙을 적용하는 토큰 내의 RLS(행 수준 보안) 역할 배열입니다. ID에는 최대 50개의 역할이 포함될 수 있습니다. 역할에는 를 제외한 `,`모든 문자가 포함될 수 있으며 길이가 50자를 초과하면 안됩니다.
username	string	행 수준 보안 규칙을 적용하는 토큰 내의 유효 사용자 이름입니다. 온-프레미스 모델의 경우 사용자 이름에는 영숫자 또는 다음 문자 `.`, , `-`, `_`, `!`, `#`, `^~`, , , `\\`가 `@`포함될 수 있습니다. 클라우드 모델의 경우 사용자 이름에 ASCII 문자가 포함될 수 있습니다. 두 모델 모두 사용자 이름 길이가 256자를 초과하면 안 되며 사용자 이름에 공백이 없어야 합니다.

EmbedToken

Power BI 포함 토큰

Name	형식	Description
expiration	string	토큰 만료 날짜 및 시간(UTC)
token	string	포함 토큰
tokenId	string	고유 토큰 ID입니다. 감사 로그를 통해 토큰 ID를 사용하여 토큰을 사용하는 작업과 생성 작업의 상관 관계를 지정할 수 있습니다.

GenerateTokenRequest

Power BI 토큰 요청 생성

Name	형식	Description
accessLevel	TokenAccessLevel	포함 토큰 생성에 필요한 액세스 수준
allowSaveAs	boolean	포함된 보고서를 새 보고서로 저장할 수 있는지 여부입니다. 기본값은 `false`입니다. 보고서 포함에 대한 포함 토큰을 생성할 때만 적용됩니다.
datasetId	string	보고서 만들기에 사용되는 데이터 세트 ID입니다. 보고서 만들기를 위해 포함 토큰을 생성할 때만 적용됩니다.
identities	EffectiveIdentity[]	행 수준 보안 규칙에 사용할 ID 목록
lifetimeInMinutes	integer	토큰이 생성된 시간부터 시작하여 토큰의 최대 수명(분)입니다. 토큰의 만료 시간을 단축하는 데 사용할 수 있지만 토큰을 확장하는 데는 사용할 수 없습니다. 값은 양의 정수여야 합니다. 0(0)은 null과 동일하며 무시되어 기본 만료 시간이 발생합니다.

IdentityBlob

ID를 지정하기 위한 Blob입니다. Azure SQL DirectQuery 연결이 있는 데이터 세트에 대해서만 지원됩니다.

Name	형식	Description
value	string	Azure SQL 대한 OAuth 2.0 액세스 토큰

TokenAccessLevel

포함 토큰 생성에 필요한 액세스 수준

Name	형식	Description
Create	string	생성된 포함 토큰이 만들기 권한을 부여했음을 나타냅니다. 보고서 만들기를 위해 포함 토큰을 생성할 때만 적용됩니다.
Edit	string	생성된 포함 토큰이 보기 및 편집 권한을 부여했음을 나타냅니다. 보고서 포함에 대한 포함 토큰을 생성할 때만 적용됩니다.
View	string	생성된 포함 토큰이 보기 전용 권한을 부여했음을 나타냅니다.

Embed Token - Dashboards GenerateTokenInGroup

사용 권한

필수 범위

URI 매개 변수

요청 본문

응답

예제

Generate a dashboard embed token using an effective identity with an identity blob example

Sample Request

Sample Response

Generate a dashboard embed token with multiple identities example

Sample Request

Sample Response

정의

EffectiveIdentity

EmbedToken

GenerateTokenRequest

IdentityBlob

TokenAccessLevel

추가 리소스