{"id":"sforce_api_objects_permissionsetassignment","title":"PermissionSetAssignment","content":"

PermissionSetAssignment

\n
\nRepresents a user’s assignment to a permission set or permission set\n group. This object is available in API version 22.0 and later.
\n\n
\n

Supported Calls

\n\n \n

create(), delete(),\n describeSObjects(), query(), retrieve(), update()

\n\n
\n\n
\n

Special Access Rules

\n\n \n

As of Summer ’20 and later, only users who have one of these permissions can access this\n object:

\n\n \n\n
\n\n
\n

Fields

\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
Field NameDetails
AssigneeId\n
\n \n
Type
\n\n
reference
\n\n \n \n
Properties
\n\n
Create, Filter, Group, Sort
\n\n \n \n
Description
\n\n
The ID of the user that is assigned the permission set indicated in\n PermissionSetId or the permission set group indicated in\n PermissionSetGroupId.
\n\n
This is a relationship field.
\n\n \n \n
Relationship Name
\n\n
Assignee
\n\n \n \n
Relationship Type
\n\n
Lookup
\n\n \n \n
Refers To
\n\n
User
\n\n \n
\n\n
ExpirationDate\n
\n \n
Type
\n\n
dateTime
\n\n \n \n
Properties
\n\n
Create, Filter, Nillable, Sort, Update
\n\n \n \n
Description
\n\n
The date that the assignment of the permission set or permission set group expires for\n the specified user. This field is available in API version 52.0 and later.
\n\n \n
\n\n
IsActive\n
\n \n
Type
\n\n
boolean
\n\n \n \n
Properties
\n\n
Defaulted on create, Filter, Group, Sort
\n\n \n \n
Description
\n\n
Indicates whether the assignment is active (true)\n or not (false). Defaults to false. This field is available in API version 52.0 and\n later.
\n\n \n
\n\n
IsRevoked\n
\n \n
Type
\n\n
boolean
\n\n \n \n
Properties
\n\n
Defaulted on create, Filter, Group, Sort, Update
\n\n \n \n
Description
\n\n
Indicates whether the assignment was revoked (true) or not (false). Defaults to false. This field is available only if user access policies\n are enabled. This field is available in API version 57.0 and later.
\n\n
\n\n \n
\n\n
LastCreatedByChangeId\n
\n \n
Type
\n\n
reference
\n\n \n \n
Properties
\n\n
Filter, Group, Nillable, Sort
\n\n \n \n
Description
\n\n
The ID of the user access change record related to this permission set or permission\n set group assignment. This field is available only if user access policies are enabled.\n This field is available in API version 57.0 and later.
\n\n
This field is a relationship field.
\n\n \n \n
Relationship Name
\n\n
LastCreatedByChange
\n\n \n \n
Relationship Type
\n\n
Lookup
\n\n \n \n
Refers To
\n\n
UserAccessChange
\n\n \n
\n\n
LastDeletedByChangeId\n
\n \n
Type
\n\n
reference
\n\n \n \n
Properties
\n\n
Create, Filter, Group, Sort
\n\n \n \n
Description
\n\n
The ID of the user access change record related to this permission set or permission\n set group assignment being revoked. This field is available only if user access policies\n are enabled. This field is available in API version 57.0 and later.
\n\n
This field is a relationship field.
\n\n \n \n
Relationship Name
\n\n
LastCreatedByChange
\n\n \n \n
Relationship Type
\n\n
Lookup
\n\n \n \n
Refers To
\n\n
UserAccessChange
\n\n \n
\n\n
PermissionSetGroupId\n
\n \n
Type
\n\n
reference
\n\n \n \n
Properties
\n\n
Create, Filter, Group, Nillable, Sort
\n\n \n \n
Description
\n\n
The ID of the permission set group assigned to the user specified in\n AssigneeId. This field is available in API version 45.0 and\n later.
\n\n
This is a relationship field.
\n\n \n \n
Relationship Name
\n\n
PermissionSetGroup
\n\n \n \n
Relationship Type
\n\n
Lookup
\n\n \n \n
Refers To
\n\n
PermissionSetGroup
\n\n \n
\n\n
PermissionSetId\n
\n \n
Type
\n\n
reference
\n\n \n \n
Properties
\n\n
Create, Filter, Group, Nillable, Sort
\n\n \n \n
Description
\n\n
The ID of the permission set assigned to the user specified in\n AssigneeId.
\n\n
This is a relationship field.
\n\n \n \n
Relationship Name
\n\n
PermissionSet
\n\n \n \n
Relationship Type
\n\n
Lookup
\n\n \n \n
Refers To
\n\n
PermissionSet
\n\n \n
\n\n
\n\n
\n\n
\n

Usage

\n\n \n
\n \n
Finding Permission Set Assignments
\n\n
Use the PermissionSetAssignment object to\n query permission set assignments to find out which permission sets are assigned to which\n users. Because each user can be assigned to many permission sets and each permission set can\n be assigned to many users, each PermissionSetAssignment ID represents the\n association of a single user and single permission set.
\n\n
For example, to search for all permission sets assigned to a particular\n user:
SELECT Id, PermissionSetId\nFROM PermissionSetAssignment\nWHERE AssigneeId = '005600000017cKt'
\nTo\n search for all users assigned to a particular permission\n set:
SELECT Id, AssigneeId\nFROM PermissionSetAssignment\nWHERE PermissionSetId = '0PS30000000000e'
\nYou\n can also create a new permission set assignment, or use delete to remove a permission set\n that's assigned to a user. To update an assignment, delete an existing assignment and insert a\n new one.
\n\n \n \n
User Licenses
\n\n
When assigning a permission set, if the PermissionSet has a\n UserLicenseId, its UserLicenseId and the Profile\n UserLicenseId must match. To determine a user's license assignment,\n query the user's profile and then query the profile's license.
\n\n
For example, to find a user's profile\n ID:
SELECT Id, ProfileId\nFROM User\nWHERE Id = '005D0000001GMAT'
\nTo\n find a permission set's\n UserLicenseId:
SELECT Id, LicenseId\nFROM PermissionSet\nWHERE Id = '0PS30000000000e'
\nIf\n the IDs match, the assignment succeeds.
\n\n
To find all the permission sets with no license that are assigned to any\n user:
SELECT Id, Assignee.Name, PermissionSet.Name\nFROM PermissionSetAssignment\nWHERE PermissionSet.LicenseId = null
\n
\n\n \n \n
Revoked Assignments from User Access Policies
\n\n
After you revoke a permission set or permission set group assignment via a user access\n policy, the IsRevoked field is updated to true. The PermissionSetAssignment record isn’t deleted. If the permission set or\n permission set group is assigned to the user again, the IsRevoked field\n is then updated to false.
\n\n
To find permission set or permission set group assignments that were\n revoked:
SELECT Id, ExpirationDate, Assignee.Name, PermissionSet.Name\nFROM PermissionSetAssignment\nWHERE IsRevoked=true ALL ROWS
\n
\n\n \n
\n\n
\n\n
\n
\n

See Also

\n\n
\n
"}