find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/power-bi:power-bi-templateapps-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Power Bi Template Apps API
  version: v1.0
  description: 'Operations tagged TemplateApps across 2 of this provider''s published API definitions: power-bi-client-swagger.json, power-bi-client-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.powerbi.com
security: []
tags:
- name: TemplateApps
paths:
  /v1.0/myorg/CreateTemplateAppInstallTicket:
    post:
      tags:
      - TemplateApps
      summary: Generates an installation ticket for the automated install flow of the…
      description: '## Permissions


        The caller must use service principal for authentication. For more information, see Embed Power BI content with service principal and Considerations and limitations.


        ## Limitations


        - The tenant making this API call *must* own the specified template app.

        - The template app must either be published to Microsoft AppSource, or, both the ticket creator and the end-user installing with the ticket must have explicit access to the app.

        - All query parameters in the install ticket *must* be configured.'
      operationId: TemplateApps_CreateInstallTicket
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstallTicket'
      x-ms-examples:
        Create an install ticket for a template app, specifying two query parameters example.:
          parameters:
            requestParameters:
              appId: 91ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87
              packageKey: g632bb64...OfsoqT56xEM=
              ownerTenantId: d43e3248-3d83-44aa-a94d-c836bd7f9b79
              config:
                configuration:
                  param1: value1
                  param2: value2
          responses:
            '200':
              body:
                ticket: H4sI....AAA=
                ticketId: 4b76f5ed-5a06-4150-8d1b-60f8e4c186f4
                expiration: '2020-07-29T17:58:19Z'
            '401':
              body:
                error:
                  code: ServiceAppApplicationOwnershipValidationFailed
                  pbi.error:
                    code: ServiceAppApplicationOwnershipValidationFailed
                    parameters: {}
                    details: []
                    exceptionCulprit: 1
            '400':
              body:
                error:
                  code: ServiceAppInstallTicketInvalidConfiguration
                  pbi.error:
                    code: ServiceAppInstallTicketInvalidConfiguration
                    parameters: {}
                    details: []
                    exceptionCulprit: 1
      deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateInstallTicketRequest'
        description: Create Install Ticket parameters
        required: true
    servers:
    - url: https://api.powerbi.com
components:
  schemas:
    CreateInstallTicketRequest:
      description: A request to create a Power BI install ticket
      properties:
        installDetails:
          type: array
          description: List of install details
          items:
            $ref: '#/components/schemas/TemplateAppInstallDetails'
    TemplateAppInstallDetails:
      required:
      - appId
      - packageKey
      - ownerTenantId
      description: The install details for a Power BI template app
      properties:
        appId:
          type: string
          format: uuid
          description: The unique ID of the Power BI template app
        packageKey:
          type: string
          description: The secure key for the Power BI template app version
        ownerTenantId:
          type: string
          format: uuid
          description: The tenant ID of the Power BI template app owner
        config:
          $ref: '#/components/schemas/TemplateAppConfigurationRequest'
          description: The automated install configuration
    TemplateAppConfigurationRequest:
      description: An automated install configuration for a Power BI template app (dictionary of name-value pairs)
      properties:
        configuration:
          type: object
          additionalProperties:
            type: string
          example:
            param1: value1
            param2: value2
    InstallTicket:
      required:
      - ticket
      - ticketId
      - expiration
      description: An automated install ticket for a Power BI template app
      properties:
        ticket:
          type: string
          description: Install ticket
        ticketId:
          type: string
          format: uuid
          description: The unique ID of an install ticket. Audit logs can be used to correlate operations that use this ticket with the generate ticket operation.
        expiration:
          type: string
          format: date-time
          description: The expiration date and time (UTC) of the ticket
x-refined-from:
- power-bi-client-swagger.json
- power-bi-client-openapi.json