IRPCExtensionAuthentications.GetExtensionAuthenticationStatus

View as Markdown

Vault API / standard read session idempotent returns metadata structure version

Lists the targets for which the caller has stored credentials, with the account name used.

ServiceExtension authentications MFiles.IRPCExtensionAuthentications
gRPC method/MFiles.IRPCExtensionAuthentications/GetExtensionAuthenticationStatus
HTTP (mf-http-grpc)POST /grpc/v1/get-extension-authentication-status
RequestGetExtensionAuthenticationStatusRequest
ResponseGetExtensionAuthenticationStatusResponse
Book and levelVault API, standard
Kindread
SessionRequired: the session ID from LogIn in the mfiles-session-id-bin metadata.
Idempotentyes
Returns metadata structure versionyes (in the mfiles-metadata-version-bin trailer)
Streamingnone (unary)

Remarks

Request: GetExtensionAuthenticationStatusRequest

No fields.

Response: GetExtensionAuthenticationStatusResponse

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

FieldTypeDescription
statuses[]repeated ExtensionAuthenticationStatusOne entry per target with stored credentials.
statuses[].userint32The ID of the user account the credentials belong to.
statuses[].user_typeExtensionAuthenticationSpecialUserTypeEXTENSION_AUTHENTICATION_SPECIAL_USER_TYPE_NORMAL for a user's own credentials, or the kind of vault-wide account.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).
statuses[].connection_namestringThe id of the target.
statuses[].accountstringThe account name on the external system.
statuses[].is_missingboolTrue if no usable credentials are stored for this user and target.