Com::Vmware::Vapi::Metadata::Authentication::AuthenticationInfo Class Reference

Inheritance diagram for Com::Vmware::Vapi::Metadata::Authentication::AuthenticationInfo:

Classes
class	SchemeType

Avaliable Methods
public method	set_session_manager ()
public method	get_scheme_type ()
public method	set_scheme_type ()
public method	get_session_manager ()
public method	new ()
public method	set_scheme ()
public method	get_scheme ()

Detailed Description

The Com::Vmware::Vapi::Metadata::Authentication::AuthenticationInfo class 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 interface* can figure out what kind of credentials are needed for that API call.

Member Function Documentation

public method Com::Vmware::Vapi::Metadata::Authentication::AuthenticationInfo::get_scheme

(

)

Gets the value of 'scheme' property.

Return values

scheme

- The current value of the field. 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.

String#

Code:

public method Com::Vmware::Vapi::Metadata::Authentication::AuthenticationInfo::get_scheme_type

(

)

Gets the value of 'scheme_type' property.

Return values

scheme_type

- The current value of the field. The type of the authentication scheme. SchemeType#

Code:

public method Com::Vmware::Vapi::Metadata::Authentication::AuthenticationInfo::get_session_manager

(

)

Gets the value of 'session_manager' property.

Return values

session_manager

- The current value of the field. In a session aware authentication scheme, a session manager is required that supports create , delete and keepAlive methods . The fully qualified interface* name of the session manager is provided in :attr:Com::Vmware::Vapi::Metadata::Authentication::AuthenticationInfo.session_manager field* . This interface is responsible for handling sessions. optional#

Code:

public method Com::Vmware::Vapi::Metadata::Authentication::AuthenticationInfo::new

(

)

Constructor to initialize the Com::Vmware::Vapi::Metadata::Authentication::AuthenticationInfo structure

Return values

Blessed

object

Code:

public method Com::Vmware::Vapi::Metadata::Authentication::AuthenticationInfo::set_scheme

(

)

Sets the given value for 'scheme' property.

Parameters

scheme

- New value for the field. 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.

Code:

public method Com::Vmware::Vapi::Metadata::Authentication::AuthenticationInfo::set_scheme_type

(

)

Sets the given value for 'scheme_type' property.

Parameters

scheme_type

- New value for the field. The type of the authentication scheme.

Code:

public method Com::Vmware::Vapi::Metadata::Authentication::AuthenticationInfo::set_session_manager

(

)

Sets the given value for 'session_manager' property.

Parameters

session_manager

- New value for the field. In a session aware authentication scheme, a session manager is required that supports create , delete and keepAlive methods . The fully qualified interface* name of the session manager is provided in :attr:Com::Vmware::Vapi::Metadata::Authentication::AuthenticationInfo.session_manager field* . This interface is responsible for handling sessions.

Code:

---

The documentation for this class was generated from the following file:

• Com/Vmware/Vapi/Metadata/Authentication/AuthenticationInfo.pm