IRPCUsersAdmin.GetUser
Administration API / specialized admin session
Gets one user account by ID.
| Service | Users MFiles.IRPCUsersAdmin |
|---|---|
| gRPC method | /MFiles.IRPCUsersAdmin/GetUser |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-user |
| Request | GetUserRequest |
| Response | GetUserResponse |
| Book and level | Administration API, specialized |
| Kind | admin |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | no |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
- Requires the vault right
manage_users. - A negative ID fails with "The parameter is incorrect."; an unknown ID (including 0) fails with "Not found.".
Request: GetUserRequest
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.
| Field | Type | Description |
|---|---|---|
user | int32 | The ID of the user account. |
Response: GetUserResponse
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page. Fields marked (recursive) refer to a type already on their path.
| Field | Type | Description |
|---|---|---|
putf8szua | UserAccount | The user account. See UserAccount. |
putf8szua.id | int32 | The ID of the user account. |
putf8szua.login_name | string | The login name that is associated with this user account (e.g. 'DOMAIN\user'). |
putf8szua.vault_roles | VAULTROLES | Bitmask of the vault roles of the user. |
putf8szua.vault_roles.all | bool | Specifies all flags set; Including any future flags. |
putf8szua.vault_roles.full_control | bool | Can perform any activity in the vault. |
putf8szua.vault_roles.can_log_in | bool | Can log in to the vault. |
putf8szua.vault_roles.can_create_objects | bool | Can create new documents. |
putf8szua.vault_roles.can_see_all_objects | bool | Sees all documents in listings, regardless of security settings and deletion state. |
putf8szua.vault_roles.can_undelete_objects | bool | Can undelete previously deleted documents. |
putf8szua.vault_roles.can_destroy_objects | bool | Has permission to permanently destroy documents. |
putf8szua.vault_roles.can_force_undo_checkout | bool | Has permission to undo a check-out performed by another user. |
putf8szua.vault_roles.can_change_all_object_permissions | bool | Can change the security settings of all documents and modify all documents. |
putf8szua.vault_roles.can_change_metadata_structure | bool | Can modify the meta data structure of the vault (propertydefs, profiles, value lists etc.). |
putf8szua.vault_roles.can_manage_users | bool | Can create, edit and delete user accounts. Cannot add or remove the Vault Manager role. |
putf8szua.vault_roles.is_internal_user | bool | An internal user of the vault. This role separates internal enad external users in the vault. |
putf8szua.vault_roles.can_manage_traditional_folders | bool | Can create, modify and delete traditional folders. OBSOLETE: const VAULTROLES VAULTROLE_DEFINE_TEMPLATES = 1 << 12; //!< Can define templates. |
putf8szua.vault_roles.can_manage_common_views | bool | Can create, modify and delete common views. |
putf8szua.vault_roles.can_manage_workflows | bool | Can create, modify and delete workflows. Modifying event handlers within the workflow still requires SERVERACCESS_RUN_CODE. |
putf8szua.vault_roles.cannot_manage_private_views | bool | Cannot create or modify private views. |
putf8szua.vault_roles.anonymous | bool | Anonymous role. |
putf8szua.vault_roles.run_code_on_server | bool | Can run code on the server hosting this vault. Not included in VAULTROLE_FULL_CONTROL, and cannot be ordinarily granted by it. |
putf8szua.acl | AccessControlList | Permissions. |
putf8szua.acl.checked_out_to_user | int32 | Specifies the ID of the user who has extended rights because of the checkout operation performed by her. 0 if such user does not exist. |
putf8szua.acl.is_fully_authoritative | bool | Specifies whether this access control list is set to ignore the secondary permissions that come from the latest checked in version. |
putf8szua.acl.custom_component | AccessControlListComponent | Accesses the custom component of this ACL. |
putf8szua.acl.restrictive_components[] | repeated AccessControlListComponentMapEntry | Accesses the restrictive automatic components of this ACL. |
putf8szua.acl.secondary_access_control_list | AccessControlList (recursive) | Secondary ACL used for latest version ACL. Not used for access check if null. |
putf8szua.acl.additive_components[] | repeated AccessControlListComponentMapEntry | Accesses the additive automatic components of this ACL. |
putf8szua.user_language | int32 | The vault language of the user. |
putf8szua.external_id | string | The user identity in external system, such as Microsoft Entra (where the identity is a GUID). Read-only. |