we have created a connected app, when running the "API Calls Made Within Last 7 Days" – Report, the report doesn't show the name of our app in the column client id (see picture). What do we need to setup to see our app name in that column?
cheers,
Timo
@AMM, it looks like all you need to do is set the client element within the CallOptions header when making API calls. Take a look at the screenshot below showing a report that lists the custom Client ID sent with an API call.
Below is the snippet of Ruby code I used to produce that audit record.
login_header = { "tns:CallOptions" => { "tns:client" => "retrieve-profiles-and-permissionsets.rb" } }
login_message = { username: username, password: password + token }
soap_response = partner_client.call :login, soap_header: login_header, message: login_message
Another alternative if each of the external applications has their own IP address is to use the Event Logs API and the RestApi Event Type. Note that this would be a paid feature outside a developer edition org.
Part of the RestApi report is the CLIENT_IP column. If each external application has a distinct IP address then they would be easy to identify in the CSV report.
There is also the USER_AGENT column, so you might be able to use a different user agent with each request. I'll try and find out how to decode/control the reported numeric codes.
Update: It would be extremely hacky, but you could use valid browser user agent strings to produce identifiable USER_AGENT values in the event log. E.g. Have one external app send in the Chrome user agent string with the REST API request. Then either vary the version it identifies as in another external app, or have it identify as a completely different browser. There is hope that a pilot program will add support for custom user agent strings.
Best Answer
The client ID / Token is defined when using the SOAP API and goes in the CallOption.client. It allows your app to access professional edition orgs via the API. I think Salesforce assigns it to you when you pass certification, but there isn't anything stopping you passing in whatever value you want.
There isn't a direct equivalent for the REST API that will populate the Client Id. Instead you can get you app whitelisted by Salesforce.
Source: Does the REST API support Client ID?
Update: The REST API now supports the Call Options Header that can define the
client