{
"sections": [
"title",
"description",
"fields",
"special_access_rules",
"usage",
"wsdl_segment",
"field_reference"
],
"title": "PermissionSet - Data API",
"description": "Represents a set of permissions that’s used to grant more access to one or more users without changing their profile or reassigning profiles. This object is available in API version 22.0 and later.",
"fields_columns": [
"type",
"properties",
"description",
"relationship_name",
"relationship_type",
"refers_to"
],
"fields": {
"Description": {
"type": "string",
"properties": "Create, Filter, Nillable, Group, Sort, Update",
"description": "A description of the permission set. Limit: 255 characters."
},
"HasActivationRequired": {
"type": "boolean",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "Indicates whether the permission set requires an associated active session (true) or not (false)."
},
"IsCustom": {
"type": "boolean",
"properties": "Defaulted on create, Filter, Group, Sort",
"description": "If true, the permission set is custom (created by an admin); if false, the permission set is standard and related to a specific permission set license."
},
"IsOwnedByProfile": {
"type": "boolean",
"properties": "Defaulted on create, Filter, Group, Sort",
"description": "If true, the permission set is owned by a profile. Available in API version 25.0 and later."
},
"Label": {
"type": "string",
"properties": "Create, Filter, Group, Sort, Update",
"description": "The permission set label, which corresponds to Label in the user interface. Limit: 80 characters."
},
"LicenseId": {
"type": "reference",
"properties": "Create, Filter, Group, Nillable, Sort",
"description": "The ID of either the related PermissionSetLicense or UserLicense associated with this permission set. Available in API version 38.0 and later. Use this field instead of UserLicenseId, which is deprecated and only available up to API Version 37.0. This is a polymorphic relationship field.",
"relationship_name": "License",
"relationship_type": "Lookup",
"refers_to": "PermissionSetLicense, UserLicense"
},
"Name": {
"type": "string",
"properties": "Create, Filter, Group, Sort, Update",
"description": "The unique name of the object 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. Corresponds to API Name in the user interface. Limit: 80 characters."
},
"NamespacePrefix": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The namespace prefix for a permission set that's been installed as part of a managed package. If the permission set isn't packaged or is part of an unmanaged package, this value is empty. Available in API version 23.0 and later."
},
"Permissions": {
"type": "boolean",
"properties": "Create, Filter, Update",
"description": "One field for each permission. If true, users assigned to this permission set have the named permission. The number of fields varies depending on the permissions for the organization and license type. To get a list of available permissions in the SOAP API, use describeSObjects()."
},
"PermissionSetGroupId": {
"type": "reference",
"properties": "Filter, Group, Nillable, Sort",
"description": "If the permission set is owned by a permission set group, this field returns the ID of the permission set group. If the permission set isn’t owned by a permission set group, this field returns a null value. Available in API version 45.0 and later. This is a relationship field.",
"relationship_name": "PermissionSetGroup",
"relationship_type": "Lookup",
"refers_to": "PermissionSetGroup"
},
"ProfileId": {
"type": "reference",
"properties": "Filter, Group, Nillable, Sort",
"description": "If the permission set is owned by a profile, this field returns the ID of the Profile. If the permission set isn’t owned by a profile, this field returns a null value. Available in API version 25.0 and later. This is a relationship field.",
"relationship_name": "Profile",
"relationship_type": "Lookup",
"refers_to": "Profile"
},
"Type": {
"type": "reference",
"properties": "Filter, Group, Nillable, Sort",
"description": "Available in API version 46.0 and later."
},
"UserLicenseId": {
"type": "reference",
"properties": "Create, Filter, Group, Nillable, Sort",
"description": "ID of the UserLicense associated with this permission set. This field is nillable in API version 26.0 and later and available up to API version 37.0 In API version 38.0 and later, use LicenseId."
}
},
"special_access_rules": "As of Summer ’20 and later, only users who have one of these permissions can access this object: To view the following settings, assignments, and permissions for standard and custom objects in a specified permission set, the View Setup and Configuration permission is required.\n\nAs of Summer ’20 and later, only users who have one of these permissions can access this object:\n\nTo view the following settings, assignments, and permissions for standard and custom objects in a specified permission set, the View Setup and Configuration permission is required.",
"usage": "Use the PermissionSet object to query existing permission sets. For example, to search for all permission sets that contain the “Modify All Data” permission: When combined with the PermissionSetAssignment object, you can create a nested query that returns all users assigned to a particular permission like “Modify All Data”: If the permission set isn’t assigned to a user, you can also create or delete a permission set.\n\nUse the PermissionSet object to query existing permission sets.\n\nFor example, to search for all permission sets that contain the “Modify All Data” permission:\n\nWhen combined with the PermissionSetAssignment object, you can create a nested query that returns all users assigned to a particular permission like “Modify All Data”:\n\nIf the permission set isn’t assigned to a user, you can also create or delete a permission set.",
"wsdl_segment": "```xml\n\n \n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n