Skip to main content

UserPageResult

totalintegerrequired

Total number of items

Example: 42
result object[]required

Array of user items

  • Array [
  • 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
    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 user permissions by type

    property name*any

    Map of user permissions by type

    Example: {"ASSET":{"PORTFOLIO":{"uid":"0bb04f5b-bf5e-4950-acb1-0a63cf3431c1","code":"b362b8cd-e105-41db-b131-0911fa559aee","label":"Alpha"},"COMPANY":{"uid":"0bb04f5b-bf5e-4950-acb1-0a63cf3431c2","code":"stonal","label":"Stonal"},"BUILDING":{"uid":"0bb04f5b-bf5e-4950-acb1-0a63cf3431c3","code":"b362b8cd-e105-41db-b131-0911fa559aef","label":"B01 - Marseille"},"BUILDING_GROUP":{"uid":"0bb04f5b-bf5e-4950-acb1-0a63cf3431c4","code":"b362b8cd-e105-41db-b131-0911fa559aea","label":"S01 - Marseille"},"FACILITY":{"uid":"0bb04f5b-bf5e-4950-acb1-0a63cf3431c5","code":"b362b8cd-e105-41db-b131-0911fa559aeb","label":"F01 - Marseille"}},"PROFILE":{"uid":"0bb04f5b-bf5e-4950-acb1-0a3cf3431c6","code":"acquereur","label":"AcquƩreur"},"SCOPE":{"RIGHT":{"uid":"0bb04f5b-bf5e-4950-acb1-0a3cf3431c7","code":"stonal.asset.all","label":"Access to all assets"}},"SCOPE_GROUP":{"APPLICATION":{"uid":"0bb04f5b-bf5e-4950-acb1-0a3cf3431c8","code":"b362b8cd-e105-41db-b131-0911fa559aec","label":"All"},"RIGHT":{"uid":"0bb04f5b-bf5e-4950-acb1-0a3cf3431c9","code":"stonal.read-write","label":"Read write"}},"REPORT":{"uid":"0bb04f5b-bf5e-4950-acb1-0a3cf3431ca","code":"019837df-ab1d-7d13-956f-a4233f0b95a1","label":"FICHE BATIMENT & SITE"},"REPORT_GROUP":{"uid":"0bb04f5b-bf5e-4950-acb1-0a3cf3431cb","code":"75cb735c-7335-42c7-a27f-c26be904c5ed","label":"Admin"}}
  • ]
  • UserPageResult
    {
    "total": 42,
    "result": [
    {
    "uid": "019619df-4768-7af9-8167-18ad0b73a399",
    "email": "john.doe@example.com",
    "firstName": "John",
    "lastName": "Doe",
    "role": "MEMBER",
    "allAssets": false,
    "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"
    },
    "COMPANY": {
    "uid": "0bb04f5b-bf5e-4950-acb1-0a63cf3431c2",
    "code": "stonal",
    "label": "Stonal"
    },
    "BUILDING": {
    "uid": "0bb04f5b-bf5e-4950-acb1-0a63cf3431c3",
    "code": "b362b8cd-e105-41db-b131-0911fa559aef",
    "label": "B01 - Marseille"
    },
    "BUILDING_GROUP": {
    "uid": "0bb04f5b-bf5e-4950-acb1-0a63cf3431c4",
    "code": "b362b8cd-e105-41db-b131-0911fa559aea",
    "label": "S01 - Marseille"
    },
    "FACILITY": {
    "uid": "0bb04f5b-bf5e-4950-acb1-0a63cf3431c5",
    "code": "b362b8cd-e105-41db-b131-0911fa559aeb",
    "label": "F01 - Marseille"
    }
    },
    "PROFILE": {
    "uid": "0bb04f5b-bf5e-4950-acb1-0a3cf3431c6",
    "code": "acquereur",
    "label": "AcquƩreur"
    },
    "SCOPE": {
    "RIGHT": {
    "uid": "0bb04f5b-bf5e-4950-acb1-0a3cf3431c7",
    "code": "stonal.asset.all",
    "label": "Access to all assets"
    }
    },
    "SCOPE_GROUP": {
    "APPLICATION": {
    "uid": "0bb04f5b-bf5e-4950-acb1-0a3cf3431c8",
    "code": "b362b8cd-e105-41db-b131-0911fa559aec",
    "label": "All"
    },
    "RIGHT": {
    "uid": "0bb04f5b-bf5e-4950-acb1-0a3cf3431c9",
    "code": "stonal.read-write",
    "label": "Read write"
    }
    },
    "REPORT": {
    "uid": "0bb04f5b-bf5e-4950-acb1-0a3cf3431ca",
    "code": "019837df-ab1d-7d13-956f-a4233f0b95a1",
    "label": "FICHE BATIMENT & SITE"
    },
    "REPORT_GROUP": {
    "uid": "0bb04f5b-bf5e-4950-acb1-0a3cf3431cb",
    "code": "75cb735c-7335-42c7-a27f-c26be904c5ed",
    "label": "Admin"
    }
    }
    }
    ]
    }