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

{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules",
    "usage",
    "wsdl_segment",
    "field_reference"
  ],
  "title": "UserShare - Data API",
  "description": "Represents a sharing entry on a user record. This object is available in API version 26.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "relationship_type",
    "refers_to"
  ],
  "fields": {
    "IsActive": {
      "type": "boolean",
      "properties": "Defaulted on create, Filter, Group, Sort",
      "description": "Read-only. Indicates whether the User has access to log in (true) or not (false). You can modify a User's active status from the user interface or via the API."
    },
    "RowCause": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "Reason that this sharing entry exists. If you’re creating a sharing entry, the only permitted value is Manual. If no value is specified, the field defaults to Manual. All other RowCause values are read-only. After the sharing entry is created, this field can’t be edited. Possible values include: Manual—The User or Group has access to the user record because a User with “All” access manually shared the User with them. Rule—The User or Group has access to the user record via a User sharing rule. GuestRule—The User or Group has access via a User guest user sharing rule. LpuImplicit—The User has access to records owned by high-volume Experience Cloud site users via a share group."
    },
    "UserAccessLevel": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Restricted picklist, Sort, Update",
      "description": "Level of access that the User or Group has to the specified user. The specified user is denoted by the UserId. The possible values are: Read Edit This field must be set to an access level that is at least equal to the organization’s default UserAccessLevel. UserAccessLevel can be updated only if RowCause is set to Manual Sharing."
    },
    "UserId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Sort",
      "description": "ID of the User being shared. This is a relationship field.",
      "relationship_name": "User",
      "relationship_type": "Lookup",
      "refers_to": "User"
    },
    "UserOrGroupId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Sort",
      "description": "ID of the User or Group that has been given access to the User. This field can’t be updated. This is a polymorphic relationship field.",
      "relationship_name": "UserOrGroup",
      "relationship_type": "Lookup",
      "refers_to": "Group, User"
    }
  },
  "special_access_rules": "As of Summer ’20 and later, only standard users or users with the Customize Application permission can access this object.",
  "usage": "This object allows you to determine which users and groups can view or edit User records owned by other users.",
  "wsdl_segment": "```xml\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<complexType name=\"UserShare\">\n  <complexContent>\n    <extension base=\"ens:sObject\">\n      <sequence>\n        <element name=\"IsActive\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\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=\"RowCause\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"User\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"UserAccessLevel\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"UserId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"UserOrGroup\" nillable=\"true\" minOccurs=\"0\" type=\"ens:sObject\"/>\n        <element name=\"UserOrGroupId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n      </sequence>\n    </extension>\n  </complexContent>\n</complexType>\n```",
  "field_reference": {
    "Id": {
      "field_label": "User Share ID",
      "type": "id",
      "length": "18"
    },
    "IsActive": {
      "field_label": "Active",
      "type": "boolean"
    },
    "LastModifiedById": {
      "field_label": "Last Modified By ID",
      "type": "reference",
      "length": "18"
    },
    "LastModifiedDate": {
      "field_label": "Last Modified Date",
      "type": "datetime"
    },
    "RowCause": {
      "field_label": "Row Cause",
      "type": "picklist",
      "length": "40"
    },
    "UserAccessLevel": {
      "field_label": "User Access Level",
      "type": "picklist",
      "length": "40"
    },
    "UserId": {
      "field_label": "User ID",
      "type": "reference",
      "length": "18"
    },
    "UserOrGroupId": {
      "field_label": "User/Group ID",
      "type": "reference",
      "length": "18"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length"
  ]
}