AccessDelegationRequest

Represents a request submitted by a user to delegate access to and permit actions upon specific information. This object is available in API version 68.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

Field Details
AccessDelegatedById
Type
reference
Properties
Create, Filter, Group, Sort
Description
The user who authorized delegated access to act upon specific information.
This field is a relationship field.
Relationship Name
AccessDelegatedBy
Refers To
User
ActualEndDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date when the access is revoked.
ActualStartDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date when the access is granted.
DelegateAccessDefId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The delegate access record that's associated with the access delegation request.
This field is a relationship field.
Relationship Name
DelegateAccessDef
Refers To
DelegateAccessDef
DelegatedContactId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The contact record that's associated with the access delegation request.
This field is a relationship field.
Relationship Name
DelegatedContact
Refers To
Contact
DelegatedEmail
Type
email
Properties
Create, Filter, Group, Sort
Description
The email of the user who is given permission to access and act upon specific information.
DelegatedFirstName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The first name of the user who is given permission to access and act upon specific information.
DelegatedLastName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The last name of the user who is given permission to access and act upon specific information.
DelegatedUserId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The user who is given permission to access and act upon specific information.
This field is a relationship field.
Relationship Name
DelegatedUser
Refers To
User
EndDate
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The end date of the access.
ErrorMessage
Type
textarea
Properties
Filter, Group, Nillable, Sort
Description
The message generated if there's an error saving the access request.
LastProcessedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date and time the access delegation request was last processed.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last accessed this record, a record related to this record, or a list view.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last viewed this record or list view. If this value is null, the user might have only accessed this record or list view (LastReferencedDate) but not viewed it.
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
The name of the access delegation request record.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The user who owns this record.
This field is a polymorphic relationship field.
Relationship Name
Owner
Refers To
Group, User
PartyRoleRelationId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The party role relation record that's associated with the access delegation request.
This field is a relationship field.
Relationship Name
PartyRoleRelation
Refers To
PartyRoleRelation
Purpose
Type
textarea
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The detailed explanation of the purpose of the request.
RequestDetails
Type
textarea
Properties
Filter, Group, Nillable, Sort
Description
The details of processing the access delegation request.
RequestSource
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort
Description
Specifies the origin of the access delegation request.
Possible values are:
  • CRM
  • Portal
RequestedById
Type
reference
Properties
Create, Filter, Group, Sort
Description
The user who requested to delegate access to act upon specific information.
This field is a relationship field.
Relationship Name
RequestedBy
Refers To
User
StartDate
Type
dateTime
Properties
Create, Filter, Sort, Update
Description
The date when the request was submitted.
Status
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
Description
Specifies the status of the request.
Possible values are:
  • Active—Granted
  • Expired
  • ExpiredFailed—Expiry Failed
  • Expiring—Expiry In Progress
  • Failed
  • GrantFailed—Grant Failed
  • Granting—Grant In Progress
  • New
  • Pending
  • Retry—Pending Retry
  • Review—Needs Review
  • Revoke—Revoke Requested
  • RevokeFailed—Revoke Failed
  • Revoked
  • Revoking—Revoke In Progress
  • Scheduled
The default value is New.

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

AccessDelegationRequestChangeEvent
Change events are available for the object.