---
schema_version: "1"
id: ac24195f3acdab249097431024f9a856998321ec269e42481b02ce9ae763a5b0
title: AuraDefinition
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_tooling/tooling_api_objects_auradefinition.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/tooling_api_objects_auradefinition.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: a38602e16d138dc682034abf6b697e2ec15125cfd4906b5688f5737cb53e5928
description: Represents an Aura component definition, such as component markup, a client-side controller, or an event. Available in API version 32.0 and later.
---
# AuraDefinition

Represents an Aura component definition, such as component markup, a client-side controller, or an event. Available in API version 32.0 and later.

## Supported SOAP API Calls

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

## Supported REST API HTTP Methods

Query, GET, POST, PATCH, DELETE

## Fields

<table class="featureTable sort_table" summary="">


          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d41706e82">Field Name</th>

              <th class="featureTableHeader  " id="d41706e85">Details</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d41706e82" data-title="Field Name"><span class="keyword parmname">AuraDefinitionBundleId</span></td>

              <td class="entry" headers="d41706e85" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">reference</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Create, Filter, Group, Sort</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">The ID of the
                    bundle containing the definition. A bundle contains
                    a Lightning definition and all its related
                    resources.</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d41706e82" data-title="Field Name"><span class="keyword parmname">DefType</span></td>

              <td class="entry" headers="d41706e85" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">picklist</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Create, Filter, Group, Restricted picklist,
                    Sort, Update</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">
                    <div class="p">The definition type. Valid
                      values are:<a name="d1680e163-d1693e205"><!-- --></a>
                      <ul class="ul bulletList" id="d1680e163-d1693e205">
                        <li class="li">
                          <samp class="codeph nolang">APPLICATION</samp> — Lightning Aura Components
                          app
                        </li>

                        <li class="li">
                          <samp class="codeph nolang">CONTROLLER</samp> — client-side controller
                        </li>

                        <li class="li">
                          <samp class="codeph nolang">COMPONENT</samp>
                          — component markup
                        </li>

                        <li class="li">
                          <samp class="codeph nolang">EVENT</samp> —
                          event definition
                        </li>

                        <li class="li">
                          <samp class="codeph nolang">HELPER</samp> —
                          client-side helper
                        </li>

                        <li class="li">
                          <samp class="codeph nolang">INTERFACE</samp>
                          — interface definition
                        </li>

                        <li class="li">
                          <samp class="codeph nolang">RENDERER</samp>
                          — client-side renderer
                        </li>

                        <li class="li">
                          <samp class="codeph nolang">STYLE</samp> —
                          style (CSS) resource
                        </li>

                        <li class="li">
                          <samp class="codeph nolang">PROVIDER</samp>
                          — reserved for future use
                        </li>

                        <li class="li">
                          <samp class="codeph nolang">MODEL</samp> —
                          deprecated, do not use
                        </li>

                        <li class="li">
                          <samp class="codeph nolang">TESTSUITE</samp>
                          — reserved for future use
                        </li>

                        <li class="li">
                          <samp class="codeph nolang">DOCUMENTATION</samp> — documentation
                          markup
                        </li>

                        <li class="li">
                          <samp class="codeph nolang">TOKENS</samp> —
                          tokens collection
                        </li>

                        <li class="li">
                          <samp class="codeph nolang">DESIGN</samp> —
                          design definition
                        </li>

                        <li class="li">
                          <samp class="codeph nolang">SVG</samp> — SVG
                          graphic resource
                        </li>

                        <li class="li">
                          <samp class="codeph nolang">MODULE</samp> —
                          reserved for future use
                        </li>

                      </ul>
                    </div>

                  </dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d41706e82" data-title="Field Name"><span class="keyword parmname">Format</span></td>

              <td class="entry" headers="d41706e85" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">picklist</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Create, Filter, Group, Restricted picklist, Sort, Update</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">The format of the definition. Valid values are:<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">XML</samp> for
                        component markup
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">JS</samp> for
                        JavaScript code
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">CSS</samp> for
                        styles
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">TEMPLATE_CSS</samp> reserved for future
                        use
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">SVG</samp> for an
                        SVG graphic
                      </li>

                    </ul>
                  </dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d41706e82" data-title="Field Name"><span class="keyword parmname">ManageableState</span></td>

              <td class="entry" headers="d41706e85" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">ManageableState enumerated list</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Filter, Group, Nillable, Restricted picklist, Sort</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">Indicates the manageable state of the specified component that is contained
                    in a package: <ul class="ul bulletList">
                      <li class="li"><samp class="codeph nolang">beta</samp></li>

                      <li class="li"><samp class="codeph nolang">deleted</samp></li>

                      <li class="li"><samp class="codeph nolang" id="d1680e219-d1764e373"><a name="d1680e219-d1764e373"><!-- --></a>deprecated</samp></li>

                      <li class="li"><samp class="codeph nolang">deprecatedEditable</samp></li>

                      <li class="li"><samp class="codeph nolang">installed</samp></li>

                      <li class="li"><samp class="codeph nolang">installedEditable</samp></li>

                      <li class="li"><samp class="codeph nolang">released</samp></li>

                      <li class="li"><samp class="codeph nolang">unmanaged</samp></li>

                    </ul>
                  </dd>


                </dl>

                <p class="p">This field is available in API version 38.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d41706e82" data-title="Field Name"><span class="keyword parmname">Source</span></td>

              <td class="entry" headers="d41706e85" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">textarea</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Create, Update</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">The contents of the
                    definition. This is all the markup or code for the
                    definition.</dd>


                </dl>

              </td>

            </tr>

          </tbody>

        </table>

## Usage

For more information, see the [Lightning Aura Components Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.lightning.meta/lightning/ "HTML (New Window)").