Session Manager Login Extension By Certificate
Deprecated as of vSphere API 6.0, use SSO style of login instead LoginByToken.
Creates a special privileged session that includes the Sessions.ImpersonateUser privilege.
Requires that the client connect over SSL and provide an X.509 certificate for which they hold the private key. The certificate must match the certificate used in an earlier call to SetExtensionCertificate.
NOTE: Verification of the received certificate (such as expiry, revocation, and trust chain) is not required for successful authentication using this method. If certificate verification is desired, use the LoginExtensionBySubjectName method instead.
Required privileges: System.Anonymous
The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case SessionManager/{moId}.
The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.
{
"extensionKey": "string",
"locale": "string"
}Key of extension that is logging in.
A two-character ISO-639 language ID (like "en") optionally followed by an underscore and a two-character ISO 3166 country ID (like "US").
Examples are "de", "fr_CA", "zh", "zh_CN", and "zh_TW". Note: The method uses the server default locale when a locale is not provided. This default can be configured in the server configuration file. If unspecified, it defaults to the locale of the server environment or English ("en") if unsupported.
OK
{
"_typeName": "string",
"key": "string",
"userName": "string",
"fullName": "string",
"loginTime": "string",
"lastActiveTime": "string",
"locale": "string",
"messageLocale": "string",
"extensionSession": false,
"ipAddress": "string",
"userAgent": "string",
"callCount": 0
}A unique identifier for this session, also known as the session ID.
The user name represented by this session.
The full name of the user, if available.
Timestamp when the user last logged on to the server.
Timestamp when the user last executed a command.
The locale for the session used for data formatting and preferred for messages.
The locale used for messages for the session.
If there are no localized messages for the user-specified locale, then the server determines this locale.
Whether or not this session belongs to a VC Extension.
The client identity.
It could be IP address, or pipe name depended on client binding
The name of user agent or application
Number of API invocations since the session started
InvalidLogin: if the extension is not registered, or the certificate does not match the expected value.
InvalidLocale: if the supplied locale is not valid
NoClientCertificate: if no certificate was used by the client to connect
{
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
}