Instructure Lti::AccountLookup API

openapi: 3.0.3
info:
  title: Canvas LMS LTI ExternalTool Lti::AccountLookup API
  description: Canvas LTI 1.3 API endpoints including Dynamic Registration, IMS Names and Roles, Line Items, Data Services, and Security endpoints.
  version: 1.0.0
  contact:
    name: Instructure Support
    url: https://developerdocs.instructure.com/
    email: support@instructure.com
  license:
    name: AGPL-3.0
    url: https://github.com/instructure/canvas-lms/blob/master/LICENSE
servers:
- url: https://{canvas_domain}
  description: Canvas institution domain
  variables:
    canvas_domain:
      default: canvas.instructure.com
      description: The institution-specific Canvas domain
tags:
- name: Lti::AccountLookup
paths:
  /api/lti/accounts/{account_id}:
    get:
      summary: show
      tags:
      - Lti::AccountLookup
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          type: integer
        example: 1987650000000008145
      responses:
        '200':
          description: returns id, uuid, and other fields on account
          content:
            application/vnd.canvas.accountlookup+json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                  name:
                    type: string
                  workflow_state:
                    type: string
                  parent_account_id:
                    nullable: true
                  root_account_id:
                    nullable: true
                  uuid:
                    type: string
                  default_time_zone:
                    type: string
                required:
                - id
                - name
                - workflow_state
                - parent_account_id
                - root_account_id
                - uuid
                - default_time_zone
              example:
                id: 8145
                name: Default Account
                workflow_state: active
                parent_account_id: null
                root_account_id: null
                uuid: vYmDAUennzTRV43z1Oo4v0MYaY2pMJ3Dr1GaH3Mn
                default_time_zone: Etc/UTC
        '401':
          description: does not return ims mime_type
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: object
                    properties:
                      type:
                        type: string
                      message:
                        type: string
                    required:
                    - type
                    - message
                required:
                - errors
              example:
                errors:
                  type: unauthorized
                  message: Unknown or inactive Developer Key
        '500':
          description: does not return ims mime_type
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                        error_code:
                          type: string
                      required:
                      - message
                      - error_code
                  error_report_id:
                    type: integer
                required:
                - errors
                - error_report_id
              example:
                errors:
                - message: An error occurred.
                  error_code: internal_server_error
                error_report_id: 127858
        '404':
          description: returns a 404
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                      required:
                      - message
                required:
                - errors
              example:
                errors:
                - message: The specified resource does not exist.
components:
  securitySchemes:
    oauth2:
      type: oauth2
      description: OAuth 2.0 authentication
      flows:
        authorizationCode:
          authorizationUrl: https://{canvas_domain}/login/oauth2/auth
          tokenUrl: https://{canvas_domain}/login/oauth2/token
          scopes: {}
    bearerAuth:
      type: http
      scheme: bearer
      description: Bearer token (access token)