| accessMethod |
AccessMethod (enumeration of type string) |
Required. Indicates how the canvas app initiates the OAuth authentication flow. The
valid values are:
-
Get—OAuth
authentication is used, and the user is prompted to allow
the third-party application to access their information.
When you use this access method, the canvas app must
initiate the OAuth authentication flow.
-
Post—OAuth
authentication is used, but when the administrator installs
the canvas app, they implicitly allow access for users.
Therefore, the user isn’t prompted to allow the third party
to access their user information. When you use this access
method, the authentication is posted directly to the canvas
app URL.
|
| canvasLocationOptions |
CanvasLocationOptions (enumeration of type string)[] |
Indicates where the canvas app can appear to the user. The valid
values are:
-
Aura—The canvas
app can appear in a custom Lightning component.
-
ChatterFeed—The
canvas app can appear as a Chatter feed item.
-
MobileNav—The
canvas app can appear in a mobile card in the Salesforce
mobile app.
-
None—The canvas
app can appear only in the Canvas App Previewer.
-
PageLayout—The
canvas app can appear on a page layout. When viewed in the
Salesforce mobile app, the canvas app appears in the record
detail page.
-
Publisher—The
canvas app can appear as a global action.
-
Visualforce—The
canvas app can appear on a Visualforce page.
|
| canvasOptions |
CanvasOptions (enumeration of type string)[] |
Indicates whether to hide the Share button
and header in the publisher for your canvas app. Valid values are:
-
HideShare—The
Share button is hidden in the
publisher for the related canvas app.
-
HideHeader—The
header is hidden in the publisher for the related canvas
app.
|
| canvasUrl |
string |
Required. The URL of the third-party app that’s exposed as a
canvas app. |
| externalClientApplication |
string |
Required. The name of the associated external client app.
|
| label |
string |
The name of the app. |
| lifeCycleHandler |
string |
The name of the lifecycle handler Apex class. |
| samlInitiationMethod |
SamlInitiationMethod (enumeration of type string) |
If you’re using SAML single sign-on (SSO), indicates which
provider initiates the SSO flow.
-
IdpInitiated—Identity provider initiated.
Salesforce makes the initial request to start the SSO
flow.
-
SpInitiated—Service provider initiated. The
canvas app starts the SSO flow after it’s invoked.
-
None—The canvas
app isn’t using SAML SSO.
|