users

Archives or unarchives the user.

Changed on

Archives or unarchives the user. Archived objects can not be used any longer but still exist for being referenced by other entities.

<Check title="Required Permissions" icon="key">The user must be an admin or have project-manage-config:write permissions.</Check>

post/users/{userId}/setarchived

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/users/{userId}/setarchived
  • Auth: HTTP bearer

Path parameters

userIdstring uuid required

The id of the user.

Request body

isArchivedboolean

Flags the entity as archived.

Response

OK

firstNamestring nullable

The firstname of the user.

lastNamestring nullable

The lastname of the user.

birthDatestring date-time nullable

The birthdate of the user.

genderstring nullable

The gender of the user.

titlestring nullable

The title of the user.

positionstring nullable

The position of the user.

languagestring nullable

The language preference of the user in ISO 639-1 format.

idstring uuid

The id of the user.

createdOnstring date-time

The date this user was created.

createdBystring uuid

The id of the user who created this user.

updatedOnstring date-time

The date when this user was last updated.

updatedBystring uuid

The id of the user who updated the entity.

isArchivedboolean

Whether this user is archived. Archived users are automatically inactive and only exist for reference purposes.

isDeactivatedboolean

Whether the user has been deactivated.

deactivatedOnstring date-time nullable

The date the user was deactivated.

deletedOnstring date-time nullable

The date the user was deleted (soft delete).

hasImageboolean

Whether the user has uploaded a profile image.

shouldMigrateToConnectboolean

Whether the user should be migrated to Connect.

resourceVersioninteger

The version of the entity, updated on every modification, to the ticks in UTC. Not identical to UpdatedOn.

isExternalboolean

True if this entity is coming from an external workspace (awork Connect).

accountIdstring uuid nullable

The account id of the user. Only used internally.

Changes