IRPCVaultsAdmin.TakeVaultOffline

Administration API / specialized admin session idempotent

Takes a vault offline: users cannot log in to it until it is brought online again.

Service	Vault management `MFiles.IRPCVaultsAdmin`
gRPC method	`/MFiles.IRPCVaultsAdmin/TakeVaultOffline`
HTTP (mf-http-grpc)	`POST /grpc/v1/take-vault-offline`
Request	`TakeVaultOfflineRequest`
Response	`TakeVaultOfflineResponse`
Book and level	Administration API, specialized
Kind	admin
Session	Required: the session ID from LogIn in the mfiles-session-id-bin metadata.
Idempotent	yes
Returns metadata structure version	no
Streaming	none (unary)

Remarks

Requires the system administrator server role (server right manage_vaults).
With disconnect_users false, the call fails if the vault has open sessions, with the same error as CheckForOpenSessions. With disconnect_users true, open sessions are terminated.
Bring the vault back with BringVaultOnline.

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
`vault`	`string`	The GUID of the vault.
`disconnect_users`	`bool`	If true, any existing sessions are terminated. If false, the operation fails if there are open sessions.

No fields.

CheckForOpenSessions -- Checks whether users have open sessions to a vault: succeeds if there are none and fails with a list of the sessions otherwise.
BringVaultOnline -- Brings an offline vault online so that users can log in to it again.