External Credential OAuth URL

POST methods typically create an item, but for this resource POST is used to retrieve information.

Root XML tag

<oAuthCredentialAuthUrl>

JSON example

1{
2"externalCredential": "salesforceOAuthExternalCredential",
3"principalName": "defaultNamedPrincipal",
4"principalType": "NamedPrincipal",
5"returnUrl": "lightning/setup/SetupOneHome/home"
6}

Properties

Name	Type	Description	Required or Optional	Available Version
externalCredential	String	Fully qualified developer name of the external credential.	Required	56.0
principalName	String	Name of the external credential named principal.	Required if principalType is NamedPrincipal	56.0
principalType	String	Type of credential principal. Values are: AwsStsPrincipal NamedPrincipal PerUserPrincipal	Required	56.0
returnUrl	String	Return URL to apply to the authentication URL.	Optional	56.0