Files
clerk-sdk-java/docs/models/components/Invitation.md
2024-06-13 13:51:50 -04:00

16 lines
7.7 KiB
Markdown

# Invitation
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `object` | [com.clerk.backend_api.models.components.InvitationObject](../../models/components/InvitationObject.md) | :heavy_check_mark: | N/A | |
| `id` | *String* | :heavy_check_mark: | N/A | |
| `emailAddress` | *String* | :heavy_check_mark: | N/A | |
| `publicMetadata` | [Optional<? extends com.clerk.backend_api.models.components.InvitationPublicMetadata>](../../models/components/InvitationPublicMetadata.md) | :heavy_minus_sign: | N/A | |
| `revoked` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A | false |
| `status` | [com.clerk.backend_api.models.components.InvitationStatus](../../models/components/InvitationStatus.md) | :heavy_check_mark: | N/A | pending |
| `url` | *JsonNullable<? extends String>* | :heavy_minus_sign: | N/A | |
| `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation.<br/> | |
| `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of last update.<br/> | |