afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/CustomPermission.json

{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules",
    "usage",
    "wsdl_segment",
    "field_reference"
  ],
  "title": "CustomPermission - Data API",
  "description": "Represents a permission created to control access to a custom process or app, such as sending email. This object is available in API version 31.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description"
  ],
  "fields": {
    "Description": {
      "type": "textarea",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "A description of the custom permission. Limit: 255 characters."
    },
    "DeveloperName": {
      "type": "string",
      "properties": "Filter, Group, Sort",
      "description": "The unique name of the custom permission in the API. This name can contain only underscores and alphanumeric characters and must be unique in your organization. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. The label corresponds to Name in the user interface. Limit: 80 characters. Note: When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record. Note: Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field."
    },
    "IsLicensed": {
      "type": "boolean",
      "properties": "Defaulted on create, Filter, Group, Sort",
      "description": "When enabled (true) indicates that the appropriate Salesforce license is required before accessing the permission. This field is available in API version 50.0 and later."
    },
    "IsProtected": {
      "type": "boolean",
      "properties": "Defaulted on create, Filter, Group, Sort",
      "description": "Indicates whether the custom permission is protected (true) or not (false). Protected components that have been installed in other organizations can’t be linked to or referenced by components created in the subscriber organization. A developer can delete a protected component contained in a managed package in a future release of the package without worrying about failing installations. However, after a component is marked as unprotected and is released globally, the developer can’t delete it. The default value is false. This field is available in API version 50.0 and later."
    },
    "Language": {
      "type": "picklist",
      "properties": "Filter, Group, Restricted picklist, Sort",
      "description": "The language of the custom permission. Valid values are: Chinese (Simplified): zh_CN Chinese (Traditional): zh_TW Danish: da Dutch: nl_NL English: en_US Finnish: fi French: fr German: de Italian: it Japanese: ja Korean: ko Norwegian: no Portuguese (Brazil): pt_BR Russian: ru Spanish: es Spanish (Mexico): es_MX Spanish (Mexico) defaults to Spanish for customer-defined translations. Swedish: sv Thai: th The Salesforce user interface is fully translated to Thai, but Help is in English."
    },
    "MasterLabel": {
      "type": "string",
      "properties": "Filter, Group, Sort",
      "description": "The custom permission label, which corresponds to Label in the user interface. Limit: 80 characters."
    },
    "NamespacePrefix": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix__componentName notation. The namespace prefix can have one of the following values. In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix."
    }
  },
  "special_access_rules": "As of Summer ’20 and later, only users who have one of these permissions can access this object:\n\nAs of Summer ’20 and later, only users who have one of these permissions can access\n\t\t\t\tthis object:\n\nView Setup and Configuration\n\nManage Session Permission Set Activations\n\nAssign Permission Sets",
  "usage": "Use the CustomPermission object to determine users’ access to custom permissions.\n\nFor example, to query all permission sets where the Button1 permission is\n\t\t\t\tenabled:\n\nSELECT Id, DeveloperName,\n\n(select Id, Parent.Name, Parent.Profile.Name from SetupEntityAccessItems)\n\nFROM CustomPermission\n\nWHERE DeveloperName = 'Button1'\n\nTo query all permission sets and profiles with custom\n\t\t\t\tpermissions:\n\nSELECT Assignee.Name, PermissionSet.Id,\n\nPermissionSet.Profile.Name,\n\nPermissionSet.isOwnedByProfile,\n\nPermissionSet.Label\n\nFROM PermissionSetAssignment\n\nWHERE PermissionSetId\n\nIN (SELECT ParentId\n\nFROM SetupEntityAccess\n\nWHERE SetupEntityType =\n\n'CustomPermission')\n\nTo query for all SetupEntityAccess rows with custom\n\t\t\t\tpermissions:\n\nSELECT Id,ParentId,Parent.Name, SetupEntityId\n\nFROM SetupEntityAccess\n\nWHERE SetupEntityType='CustomPermission'\n\nAND ParentId\n\nIN (SELECT Id\n\nFROM PermissionSet\n\nWHERE isOwnedByProfile = false)",
  "wsdl_segment": "```xml\n<complexType name=\"CustomPermission\">\n  <complexContent>\n    <extension base=\"ens:sObject\">\n      <sequence>\n        <element name=\"CreatedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"CreatedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"CreatedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"CustomPermissionDependencyItem\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"CustomPermissionItem\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"Description\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"DeveloperName\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"ExternalClientApplication\" nillable=\"true\" minOccurs=\"0\" type=\"ens:ExternalClientApplication\"/>\n        <element name=\"ExternalClientApplicationId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"GrantedByLicenses\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"IsDeleted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"IsLicensed\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"IsProtected\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"Language\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"LastModifiedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"LastModifiedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"LastModifiedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"LicenseAllowsCustomPermissions\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"MasterLabel\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"NamespacePrefix\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"SetupEntityAccessItems\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n      </sequence>\n    </extension>\n  </complexContent>\n</complexType>\n<simpleType name=\"ID\">\n  <restriction base=\"xsd:string\">\n    <length value=\"18\"/>\n    <pattern value=\"[a-zA-Z0-9]{18}\"/>\n  </restriction>\n</simpleType>\n<simpleType name=\"QueryLocator\">\n  <restriction base=\"xsd:string\"/>\n</simpleType>\n<complexType name=\"QueryResult\">\n  <sequence>\n    <element name=\"done\" type=\"xsd:boolean\"/>\n    <element name=\"queryLocator\" type=\"tns:QueryLocator\" nillable=\"true\"/>\n    <element name=\"records\" type=\"ens:sObject\" nillable=\"true\" minOccurs=\"0\" maxOccurs=\"unbounded\"/>\n    <element name=\"size\" type=\"xsd:int\"/>\n  </sequence>\n</complexType>\n```",
  "field_reference": {
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "Description": {
      "field_label": "Description",
      "type": "textarea",
      "length": "255"
    },
    "DeveloperName": {
      "field_label": "Name",
      "type": "string",
      "length": "80"
    },
    "ExternalClientApplicationId": {
      "field_label": "External Client Application ID",
      "type": "reference",
      "length": "18"
    },
    "Id": {
      "field_label": "Custom Permission ID",
      "type": "id",
      "length": "18"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "type": "boolean"
    },
    "IsLicensed": {
      "field_label": "License Required",
      "type": "boolean"
    },
    "IsProtected": {
      "field_label": "Protected Component",
      "type": "boolean"
    },
    "Language": {
      "field_label": "Master Language",
      "type": "picklist",
      "length": "40"
    },
    "LastModifiedById": {
      "field_label": "Last Modified By ID",
      "type": "reference",
      "length": "18"
    },
    "LastModifiedDate": {
      "field_label": "Last Modified Date",
      "type": "datetime"
    },
    "MasterLabel": {
      "field_label": "Label",
      "type": "string",
      "length": "80"
    },
    "NamespacePrefix": {
      "field_label": "Namespace Prefix",
      "type": "string",
      "length": "15"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length"
  ]
}