---
title: User
slug: oip-next/ahrivc-24vmcerycn4xp9
icon: {"lucideIcon":"📘"}
createdAt: 2024-04-08T10:17:29.000Z
---

# User

## Description

L'entité User regroupe les informations relatives à l'utilisateur actif de l'OAV (généralement un apporteur ou un courtier, mais peut être un end user dans le cadre d'un OAV ouvert au public).

## Relations

### Ascendantes

| Entité  | Propriété |
| ------- | --------- |
| Project | users     |

### Descendantes

| Entité  | Propriété |
| ------- | --------- |
| GDPR    | GDPRs     |
| Address | addresses |
| Email   | emails    |
| History | history   |
| Phone   | phones    |

## Propriétés

| Nom          | Type             | Description                                                                    | Validateur              | Lecture seule ? | Dépréciée ? | Dernière version modifiée |
| ------------ | ---------------- | ------------------------------------------------------------------------------ | ----------------------- | --------------- | ----------- | ------------------------- |
| ORIAS        | `String`         | numéro/ID ORIAS de la société de l'utilisateur dans le cas d'un courtier       | Exactement 8 caractères |                 |             | 2.6.1                     |
| companyName  | `String`         | Nom de la société de l'utilisateur (agence, cabinet, etc)                      |                         |                 |             | 2.0.0                     |
| email        | `String`         | E-mail de l'utilisateur                                                        |                         |                 |             | 2.0.0                     |
| firstName    | `String`         | Prénom de l'utilisateur                                                        |                         |                 |             | 2.0.0                     |
| isActive     | `Boolean`        | Indique si l'utilisateur est actif ou non                                      |                         |                 |             | 3.11.0                    |
| lastName     | `String`         | Nom de famille l'utilisateur                                                   |                         |                 |             | 2.0.0                     |
| login        | `String`         | Login de l'utilisateur                                                         |                         |                 |             | 2.0.0                     |
| network      | `String`         | Réseau de courtiers auquel appartient l'utilisateur                            |                         |                 |             | 2.0.0                     |
| origin       | `UserOriginEnum` | Origine du décrochage de l'utilisateur au moment du décrochage.                |                         |                 |             | 2.22.0                    |
| roles        | `String[]`       | Roles de l'utilisateur                                                         |                         |                 |             | 2.0.0                     |
| id           | `String`         | Identifiant de l'entité `User`                                                 |                         | X               |             |                           |
| code         | `String`         | Codification fonctionnelle de l'entité `User`                                  |                         |                 |             |                           |
| externalId   | `String`         | Identifiant de l'entité `User` dans le système client                          |                         |                 |             |                           |
| externalCode | `String`         | Codification fonctionnelle de l'entité `User` dans le système client           |                         |                 |             |                           |
| userId       | `String`         | Identifiant public de l'entité `User` dans l'OIP                               |                         |                 |             |                           |
| label        | `String`         | Information relative au nom de l'entité `User` dans son contexte d'utilisation |                         |                 |             |                           |
| createdAt    | `Date`           | Date de création de l'entité `User`                                            |                         | X               |             |                           |
| updatedAt    | `Date`           | Date de modification de l'entité `User`                                        |                         | X               |             |                           |

## Enumérations

### UserOriginEnum

- `CRM`
- `SELF`

## Enumérations génériques

Aucune enumération générique.

## Exemple

```javascript
import { Entities } from '@fasstech/oip-core';
import { getProjectId } from '@fasstech/oip-core/entities/Project';
import { getUserCode, getUserCompanyName, getUserEmail, getUserExternalCode, getUserExternalId, getUserFirstName, getUserId, getUserIsActive, getUserLabel, getUserLastName, getUserLogin, getUserNetwork, getUserORIAS, getUserOrigin, getUserRoles, getUserUserId, setUserCode, setUserCompanyName, setUserEmail, setUserExternalCode, setUserExternalId, setUserFirstName, setUserIsActive, setUserLabel, setUserLastName, setUserLogin, setUserNetwork, setUserORIAS, setUserOrigin, setUserRoles, setUserUserId } from '@fasstech/oip-core/entities/User';
import { UserOriginEnum } from '@fasstech/oip-core/entities/User/enums';

(async () => {
  let project = await Entities('Project').create();
  const user = await Entities('User').create();
  
  setUserORIAS('OOOOOOOO', user);
  setUserCompanyName('companyName', user);
  setUserEmail('email', user);
  setUserFirstName('firstName', user);
  setUserIsActive(false, user);
  setUserLastName('lastName', user);
  setUserLogin('login', user);
  setUserNetwork('network', user);
  setUserOrigin(UserOriginEnum.SELF, user);
  setUserRoles(['roles'], user);
  setUserCode('code', user);
  setUserExternalId('externalId', user);
  setUserExternalCode('externalCode', user);
  setUserUserId('userId', user);
  setUserLabel('label', user);
  
  project = await Entities('User').save(project, user);
  await Entities('Project').save(project);
  
  const projectToTest = await Entities('Project').get({ id: getProjectId(project) });
  const userToTest = await Entities('User').get(projectToTest, { filter: ({ id }) => id === getUserId(user) });
  
  getUserORIAS(userToTest); // 'OOOOOOOO'
  getUserCompanyName(userToTest); // 'companyName'
  getUserEmail(userToTest); // 'email'
  getUserFirstName(userToTest); // 'firstName'
  getUserIsActive(userToTest); // false
  getUserLastName(userToTest); // 'lastName'
  getUserLogin(userToTest); // 'login'
  getUserNetwork(userToTest); // 'network'
  getUserOrigin(userToTest); // UserOriginEnum.SELF
  getUserRoles(userToTest); // ['roles']
  getUserCode(userToTest); // 'code'
  getUserExternalId(userToTest); // 'externalId'
  getUserExternalCode(userToTest); // 'externalCode'
  getUserUserId(userToTest); // 'userId'
  getUserLabel(userToTest); // 'label'
})();
```
