Newer Version Available

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

User External Credentials Authentication URL

Get the URL for the OAuth token flow for a user external credential.
Resource
1/user-external-credential/auth-url
Available version
55.0
Requires Chatter
No
HTTP methods
POST
Request body for POST
Root XML tag
<userExternalCredentialAuthFlow>
JSON example
1{
2"returnUrl": "lightning/setup/SetupOneHome/home"
3}
Properties
Name Type Description Required or Optional Available Version
returnUrl String Return URL to apply to the authentication URL. Optional 55.0
Request parameters for POST
Parameter Name Type Description Required or Optional Available Version
externalCredential String Developer name of the external credential. Required 55.0
perUser Boolean Specifies whether this credential is per user (true) or not (false). If unspecified, the default value is false. Optional 55.0
principal String Name of the external credential named principal parameter. Optional 55.0
Response body for POST
User External Credential Auth URL