Lightning Aura Components Developer Guide

What Is the Lightning Component Framework?
Quick Start
Creating Components
Using Components
Aura Component Bundle Design Resources
Use Aura Components in Lightning Experience and the Salesforce Mobile App
Navigate Across Your Apps with Page References
Get Your Aura Components Ready to Use on Lightning Pages
Use Aura Components in Experience Builder
Use Aura Components with Flows
Add Components to Apps
Integrate Your Custom Apps into the Chatter Publisher
Using Background Utility Items
Use Lightning Components in Visualforce Pages
Add Aura Components to Any App with Lightning Out (Beta)
Lightning Container
Using a Third-Party Framework
Lightning Container Component Limits
The Lightning Realty App
lightning-container NPM Module Reference
addErrorHandler()
addMessageHandler()
callApex()
getRESTAPISessionKey()
removeErrorHandler()
removeMessageHandler()
sendMessage()
Communicating with Events
Communicating Across the DOM with Lightning Message Service
Creating Apps
Styling Apps
Developing Secure Code
Using JavaScript
Working with Salesforce Data
Testing Components with Lightning Testing Service
Debugging
Performance
Reference
PDF

Newer Version Available

This content describes an older version of this product. View Latest

getRESTAPISessionKey()

Returns the Salesforce REST API session key.

Use this method when your embedded app needs to interact with the Salesforce REST API, such as executing a SOQL query.

Don’t use the session key to manage custom objects or fields. You can use the session key to create and update object records. Apps that use lightning:container should work with data, not metadata.

It's important to keep your API key secure. Don't give this key to code you don't trust, and don't include it in URLs or hyperlinks, even to another page in your app.

Salesforce uses the no-referrer policy to protect against leaking your app's URL to outside servers, such as image hosts. However, this policy doesn't protect some browsers, meaning your app's URLs could be included in outside requests.

Important

Sample

Used within a JavaScript app uploaded as a static resource and referenced by lightning:container, this example gets the REST API session key and uses it to execute a SOQL query.

You can view and download this example in the Developerforce Github Repository.

Arguments

None.

Response

Name Type Description
key string The REST API session key.