PermissionSetAssignment

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 API Calls

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

Supported REST API Methods

DELETE, GET, HEAD, PATCH, POST, Query

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 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 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 (Beta)
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.

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

The default value is false.
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 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