Table of Contents

Public.Users View

Namespace: Public

Public users profile data. Entity: Public_Users (Introduced in version 22.1.4.22)

Default Visualization

Default Display Text Format:
{Name}
Default Search Members:
Name
Category: Views
Show in UI: CannotBeShown

Aggregate

An aggregate is a cluster of domain objects that can be treated as a single unit.

Aggregate Tree

Attributes

Name Type Description
Email string (254) nullable Unique email of the user. Can be null because there may be login providers that don't use emails. Filter(multi eq;like) Inherited from Sec_Users_Table.Email
IsAdmin boolean True if the user is administrator, otherwise 0. Required Default(false) Filter(eq) Inherited from Sec_Users_Table.Is_Admin
Login string (64) The login name of the user, which is usually the email. Required Filter(multi eq;like) Inherited from Sec_Users_Table.Login
Name MultilanguageString (254) The full name of the user. Required Filter(like) Inherited from Sec_Users_Table.User_Name
PhoneNumber string (64) nullable Used only for two-factor authentication. null when phone-based two-factor is not used. Filter(eq;like) Inherited from Sec_Users_Table.Phone_Number
UserId guid The Id of the security user. Required Filter(multi eq)

References

Name Type Description
Domain Domains (nullable) The domain, to which the user belongs. Filter(multi eq) Inherited from Sec_Users_Table.Domain_Id
Person Persons (nullable) The person from within the system, which is authenticated with this login. null means that this user is not associated with a person record in the database. Filter(multi eq) Inherited from Sec_Users_Table.Person_Id

Attribute Details

Email

Unique email of the user. Can be null because there may be login providers that don't use emails. Filter(multi eq;like) Inherited from Sec_Users_Table.Email

Type: string (254) nullable
Category: System
Inherited From: Sec_Users_Table.Email
Supported Filters: Equals, Like, EqualsIn
Supports Order By: False
Maximum Length: 254
Show in UI: ShownByDefault

IsAdmin

True if the user is administrator, otherwise 0. Required Default(false) Filter(eq) Inherited from Sec_Users_Table.Is_Admin

Type: boolean
Category: System
Inherited From: Sec_Users_Table.Is_Admin
Supported Filters: Equals
Supports Order By: False
Default Value: False
Show in UI: ShownByDefault

Login

The login name of the user, which is usually the email. Required Filter(multi eq;like) Inherited from Sec_Users_Table.Login

Type: string (64)
Category: System
Inherited From: Sec_Users_Table.Login
Supported Filters: Equals, Like, EqualsIn
Supports Order By: False
Maximum Length: 64
Show in UI: ShownByDefault

Name

The full name of the user. Required Filter(like) Inherited from Sec_Users_Table.User_Name

Type: MultilanguageString (254)
Category: System
Inherited From: Sec_Users_Table.User_Name
Supported Filters: Like
Supports Order By: False
Show in UI: ShownByDefault

PhoneNumber

Used only for two-factor authentication. null when phone-based two-factor is not used. Filter(eq;like) Inherited from Sec_Users_Table.Phone_Number

Type: string (64) nullable
Category: System
Inherited From: Sec_Users_Table.Phone_Number
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 64
Show in UI: ShownByDefault

UserId

The Id of the security user. Required Filter(multi eq)

Type: guid
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

Reference Details

Domain

The domain, to which the user belongs. Filter(multi eq) Inherited from Sec_Users_Table.Domain_Id

Type: Domains (nullable)
Category: System
Inherited From: Sec_Users_Table.Domain_Id
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

Person

The person from within the system, which is authenticated with this login. null means that this user is not associated with a person record in the database. Filter(multi eq) Inherited from Sec_Users_Table.Person_Id

Type: Persons (nullable)
Category: System
Inherited From: Sec_Users_Table.Person_Id
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

API Methods

Methods that can be invoked in public APIs.

GetAccessKeyPermissions

Gets the permissions this user has to access resources protected by the provided access key.
Return Type: SecurityPermissions
Declaring Type: Users
Domain API Request: POST

Parameters

  • accessKeyId
    The access key id
    Type: guid

  • userToken
    A proof token, identifying the logged in user. E.g. It could be an id token, or an access token. Required when the currently logged user is different from the public user.
    Type: string
    Optional: True
    Default Value: null

API

Domain API Query: https://demodb.my.erp.net/api/domain/odata/Public_Users?$top=10

Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#Public_Users?$top=10

Suggest improvement to this page