Authentication
AuthorizationBearerSend your token in the Authorization: Bearer <token> header. See Authentication for API keys and OAuth.
Path parameters
accountIdstringRequiredThe accountId value.
Query parameters
skipEmailVerificationbooleanOptionalfalseThe skipEmailVerification value.
sendAdminInitiatedVerificationEmailbooleanOptionalfalseThe sendAdminInitiatedVerificationEmail value.
Request body Required
The model value.
application/json
emailstring or nullOptionalThe email of the account.
firstNamestring or nullOptionalThe first name of the account.
lastNamestring or nullOptionalThe last name of the account.
languagestring or nullOptionalThe language of the account, as a Language Culture Name (de-DE).
timezonestring or nullOptionalThe timezone of the account. The format of the timezone is the IANA standard.
mfaEnabledbooleanOptionalWhether MFA is enabled for the account.
Responses
200 OK
application/json
emailstring or nullOptionalThe email of the account.
firstNamestring or nullOptionalThe first name of the account.
lastNamestring or nullOptionalThe last name of the account.
languagestring or nullOptionalThe language of the account, as a Language Culture Name (de-DE).
timezonestring or nullOptionalThe timezone of the account. The format of the timezone is the IANA standard.
mfaEnabledbooleanOptionalWhether MFA is enabled for the account.
idstringOptionalThe id of the account.
passwordIsAutoGeneratedbooleanOptionalWhether the password is generated by awork.
emailConfirmedbooleanOptionalWhether the email has been confirmed by the user.
externalAccountsarray of object or nullOptionalThe list of connected social providers.
Show 2 properties
providerstring or nullOptionalThe name of the external provider.
externalUserIdstring or nullOptionalThe id of the user for the external account.
mfaProvidersarray of string or nullOptionalThe enabled MFA providers for the account. Currently we support "Email" and "Authenticator".
passwordlessEnabledbooleanOptionalWhether the account has passwordless login enabled.
400 Bad Request
application/json
codestringRequired1 The error code.
descriptionstringRequired1 The description of the error.
linkstringRequired1 The link to the API documentation page.
detailsarray of string or nullOptionalA list of details describing the error.
validationErrorsarray of object or nullOptionalIf a validation error occurred, this contains the validation errors for each property.
Show 2 properties
propertystring or nullOptionalThe name of the property that failed validation.
messagestring or nullOptionalThe reason why this property failed validation.
traceIdstring or nullOptionalThe request trace id for tracking the request.
401 Unauthorized
application/json
codestringRequired1 The error code.
descriptionstringRequired1 The description of the error.
linkstringRequired1 The link to the API documentation page.
detailsarray of string or nullOptionalA list of details describing the error.
validationErrorsarray of object or nullOptionalIf a validation error occurred, this contains the validation errors for each property.
Show 2 properties
propertystring or nullOptionalThe name of the property that failed validation.
messagestring or nullOptionalThe reason why this property failed validation.
traceIdstring or nullOptionalThe request trace id for tracking the request.
404 Not Found
application/json
codestringRequired1 The error code.
descriptionstringRequired1 The description of the error.
linkstringRequired1 The link to the API documentation page.
detailsarray of string or nullOptionalA list of details describing the error.
validationErrorsarray of object or nullOptionalIf a validation error occurred, this contains the validation errors for each property.
Show 2 properties
propertystring or nullOptionalThe name of the property that failed validation.
messagestring or nullOptionalThe reason why this property failed validation.
traceIdstring or nullOptionalThe request trace id for tracking the request.