mirror of
https://github.com/LukeHagar/clerk-sdk-java.git
synced 2025-12-06 20:37:47 +00:00
44 lines
43 KiB
Markdown
44 lines
43 KiB
Markdown
# User
|
|
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description | Example |
|
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `id` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | |
|
|
| `object` | [Optional<? extends com.clerk.backend_api.models.components.UserObject>](../../models/components/UserObject.md) | :heavy_minus_sign: | String representing the object's type. Objects of the same type share the same value.<br/> | |
|
|
| `externalId` | *JsonNullable<? extends String>* | :heavy_minus_sign: | N/A | |
|
|
| `primaryEmailAddressId` | *JsonNullable<? extends String>* | :heavy_minus_sign: | N/A | |
|
|
| `primaryPhoneNumberId` | *JsonNullable<? extends String>* | :heavy_minus_sign: | N/A | |
|
|
| `primaryWeb3WalletId` | *JsonNullable<? extends String>* | :heavy_minus_sign: | N/A | |
|
|
| `username` | *JsonNullable<? extends String>* | :heavy_minus_sign: | N/A | |
|
|
| `firstName` | *JsonNullable<? extends String>* | :heavy_minus_sign: | N/A | |
|
|
| `lastName` | *JsonNullable<? extends String>* | :heavy_minus_sign: | N/A | |
|
|
| ~~`profileImageUrl`~~ | *Optional<? extends String>* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | |
|
|
| `imageUrl` | *Optional<? extends String>* | :heavy_minus_sign: | N/A | |
|
|
| `hasImage` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A | |
|
|
| `publicMetadata` | [Optional<? extends com.clerk.backend_api.models.components.PublicMetadata>](../../models/components/PublicMetadata.md) | :heavy_minus_sign: | N/A | |
|
|
| `privateMetadata` | [JsonNullable<? extends com.clerk.backend_api.models.components.PrivateMetadata>](../../models/components/PrivateMetadata.md) | :heavy_minus_sign: | N/A | |
|
|
| `unsafeMetadata` | [Optional<? extends com.clerk.backend_api.models.components.UnsafeMetadata>](../../models/components/UnsafeMetadata.md) | :heavy_minus_sign: | N/A | |
|
|
| `emailAddresses` | List<[com.clerk.backend_api.models.components.EmailAddress](../../models/components/EmailAddress.md)> | :heavy_minus_sign: | N/A | |
|
|
| `phoneNumbers` | List<[com.clerk.backend_api.models.components.PhoneNumber](../../models/components/PhoneNumber.md)> | :heavy_minus_sign: | N/A | |
|
|
| `web3Wallets` | List<[com.clerk.backend_api.models.components.Web3Wallet](../../models/components/Web3Wallet.md)> | :heavy_minus_sign: | N/A | |
|
|
| `passkeys` | List<[com.clerk.backend_api.models.components.SchemasPasskey](../../models/components/SchemasPasskey.md)> | :heavy_minus_sign: | N/A | |
|
|
| `passwordEnabled` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A | |
|
|
| `twoFactorEnabled` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A | |
|
|
| `totpEnabled` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A | |
|
|
| `backupCodeEnabled` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A | |
|
|
| `mfaEnabledAt` | *JsonNullable<? extends Long>* | :heavy_minus_sign: | Unix timestamp of when MFA was last enabled for this user. It should be noted that this field is not nullified if MFA is disabled.<br/> | |
|
|
| `mfaDisabledAt` | *JsonNullable<? extends Long>* | :heavy_minus_sign: | Unix timestamp of when MFA was last disabled for this user. It should be noted that this field is not nullified if MFA is enabled again.<br/> | |
|
|
| `externalAccounts` | List<[com.clerk.backend_api.models.components.ExternalAccounts](../../models/components/ExternalAccounts.md)> | :heavy_minus_sign: | N/A | |
|
|
| `samlAccounts` | List<[com.clerk.backend_api.models.components.SAMLAccount](../../models/components/SAMLAccount.md)> | :heavy_minus_sign: | N/A | |
|
|
| `lastSignInAt` | *JsonNullable<? extends Long>* | :heavy_minus_sign: | Unix timestamp of last sign-in.<br/> | |
|
|
| `banned` | *Optional<? extends Boolean>* | :heavy_minus_sign: | Flag to denote whether user is banned or not.<br/> | |
|
|
| `locked` | *Optional<? extends Boolean>* | :heavy_minus_sign: | Flag to denote whether user is currently locked, i.e. restricted from signing in or not.<br/> | |
|
|
| `lockoutExpiresInSeconds` | *JsonNullable<? extends Long>* | :heavy_minus_sign: | The number of seconds remaining until the lockout period expires for a locked user. A null value for a locked user indicates that lockout never expires.<br/> | |
|
|
| `verificationAttemptsRemaining` | *JsonNullable<? extends Long>* | :heavy_minus_sign: | The number of verification attempts remaining until the user is locked. Null if account lockout is not enabled. Note: if a user is locked explicitly via the Backend API, they may still have verification attempts remaining.<br/> | |
|
|
| `updatedAt` | *Optional<? extends Long>* | :heavy_minus_sign: | Unix timestamp of last update.<br/> | |
|
|
| `createdAt` | *Optional<? extends Long>* | :heavy_minus_sign: | Unix timestamp of creation.<br/> | |
|
|
| `deleteSelfEnabled` | *Optional<? extends Boolean>* | :heavy_minus_sign: | If enabled, user can delete themselves via FAPI.<br/> | |
|
|
| `createOrganizationEnabled` | *Optional<? extends Boolean>* | :heavy_minus_sign: | If enabled, user can create organizations via FAPI.<br/> | |
|
|
| `lastActiveAt` | *JsonNullable<? extends Long>* | :heavy_minus_sign: | Unix timestamp of the latest session activity, with day precision.<br/> | 1700690400000 | |