API v1 ReferenceAccounts

Updates the account profile and starts email verification when required.

<Check title="Required Permissions" icon="key">Any authenticated user.</Check>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

accountIdstringRequiredformat: "uuid"
The accountId value.

Query parameters

skipEmailVerificationbooleanOptionalDefaults to false
The skipEmailVerification value.
sendAdminInitiatedVerificationEmailbooleanOptionalDefaults to false
The sendAdminInitiatedVerificationEmail value.

Request

The model value.
emailstring or nullOptionalformat: "email"
The email of the account.
firstNamestring or nullOptional
The first name of the account.
lastNamestring or nullOptional
The last name of the account.
languagestring or nullOptional

The language of the account, as a Language Culture Name (de-DE).

timezonestring or nullOptional
The timezone of the account. The format of the timezone is the IANA standard.
mfaEnabledbooleanOptional
Whether MFA is enabled for the account.

Response

OK
emailstring or nullOptionalformat: "email"
The email of the account.
firstNamestring or nullOptional
The first name of the account.
lastNamestring or nullOptional
The last name of the account.
languagestring or nullOptional

The language of the account, as a Language Culture Name (de-DE).

timezonestring or nullOptional
The timezone of the account. The format of the timezone is the IANA standard.
mfaEnabledbooleanOptional
Whether MFA is enabled for the account.
idstringOptionalformat: "uuid"
The id of the account.
passwordIsAutoGeneratedbooleanOptional
Whether the password is generated by awork.
emailConfirmedbooleanOptional
Whether the email has been confirmed by the user.
externalAccountslist of objects or nullOptional
The list of connected social providers.
mfaProviderslist of strings or nullOptional
The enabled MFA providers for the account. Currently we support "Email" and "Authenticator".
passwordlessEnabledbooleanOptional
Whether the account has passwordless login enabled.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error