afv-library/skills/platform-data-and-tooling-api-context-get/assets/tooling_api/PermissionSetGroup.json

64 lines
6.5 KiB
JSON
Raw Normal View History

{
"sections": [
"title",
"description",
"supported_soap_calls",
"supported_rest_api_http_methods",
"fields",
"special_access_rules",
"wsdl_segment"
],
"title": "PermissionSetGroup - Tooling API",
"description": "Represents a group of permission sets and the permissions within them. Use permission set groups to organize permissions based on job functions or tasks. Then, you can package the groups as needed. Available in Tooling API version 45.0 and later.",
"supported_soap_calls": "`create()`, `delete()`, `describeSObjects()`, `query()`, `retrieve()`, `update()`, `upsert()`",
"supported_rest_api_http_methods": "`Query`, `GET`, `POST`, `PATCH`, `DELETE`",
"fields_columns": [
"type",
"properties",
"description"
],
"fields": {
"Description": {
"type": "textarea",
"properties": "Create, Filter, Group, Nillable, Sort, Query, Retrieve Update",
"description": "The permission set group description."
},
"DeveloperName": {
"type": "string",
"properties": "Create, Filter, Group, NameField, Sort, Update",
"description": "The permission set group name used in the API. Note: Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field."
},
"HasActivationRequired": {
"type": "boolean",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "Indicates whether the permission set group requires an associated active session (true) or not (false). The default value is false.This field is available in API version 53.0 and later."
},
"Language": {
"type": "picklist",
"properties": "Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
"description": "The Permission Set Group language. 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."
},
"ManageableState": {
"type": "ManageableState enumerated list",
"properties": "Filter, Group, Nillable, Restricted picklist, Sort",
"description": "Indicates the manageable state of the specified component that is contained in a package: beta deleted deprecated deprecatedEditable installed installedEditable released unmanaged"
},
"MasterLabel": {
"type": "string",
"properties": "Create, Filter, Group, Sort, Update",
"description": "The permission set group label for the aggregated permissions."
},
"NamespacePrefix": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The permission set group namespace prefix."
},
"Status": {
"type": "string",
"properties": "DefaultedOnCreate, Filter, Group, Restricted picklist, Sort",
"description": "Indicates the permission set group recalculation status. Updated. The group is current. Outdated. The group requires recalculation. Updating. The group is in recalculation mode. Failed. The group recalculation failed."
}
},
"special_access_rules": "As of Summer 20 and later, to view this object, users must have one of these permissions:\n- View Setup and Configuration\n- Manage Session Permission Set Activations\n- Assign Permission Sets\nTo edit this object, users must have the Manage Profiles and Permission Sets permission.",
"wsdl_segment": "```xml\n<xsd:simpleType name=\"ID\">\n <xsd:restriction base=\"xsd:string\">\n <xsd:length value=\"18\"/>\n <xsd:pattern value=\"[a-zA-Z0-9]{18}\"/>\n </xsd:restriction>\n</xsd:simpleType>\n<xsd:complexType name=\"PermissionSetGroup\">\n <xsd:complexContent>\n <xsd:extension base=\"ens:sObject\">\n <xsd:sequence>\n <xsd:element name=\"Assignments\" minOccurs=\"0\" type=\"tns:QueryResult\" nillable=\"true\"/>\n <xsd:element name=\"CreatedBy\" minOccurs=\"0\" type=\"ens:User\" nillable=\"true\"/>\n <xsd:element name=\"CreatedById\" minOccurs=\"0\" type=\"tns:ID\" nillable=\"true\"/>\n <xsd:element name=\"CreatedDate\" minOccurs=\"0\" type=\"xsd:dateTime\" nillable=\"true\"/>\n <xsd:element name=\"Description\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n <xsd:element name=\"DeveloperName\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n <xsd:element name=\"HasActivationRequired\" minOccurs=\"0\" type=\"xsd:boolean\" nillable=\"true\"/>\n <xsd:element name=\"IsDeleted\" minOccurs=\"0\" type=\"xsd:boolean\" nillable=\"true\"/>\n <xsd:element name=\"Language\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n <xsd:element name=\"LastModifiedBy\" minOccurs=\"0\" type=\"ens:User\" nillable=\"true\"/>\n <xsd:element name=\"LastModifiedById\" minOccurs=\"0\" type=\"tns:ID\" nillable=\"true\"/>\n <xsd:element name=\"LastModifiedDate\" minOccurs=\"0\" type=\"xsd:dateTime\" nillable=\"true\"/>\n <xsd:element name=\"ManageableState\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n <xsd:element name=\"MasterLabel\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n <xsd:element name=\"NamespacePrefix\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n <xsd:element name=\"PermissionSetGroupComponents\" minOccurs=\"0\" type=\"tns:QueryResult\" nillable=\"true\"/>\n <xsd:element name=\"Status\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n <xsd:element name=\"SystemModstamp\" minOccurs=\"0\" type=\"xsd:dateTime\" nillable=\"true\"/>\n </xsd:sequence>\n </xsd:extension>\n </xsd:complexContent>\n</xsd:complexType>\n<xsd:simpleType name=\"QueryLocator\">\n <xsd:restriction base=\"xsd:string\"/>\n</xsd:simpleType>\n<xsd:complexType name=\"QueryResult\">\n <xsd:sequence>\n <xsd:element name=\"done\" type=\"xsd:boolean\"/>\n <xsd:element name=\"entityTypeName\" type=\"xsd:string\"/>\n <xsd:element name=\"nextRecordsUrl\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"queryLocator\" type=\"tns:QueryLocator\"/>\n <xsd:element name=\"records\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"ens:sObject\"/>\n <xsd:element name=\"size\" type=\"xsd:int\"/>\n <xsd:element name=\"totalSize\" type=\"xsd:int\"/>\n </xsd:sequence>\n</xsd:complexType>\n```"
}