accounts

Updates the account profile and starts email verification when required.

Changed on

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

put/accounts/{accountId}

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/accounts/{accountId}
  • Auth: HTTP bearer

Path parameters

accountIdstring uuid required

The accountId value.

Query parameters

skipEmailVerificationboolean

The skipEmailVerification value.

sendAdminInitiatedVerificationEmailboolean

The sendAdminInitiatedVerificationEmail value.

Request body

emailstring email nullable

The email of the account.

firstNamestring nullable

The first name of the account.

lastNamestring nullable

The last name of the account.

languagestring nullable

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

timezonestring nullable

The timezone of the account. The format of the timezone is the IANA standard.

mfaEnabledboolean

Whether MFA is enabled for the account.

Response

OK

emailstring email nullable

The email of the account.

firstNamestring nullable

The first name of the account.

lastNamestring nullable

The last name of the account.

languagestring nullable

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

timezonestring nullable

The timezone of the account. The format of the timezone is the IANA standard.

mfaEnabledboolean

Whether MFA is enabled for the account.

idstring uuid

The id of the account.

passwordIsAutoGeneratedboolean

Whether the password is generated by awork.

emailConfirmedboolean

Whether the email has been confirmed by the user.

mfaProvidersstring[] nullable

The enabled MFA providers for the account. Currently we support "Email" and "Authenticator".

passwordlessEnabledboolean

Whether the account has passwordless login enabled.

Changes

  • 5332322ffca3Revision changes
    • info

      api operation id accounts_PutAccount removed and replaced with accounts_PutAccountsByAccountId

    • info

      added the new optional query request parameter sendAdminInitiatedVerificationEmail

    • info

      added the new optional query request parameter skipEmailVerification

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 1556e0487867Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API