DeveloperPortalInvitationDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
An invitation as the back office reads it.
Values
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
| Field | Type | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
id
required |
string (uuid) |
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
creationTime
required |
string (date-time) | The date and time when this entity was created.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
creatorId
required |
string (uuid) | The ID of the user who created this entity.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
lastModificationTime
required |
string (date-time) | The date and time when this entity was last modified.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
lastModifierId
required |
string (uuid) | The ID of the user who last modified this entity.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
isDeleted
required |
boolean | Indicates whether this entity has been deleted.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
deleterId
required |
string (uuid) | The ID of the user who deleted this entity, if it is deleted.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
deletionTime
required |
string (date-time) | The date and time when this entity was deleted, if it is deleted.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
merchantId
required |
string (uuid) | The merchant the invitation offers access to, or `null` when it offers access to a
reseller. Exactly one of this and `resellerId` is set.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
resellerId
required |
string (uuid) | The reseller the invitation offers access to, or `null` when it offers access to a
merchant. Exactly one of this and `merchantId` is set.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
email
required |
string | The address the invitation was emailed to.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
invitedIdentityUserId
required |
string (uuid) | The identity user the invitation is for, and the only one who can redeem it.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
role
required |
DeveloperPortalRole DeveloperPortalRole | The portal capability a redemption will grant.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
expiresAt
required |
string (date-time) | When the invitation stops being redeemable, in UTC. The contract stays UTC in and UTC out;
display surfaces convert it to the viewer's time zone.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
status
required |
DeveloperPortalInvitationStatus DeveloperPortalInvitationStatus | The lifecycle state, already resolved against the clock by the reader.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
issuedByUserId
required |
string (uuid) | The back-office user who issued the invitation.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
redeemedAt
required |
string (date-time) | When the invitation was redeemed, in UTC, or `null` if it never was.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
revokedAt
required |
string (date-time) | When the invitation was revoked, in UTC, or `null` if it never was.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
concurrencyStamp
required |
string | Optimistic-concurrency token.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
user
required |
DeveloperPortalUserSummaryDto DeveloperPortalUserSummaryDto | The identity half of the invited party: who they are, and whether they already hold a
back-office role. `null` when the reader did not enrich the row.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
Fields of DeveloperPortalUserSummaryDto: This body has no documented fields. | ||||||||||
This model has no documented fields.