Metadata_Authentication_AuthenticationInfo

The AuthenticationInfo structure describes the authentication information. Authentication information could be specified for a package element, service elenent or an operation element. Using the authentication scheme information, a client invoking an API call from any service can figure out what kind of credentials are needed for that API call.

JSON Example

{
    "scheme_type": "string",
    "session_manager": "string",
    "scheme": "string"
}

Metadata_Authentication_AuthenticationInfo_SchemeType

scheme_type

Required

The AuthenticationInfo.SchemeType enumerated type provides enumeration values for the set of valid authentication scheme types.
SESSIONLESS : Indicates that the scheme is a session less authentication scheme, the user is authenticated on every operation. There is no explicit session establishment.
SESSION_AWARE : Indicates that the scheme is a session aware authentication scheme. It requires an explicit login before executing a operation and logout when a session terminates. A service might choose to have a session aware scheme if it wants to associate some state corresponding to the user until the user logs out or if it wants to mitigate the cost of authenticating the user on every operation.

string

session_manager

Optional

In a session aware authentication scheme, a session manager is required that supports create, delete and keepAlive operations. The fully qualified service name of the session manager is provided in AuthenticationInfo.session-manager field. This service is responsible for handling sessions. This field is optional and it is only relevant when the value of AuthenticationInfo.scheme-type is SESSION_AWARE.

string

scheme

Required

String identifier of the authentication scheme. Following are the supported authentication schemes by the infrastructure:

The identifier com.vmware.vapi.std.security.saml_hok_token for SAML holder of key token based authentication mechanism.
The identifier com.vmware.vapi.std.security.bearer_token for SAML bearer token based authentication mechanism.
The identifier com.vmware.vapi.std.security.session_id for session based authentication mechanism.
The identifier com.vmware.vapi.std.security.user_pass for username and password based authentication mechanism.