Extension authentications (IRPCExtensionAuthentications)
Manages the credentials that the vault uses to access external systems, such as external repositories connected to the vault, on behalf of the user.
| gRPC service | MFiles.IRPCExtensionAuthentications |
|---|---|
| Book and level | Vault API, standard |
| Methods | 8 |
| Proto file | mfiles/IRPCExtensionAuthentications.proto |
Overview
Some vault applications and external repository connections need the user's own credentials for the external system. The server keeps those credentials per user and target. M-Files clients use this service in their "external repositories" dialogs.
- GetExtensionAuthenticationTargets lists the external systems (targets) and the authentication methods they accept.
- GetExtensionAuthenticationStatus tells for which targets the caller has stored credentials.
- StoreExtensionAuthenticationCredentials logs the caller in to a target by storing credentials.
- LogoutWithExtensionAuthentication removes them.
All methods need a vault session; anonymous sessions cannot store credentials. A target is
identified by ExtensionAuthenticationTarget.id. Methods that name an unknown target generally
succeed without doing anything, so check the result with
GetExtensionAuthenticationStatus.
Credentials for the whole vault (common, background and permission-reading accounts) are set by vault administrators with StoreExtensionAuthenticationSpecialCredentials. Send credentials only over TLS.
Methods
| Method | Summary | Facts |
|---|---|---|
| GetExtensionAuthenticationStatus | Lists the targets for which the caller has stored credentials, with the account name used. | read session idempotent returns metadata structure version |
| GetExtensionAuthenticationTargets | Lists the external systems that accept credentials through this service. | read session idempotent returns metadata structure version |
| LogInAsDifferentUserForExtensionAuthentication | Asks the external system to start a new login for the caller, so that the caller can switch to another account there. Used by M-Files clients; applications rarely call it. | write session returns metadata structure version |
| LoginWithExtensionAuthentication | Logs the caller in to an external system with encrypted credentials. | write session returns metadata structure version |
| LogoutWithExtensionAuthentication | Removes the caller's stored credentials for an external system and logs the caller out of it. | write session returns metadata structure version |
| RemoveExtensionAuthenticationSpecialCredentials | Removes vault-wide credentials for an external system. Used by vault administration tools. | write session returns metadata structure version |
| StoreExtensionAuthenticationCredentials | Logs the caller in to an external system by storing the caller's credentials for it. | write session returns metadata structure version |
| StoreExtensionAuthenticationSpecialCredentials | Stores vault-wide credentials for an external system: the common, background or permission-reading account. Used by vault administration tools. | write session returns metadata structure version |