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

{
  "sections": [
    "title",
    "description",
    "supported_soap_calls",
    "supported_rest_api_http_methods",
    "fields",
    "special_access_rules",
    "wsdl_segment"
  ],
  "title": "PermissionSetAssignment - Tooling API",
  "description": "Represents a user’s assignment to a permission set or permission set group. This object is available in API version 22.0 and later.",
  "supported_soap_calls": "`create()`, `delete()`, `describeSObjects()`, `query()`, `retrieve()`, `update()`, `upsert()`",
  "supported_rest_api_http_methods": "`DELETE`, `GET`, `HEAD`, `PATCH`, `POST`, `Query`",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "relationship_type",
    "refers_to"
  ],
  "fields": {
    "AssigneeId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Sort",
      "description": "The ID of the user that is assigned the permission set indicated in PermissionSetId or the permission set group indicated in PermissionSetGroupId. This field is a relationship field.",
      "relationship_name": "Assignee",
      "relationship_type": "Lookup",
      "refers_to": "User"
    },
    "ExpirationDate": {
      "type": "dateTime",
      "properties": "Create, Filter, Nillable, Sort, Update",
      "description": "The date that the assignment of the permission set or permission set group expires for the specified user. This field is available in API version 52.0 and later."
    },
    "IsActive": {
      "type": "boolean",
      "properties": "Defaulted on create, Filter, Group, Sort",
      "description": "Indicates whether the assignment is active (true) or not (false). This field is available in API version 52.0 and later. The default value is false."
    },
    "IsRevoked": {
      "type": "boolean",
      "properties": "Defaulted on create, Filter, Group, Sort, Update",
      "description": "Indicates whether the assignment was revoked (true) or not (false). This field is available in API version 57.0 and later. Note: This feature is a Beta Service. Customer may opt to try such Beta Service in its sole discretion. Any use of the Beta Service is subject to the applicable Beta Services Terms provided at Agreements and Terms. The default value is false."
    },
    "LastCreatedByChangeId": {
      "type": "reference",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The ID of the user access change record related to this permission set or permission set group assignment. This field is available in API version 57.0 and later. This field is a relationship field.",
      "relationship_name": "LastCreatedByChange",
      "relationship_type": "Lookup",
      "refers_to": "UserAccessChange"
    },
    "LastDeletedByChangeId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Sort",
      "description": "The ID of the user access change record related to this permission set or permission set group assignment being revoked. This field is available in API version 57.0 and later. This field is a relationship field.",
      "relationship_name": "LastCreatedByChange",
      "relationship_type": "Lookup",
      "refers_to": "UserAccessChange"
    },
    "PermissionSetGroupId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort",
      "description": "The ID of the permission set group assigned to the user specified in AssigneeId. This field is available in API version 45.0 and later. This field is a relationship field.",
      "relationship_name": "PermissionSetGroup",
      "relationship_type": "Lookup",
      "refers_to": "PermissionSetGroup"
    },
    "PermissionSetId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort",
      "description": "The ID of the permission set assigned to the user specified in AssigneeId. This field is a relationship field.",
      "relationship_name": "PermissionSet",
      "relationship_type": "Lookup",
      "refers_to": "PermissionSet"
    }
  },
  "special_access_rules": "As of Summer ’20 and later, only users who have one of these permissions can access this object:\n- View Setup and Configuration\n- Assign Permission Sets\n- Manage User",
  "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=\"PermissionSetAssignment\">\n  <xsd:complexContent>\n    <xsd:extension base=\"ens:sObject\">\n      <xsd:sequence>\n        <xsd:element name=\"Assignee\" minOccurs=\"0\" type=\"ens:User\" nillable=\"true\"/>\n        <xsd:element name=\"AssigneeId\" minOccurs=\"0\" type=\"tns:ID\" nillable=\"true\"/>\n        <xsd:element name=\"ExpirationDate\" minOccurs=\"0\" type=\"xsd:dateTime\" nillable=\"true\"/>\n        <xsd:element name=\"IsActive\" minOccurs=\"0\" type=\"xsd:boolean\" nillable=\"true\"/>\n        <xsd:element name=\"IsRevoked\" minOccurs=\"0\" type=\"xsd:boolean\" nillable=\"true\"/>\n        <xsd:element name=\"PermissionSet\" minOccurs=\"0\" type=\"ens:PermissionSet\" nillable=\"true\"/>\n        <xsd:element name=\"PermissionSetGroup\" minOccurs=\"0\" type=\"ens:PermissionSetGroup\" nillable=\"true\"/>\n        <xsd:element name=\"PermissionSetGroupId\" minOccurs=\"0\" type=\"tns:ID\" nillable=\"true\"/>\n        <xsd:element name=\"PermissionSetId\" minOccurs=\"0\" type=\"tns:ID\" 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```"
}