Account Invite Object

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

Properties
idstringRead-onlyformat GUID

Invite ID.

accountIdstringRead-onlyformat GUID

Account ID.

emailstringformat EMAIL

Email address where the invite was sent.

rolestringdeprecated

Deprecated. Use policyIds.

inviterIdstringRead-onlydeprecated

Deprecated. Use inviterAccountId.

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.
acceptLinkstring

Link to accept the invite.

inviterAccountIdstringRead-onlyformat GUID

Inviting account ID.

acceptedByAccountIdstringRead-onlyformat GUID

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

dateCreatedstringformat date-time

Date the invite was created.

policyIdsArray <string>

Role IDs included in the invite.

dateUpdatedstringformat date-time

Date the invite was last updated.

assignmentsArray <InviteResourceAssignment>

Assets the users are invited to join.

expirationDatestringformat date-time

Invite expiration date.

Was this helpful?
Yes
No