Metadata API Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
BlacklistedConsumer
File Suffix and Directory Location
BlacklistedConsumer components have the suffix .blacklistedConsumer and are stored in the blacklistedConsumers folder.
Version
BlacklistedConsumer components are available in API version 49.0 and later.
Fields
This metadata type contains the following fields:
| Field Name | Field Type | Description |
|---|---|---|
| blockedByApiWhitelisting | boolean | Set to true to apply the Permitted Users policy, Admin approved users are pre-authorized to all connected apps in the org. This policy limits access to only users with the associated profile or permission set assigned to the app. Set to false to allow access to the connected app. False is the default value. |
| consumerKey | string | Required. A value used by the consumer for identification of the connected app
to Salesforce. Referred to as client_id in
OAuth 2.0. After you define and save the value, it can’t be edited. The value must be alphanumeric, can’t contain special characters or spaces, and must be between 8–256 characters. Consumer keys must be globally unique. |
| consumerName | string | Required. The name of the connected app being blocked. |
| masterLabel | string | Required. The primary label for the connected app record. |
Declarative Metadata Sample Definition
The following is an example of a component.
<BlacklistedConsumer xmlns="http://soap.sforce.com/2006/04/metadata">
<consumerKey>testConsumerKey</consumerKey>
<consumerName>testName</consumerName>
<blockedByApiWhitelisting>false</blockedByApiWhitelisting>
<masterLabel>myTest</masterLabel>
</BlacklistedConsumer><?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>*</members>
<name>BlacklistedConsumer</name>
</types>
<version>49.0</version>
</Package>Usage
Use this type judiciously for connected apps that you want to make inaccessible to your org’s users. Blocking an app ends all current user sessions and prevents future sessions. To block malicious attempts to access your org’s data, we recommend using API Access Control instead. This feature restricts users from accessing your Salesforce APIs unless they are pre-authorized through an approved connected app.