IRPCVault.GetUsersAndUserContainersOrDelta

Vault API / core read session or assertion idempotent returns metadata structure version

Gets users and user groups of all types as JSON, or only the changes since a version the caller already has.

Service	Vault information `MFiles.IRPCVault`
gRPC method	`/MFiles.IRPCVault/GetUsersAndUserContainersOrDelta`
HTTP (mf-http-grpc)	`POST /grpc/v1/get-users-and-user-containers-or-delta`
Request	`GetUsersAndUserContainersOrDeltaRequest`
Response	`GetUsersAndUserContainersOrDeltaResponse`
Book and level	Vault API, core
Kind	read
Session	Required: a session (mfiles-session-id-bin metadata) or a session assertion (x-mf-session-assertion metadata).
Idempotent	yes
Returns metadata structure version	yes (in the mfiles-metadata-version-bin trailer)
Streaming	none (unary)

Remarks

Works like GetUsersAndUserGroupsOrDelta but includes groups of all types. Used by M-Files clients; applications usually call GetUsersAndUserContainers instead.

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
`callers_current_users_version`	`int64`	The users version from your previous call, or 0 to get all users.
`callers_current_user_groups_version`	`int64`	The user groups version from your previous call, or 0 to get all groups.
`allow_receiving_delta`	`bool`	True to accept only the changes since the versions given.

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
`current_users_version_on_server`	`int64`	Receives the current version of the Users value list's data on the server. If this is the same as the one specified by the caller, no users are returned.
`current_user_groups_version_on_server`	`int64`	Receives the current version of the User Groups value list's data on the server. If this is the same as the one specified by the caller, no user groups are returned.
`users`	`bytes`	NUL-terminated JSON object (`isDelta`, `removedUsers`, `users`), zlib-compressed unless `uncompressed_users_length` is 4294967295.
`uncompressed_users_length`	`uint32`	Size of the decompressed `users`, or 4294967295 if not compressed.
`groups`	`bytes`	NUL-terminated JSON object with the groups or their changes, zlib-compressed unless `uncompressed_groups_length` is 4294967295.
`uncompressed_groups_length`	`uint32`	Size of the decompressed `groups`, or 4294967295 if not compressed.

GetUsersAndUserGroupsOrDelta -- Gets users and normal user groups as JSON, or only the changes since a version the caller already has.
GetUsersAndUserContainers -- Gets all users and all user groups of the vault.