---
schema_version: "1"
id: 75976341099c88c474274ff162d195693dec65ceddce5094d6c97060e7734e1e
title: AuraDefinition
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/object_reference/sforce_api_objects_auradefinition.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_auradefinition.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: c663672a7cb6563dcee1ce5b3f09ea4cb7cf23cab7b87cdfbe3d20f2c86daf1c
description: Represents an Aura component definition, such as component markup, a client-side controller, or an event. This object is 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. This object is available in API version 32.0 and later.

## Supported Calls

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

## Special Access Rules

As of Summer ’20 and later, only your Salesforce org's internal users can access this object.

## Fields

| Field Name | Details |
| --- | --- |
| AuraDefinitionBundleId | 
Type

reference

Properties

Create, Filter, Group, Sort

Description

The ID of the bundle containing the definition. A bundle contains a Lightning definition and all its related resources.

This is a relationship field.

Relationship Name

AuraDefinitionBundle

Relationship Type

Lookup

Refers To

AuraDefinitionBundle



 |
| DefType | 

Type

picklist

Properties

Create, Filter, Group, Restricted picklist, Sort, Update

Description

The definition type. Valid values are:

- APPLICATION — Lightning Aura Components app
- CONTROLLER — client-side controller
- COMPONENT — component markup
- EVENT — event definition
- HELPER — client-side helper
- INTERFACE — interface definition
- RENDERER — client-side renderer
- STYLE — style (CSS) resource
- PROVIDER — reserved for future use
- MODEL — deprecated, do not use
- TESTSUITE — reserved for future use
- DOCUMENTATION — documentation markup
- TOKENS — tokens collection
- DESIGN — design definition
- SVG — SVG graphic resource
- MODULE — reserved for future use







 |
| Format | 

Type

picklist

Properties

Create, Filter, Group, Restricted picklist, Sort, Update

Description

The format of the definition. Valid values are:

- XML for component markup
- JS for JavaScript code
- CSS for styles
- TEMPLATE\_CSS reserved for future use
- SVG for an SVG graphic





 |
| Source | 

Type

textarea

Properties

Create, Update

Description

The contents of the definition. This is all the markup or code for the definition.



 |

## 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)").