IRPCServerAdmin.JoinSubscriptionTest

Administration API / specialized admin session idempotent

Checks whether the server could join an M-Files Manage subscription, and lists the vaults that would prevent it.

Service	Server administration `MFiles.IRPCServerAdmin`
gRPC method	`/MFiles.IRPCServerAdmin/JoinSubscriptionTest`
HTTP (mf-http-grpc)	`POST /grpc/v1/join-subscription-test`
Request	`JoinSubscriptionTestRequest`
Response	`JoinSubscriptionTestResponse`
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

Does not join; use JoinSubscription for that.
Requires the system administrator server role (server rights edit_server_properties, manage_logins and shutdown).
Fails with "Access denied." if the server already uses M-Files Manage.
If M-Files Manage does not recognize the test request, the call succeeds with empty lists.

A structure that specifies join subscription test request.

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
`token`	`string`	The access token from M-Files Manage that authorizes joining.
`subscription_id`	`string`	The ID of the subscription to test.

A structure that specifies join subscription test response.

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
`preventing_vaults[]`	repeated `VaultBasic`	Array of already attached vaults.
`preventing_vaults[].guid`	`string`	The vault GUID, in braces and upper case. Use it as `LoginData.vault_guid`.
`preventing_vaults[].display_name`	`string`	The vault name shown to users.
`preventing_vaults[].tooltip`	`string`	Optional description. Often empty.
`preventing_vaults[].icon`	`bytes`	The vault icon in .ico format, or empty.
`preventing_vaults[].dns_names`	`StringArray`	Host names configured for the vault, if any.
`preventing_vaults[].dns_names.value[]`	repeated `string`	String values.
`foreign_vaults[]`	repeated `VaultBasic`	Array of vaults with reserved GUID in another subscription.
`foreign_vaults[].guid`	`string`	The vault GUID, in braces and upper case. Use it as `LoginData.vault_guid`.
`foreign_vaults[].display_name`	`string`	The vault name shown to users.
`foreign_vaults[].tooltip`	`string`	Optional description. Often empty.
`foreign_vaults[].icon`	`bytes`	The vault icon in .ico format, or empty.
`foreign_vaults[].dns_names`	`StringArray`	Host names configured for the vault, if any.
`foreign_vaults[].dns_names.value[]`	repeated `string`	String values.