Skip to main content

UserResult

uidstringrequired

Unique identifier of the user

Example: 019619df-4768-7af9-8167-18ad0b73a399
emailstring<email>required

Email address of the user

Example: john.doe@example.com
firstNamestringrequired

First name of the user

Example: John
lastNamestringrequired

Last name of the user

Example: Doe
rolestringrequired

Role of the user

Possible values: [ADMIN, MEMBER]

Example: MEMBER
allAssetsbooleanrequired

Whether the user has access to all assets

Example: false
disabledbooleanrequired

Whether the user is disabled in this organization (a disabled user has no access to it)

Example: false
expiresAtstring<date-time>

When set, the date and time after which the user's access to this organization is automatically disabled. Omitted when the access never expires.

Example: 2026-12-31T23:59:59Z
createdAtstring<date-time>required

Date and time when the user was created

Example: 2025-06-15T10:30:00Z
userGroups object[]required

Groups the user belongs to

  • Array [
    • uidstringrequired

    Unique identifier of the user group

    Example: 019619df-4768-76b7-81e3-2c56d374df46
    labelstringrequired

    Display label of the user group

    Example: Marketing
  • ]
    • permissions object

    Map of the user's permissions grouped by type. Omitted when the user has no permissions.

    property name* object
    oneOf

    Permissions of a type that has no subtypes

  • Array [
    • uidstringrequired

    Unique identifier of the permission

    Example: 019619df-4768-76b3-8ab3-4414dcf29ff1
    codestringrequired

    Code of the permission

    Example: portfolio-123
    labelstringrequired

    Display label of the permission

    Example: Alpha Portfolio
    descriptionstringrequired

    Description of the permission (empty string when not set)

    Example: The Alpha Portfolio of buildings
  • ]
    • UserResult
    {
      "uid": "019619df-4768-7af9-8167-18ad0b73a399",
      "email": "john.doe@example.com",
      "firstName": "John",
      "lastName": "Doe",
      "role": "MEMBER",
      "allAssets": false,
      "disabled": false,
      "expiresAt": "2026-12-31T23:59:59Z",
      "createdAt": "2025-06-15T10:30:00Z",
      "userGroups": [
        {
          "uid": "019619df-4768-76b7-81e3-2c56d374df46",
          "label": "Marketing"
        }
      ],
      "permissions": {
        "ASSET": {
          "PORTFOLIO": [
            {
              "uid": "0bb04f5b-bf5e-4950-acb1-0a63cf3431c1",
              "code": "b362b8cd-e105-41db-b131-0911fa559aee",
              "label": "Alpha",
              "description": "The Alpha portfolio of buildings"
            }
          ],
          "BUILDING": [
            {
              "uid": "0bb04f5b-bf5e-4950-acb1-0a63cf3431c3",
              "code": "b362b8cd-e105-41db-b131-0911fa559aef",
              "label": "B01 - Marseille",
              "description": ""
            }
          ]
        },
        "PROFILE": [
          {
            "uid": "0bb04f5b-bf5e-4950-acb1-0a3cf3431c6",
            "code": "acquereur",
            "label": "Acquéreur",
            "description": ""
          }
        ],
        "SCOPE": {
          "RIGHT": [
            {
              "uid": "0bb04f5b-bf5e-4950-acb1-0a3cf3431c7",
              "code": "stonal.asset.all",
              "label": "Access to all assets",
              "description": ""
            }
          ]
        },
        "SCOPE_GROUP": {
          "APPLICATION": [
            {
              "uid": "0bb04f5b-bf5e-4950-acb1-0a3cf3431c8",
              "code": "b362b8cd-e105-41db-b131-0911fa559aec",
              "label": "All",
              "description": ""
            }
          ],
          "RIGHT": [
            {
              "uid": "0bb04f5b-bf5e-4950-acb1-0a3cf3431c9",
              "code": "stonal.read-write",
              "label": "Read write",
              "description": ""
            }
          ]
        },
        "REPORT": [
          {
            "uid": "0bb04f5b-bf5e-4950-acb1-0a3cf3431ca",
            "code": "019837df-ab1d-7d13-956f-a4233f0b95a1",
            "label": "FICHE BATIMENT & SITE",
            "description": ""
          }
        ],
        "REPORT_GROUP": {
          "MIXED": [
            {
              "uid": "0bb04f5b-bf5e-4950-acb1-0a3cf3431cb",
              "code": "groupe_projet",
              "label": "Groupe projet",
              "description": ""
            }
          ],
          "POWERBI": [
            {
              "uid": "0bb04f5b-bf5e-4950-acb1-0a3cf3431cc",
              "code": "9cfa1e15-4f8b-49fc-a01e-2ff3f0d24a7d",
              "label": "Contrôle réglementaire",
              "description": ""
            }
          ]
        }
      }
    }