PermissionSetAssignment

Represents a user’s assignment to a permission set or permission set group.

Version 

Introduced in API version 52.0.

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 

AssigneeId 

• Type: reference

• Required: No

• 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: relationship
• Refers to: User

ExpirationDate 

• Type: datetime

• Required: No

• Properties: Create, Filter, Nillable, Sort, Update

• Introduced: API version 52.0

• Description: The date that the assignment of the permission set or permission set group expires for the specified user.

IsActive 

• Type: boolean

• Required: No

• Properties: Defaulted on create, Filter, Group, Sort

• Introduced: API version 52.0

• Description: Indicates whether the assignment is active (true) or not (false).

The default value is false.

• Default value: false

IsRevoked 

• Type: boolean

• Required: No

• Properties: Defaulted on create, Filter, Group, Sort, Update

• Introduced: API version 57.0

• Description: Indicates whether the assignment was revoked (true) or not (false).

The default value is false.

• Default value: false

  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 

• Type: ID

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 57.0

• Description: The ID of the user access change record related to this permission set or permission set group assignment.

This field is a relationship field.

LastDeletedByChangeId 

• Type: ID

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 57.0

• Description: The ID of the user access change record related to this permission set or permission set group assignment being revoked.

This field is a relationship field.

PermissionSetGroupId 

• Type: reference

• Required: No

• Properties: Create, Filter, Group, Nillable, Sort

• Introduced: API version 41.0

• Description: The ID of the permission set group assigned to the user specified in AssigneeId.

This field is a relationship field.

• Relationship name: PermissionSetGroup
• Relationship type: relationship
• Refers to: PermissionSetGroup

PermissionSetId 

• Type: reference

• Required: No

• 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: relationship
• Refers to: PermissionSet