IRPCExtensionAuthentications.StoreExtensionAuthenticationSpecialCredentials

View as Markdown

Vault API / standard write session returns metadata structure version

Stores vault-wide credentials for an external system: the common, background or permission-reading account. Used by vault administration tools.

ServiceExtension authentications MFiles.IRPCExtensionAuthentications
gRPC method/MFiles.IRPCExtensionAuthentications/StoreExtensionAuthenticationSpecialCredentials
HTTP (mf-http-grpc)POST /grpc/v1/store-extension-authentication-special-credentials
RequestStoreExtensionAuthenticationSpecialCredentialsRequest
ResponseStoreExtensionAuthenticationSpecialCredentialsResponse
Book and levelVault API, standard
Kindwrite
SessionRequired: the session ID from LogIn in the mfiles-session-id-bin metadata.
Idempotentno
Returns metadata structure versionyes (in the mfiles-metadata-version-bin trailer)
Streamingnone (unary)

Remarks

Request: StoreExtensionAuthenticationSpecialCredentialsRequest

Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.

FieldTypeDescription
eeasutExtensionAuthenticationSpecialUserTypeWhich vault-wide account to set: EXTENSION_AUTHENTICATION_SPECIAL_USER_TYPE_COMMON, EXTENSION_AUTHENTICATION_SPECIAL_USER_TYPE_BACKGROUND or EXTENSION_AUTHENTICATION_SPECIAL_USER_TYPE_PERMISSIONS.Values: EXTENSION_AUTHENTICATION_SPECIAL_USER_TYPE_NORMAL (0), EXTENSION_AUTHENTICATION_SPECIAL_USER_TYPE_COMMON (1), EXTENSION_AUTHENTICATION_SPECIAL_USER_TYPE_BACKGROUND (2), EXTENSION_AUTHENTICATION_SPECIAL_USER_TYPE_PERMISSIONS (3).
targetstringThe id of the target.
ear_data_encryptedbytesThe credentials, encrypted with the server's public key in a format internal to the M-Files clients.

Response: StoreExtensionAuthenticationSpecialCredentialsResponse

No fields.