PermissionSetAssignment

Supported Calls

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

Special Access Rules

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

View Setup and Configuration
Assign Permission Sets
Manage User

Fields

Field Name	Details
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 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`). Defaults to `false`. This field is available in API version 52.0 and later.
IsRevoked (Beta)	Type boolean Properties Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the assignment was revoked (`true`) or not (`false`). Defaults to `false`. This field is available in API version 57.0 and later. 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. Note
LastCreatedByChangeId (Beta)	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 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. Note
LastDeletedByChangeId (Beta)	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 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. Note
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 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 is a relationship field. Relationship Name PermissionSet Relationship Type Lookup Refers To PermissionSet

Usage

Finding Permission Set Assignments

Use the PermissionSetAssignment object to query permission set assignments to find out which permission sets are assigned to which users. Because each user can be assigned to many permission sets and each permission set can be assigned to many users, each PermissionSetAssignment ID represents the association of a single user and single permission set.

For example, to search for all permission sets assigned to a particular user:

1SELECT Id, PermissionSetId
2FROM PermissionSetAssignment
3WHERE AssigneeId = '005600000017cKt'

To search for all users assigned to a particular permission set:

1SELECT Id, AssigneeId
2FROM PermissionSetAssignment
3WHERE PermissionSetId = '0PS30000000000e'

You can also create a new permission set assignment, or use delete to remove a permission set that's assigned to a user. To update an assignment, delete an existing assignment and insert a new one.

User Licenses

When assigning a permission set, if the PermissionSet has a UserLicenseId, its UserLicenseId and the Profile UserLicenseId must match. To determine a user's license assignment, query the user's profile and then query the profile's license.

For example, to find a user's profile ID:

1SELECT Id, ProfileId
2FROM User
3WHERE Id = '005D0000001GMAT'

To find a permission set's UserLicenseId:

1SELECT Id, LicenseId
2FROM PermissionSet
3WHERE Id = '0PS30000000000e'

If the IDs match, the assignment succeeds.

To find all the permission sets with no license that are assigned to any user:

1SELECT Id, Assignee.Name, PermissionSet.Name
2FROM PermissionSetAssignment
3WHERE PermissionSet.LicenseId = null

Object Reference for the Salesforce Platform

Supported Calls

Special Access Rules

Fields

Usage

See Also