Account Invite Object


This service manages all invites related actions (site and account level)

Properties
acceptedByAccountIdstringRead-onlyformat GUID

Account ID that accepted the invite. Populated only once the invite is accepted.


acceptLinkstring

Link to accept the invite.


accountIdstringRead-onlyformat GUID

Account ID.


assignmentsArray <InviteResourceAssignment>

Assets the users are invited to join.


dateCreatedDate

Date the invite was created.


dateUpdatedDate

Date the invite was last updated.


emailstringformat EMAIL

Email address where the invite was sent.


expirationDateDate

Invite expiration date.


_idstringRead-onlyformat GUID

Invite ID.


inviterAccountIdstringRead-onlyformat GUID

Inviting account ID.


inviterIdstringRead-onlydeprecated

Deprecated. Use inviterAccountId.


policyIdsArray <string>

Role IDs included in the invite.


rolestringdeprecated

Deprecated. Use policyIds.


statusstring

Invite status.

Supported values:

  • Pending: The invite has been sent and is valid, waiting for the user's response.
  • Used: The invite has been accepted.
  • Deleted: The invite has been deleted or revoked.
  • Declined: The user has declined the invite.
  • Expired: The invite has expired without being accepted.
Did this help?