MagicLinkModel
Less than to read
Represents a magic link that can be used to log in to a Sage Network application.
Methods
The following API methods use this data model.
- Retrieve Magic Link
- Query Magic Links
Read-Only Fields
These fields are assigned by the API server and cannot be changed.
magicLinkId
uuid, read-only
The unique ID of this record, automatically assigned by Sage Network when this record is added to the Sage Network.
groupKey
uuid, read-only
The GroupKey uniquely identifies a single Sage Network account. All records for this account will share the same GroupKey value. GroupKey values cannot be changed once created.
userId
uuid, read-only
The unique ID of the user that this magic link is associated with.
userRole
uuid, read-only
The ID of the user role for the magic link.
applicationId
uuid, read-only
The ID of the application for this magic link.
expires
date-time, read-only
The UTC date and time when this magic link expires.
created
date-time, read-only
The date that the magic link was created
createdUserId
uuid, read-only
The ID of the user who created the magic link
modified
date-time, read-only
The date that the magic link was last modified
modifiedUserId
uuid, read-only
The ID of the user who last modified the magic link
companyId
uuid, nullable, read-only
The ID of the company associated to this magic link
accountingProfileId
uuid, nullable, read-only
The ID of the accounting profile associated to this magic link
magicLinkUrl
string, nullable, read-only
The created magic link URL. This will only be returned upon creation of the magic link.
All other times, this value will be null.
user
UserAccountModel, nullable, read-only
The user associated with this magic link.
To retrieve this item, specify User in the “Include” parameter for your query.
Optional Fields
revoked
date-time, nullable
The UTC date and time when this magic link was revoked.