Com::Vmware::Vapi::Std::AuthenticationScheme Class Reference

Inheritance diagram for Com::Vmware::Vapi::Std::AuthenticationScheme:

Avaliable Methods
public method	new ()

Detailed Description

Constant String::NO_AUTHENTICATION # Indicates that the request doesn't need any authentication. Constant String::SAML_BEARER_TOKEN # Indicates that the security context in a request is using a SAML bearer token based authentication scheme.

In this scheme, the following pieces of information has to be passed in the SecurityContext structure in the execution context of the request:

• The scheme identifier: com.vmware.vapi.std.security.saml_bearer_token
• The token itself

Sample security context in JSON format that matches the specification: ``{ 'schemeId': 'com.vmware.vapi.std.security.saml_bearer_token', 'token': 'the token itself' }`` vAPI runtime provide convenient factory methods that take SAML bearer token and to create the security context that conforms to the above mentioned format.

Constant String::SAML_HOK_TOKEN # Indicates that the security context in a request is using a SAML holder-of-key token based authentication scheme.

In this scheme, the following pieces of information has to be passed in the SecurityContext structure in the execution context of the request:

• The scheme identifier: com.vmware.vapi.std.security.saml_hok_token
• Signature of the request: This includes - algorithm used for signing the request, SAML holder of key token and signature digest
• Request timestamp: This includes the created and expires timestamp of the request. The timestamp should match the following format - YYYY-MM-DDThh:mm:ss.sssZ (e.g. 1878-03-03T19:20:30.451Z).

Sample security context in JSON format that matches the specification: ``{ 'schemeId': 'com.vmware.vapi.std.security.saml_hok_token', 'signature': { 'alg': 'RS256', 'samlToken': ..., 'value': ...,`` , 'timestamp': { 'created': '2012-10-26T12:24:18.941Z', 'expires': '2012-10-26T12:44:18.941Z', } } } vAPI runtime provide convenient factory methods that take SAML holder of key token and private key to create the security context that conforms to the above mentioned format.

Constant String::SESSION_ID # Indicates that the security context in a request is using a session identifier based authentication scheme.

In this scheme, the following pieces of information has to be passed in the SecurityContext structure in the execution context of the request:

• The scheme identifier - com.vmware.vapi.std.security.session_id
• Valid session identifier - This is usually returned by a login method of a session manager interface for a particular vAPI service of this authentication scheme

Sample security context in JSON format that matches the specification: ``{ 'schemeId': 'com.vmware.vapi.std.security.session_id', 'sessionId': ...., }`` vAPI runtime provides convenient factory methods that take session identifier as input parameter and create a security context that conforms to the above format. Constant String::USER_PASSWORD # Indicates that the security context in a request is using username/password based authentication scheme.

In this scheme, the following pieces of information has to be passed in the SecurityContext structure in the execution context of the request:

• The scheme identifier - com.vmware.vapi.std.security.user_password
• Username
• Password

Sample security context in JSON format that matches the specification: ``{ 'schemeId': 'com.vmware.vapi.std.security.user_password', 'userName': ...., 'password': ... }`` vAPI runtime provides convenient factory methods that take username and password as input parameters and create a security context that conforms to the above format.

The class Com::Vmware::Vapi::Std::AuthenticationScheme class defines constants for authentication scheme identifiers for authentication mechanisms present in the vAPI infrastructure shipped by VMware.

A third party extension can define and implements it's own authentication mechanism and define a constant in a different IDL file.

Member Function Documentation

public method Com::Vmware::Vapi::Std::AuthenticationScheme::new

(

)

Constructor to initialize the Com::Vmware::Vapi::Std::AuthenticationScheme structure

Return values

Blessed

object

Code:

---

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

• Com/Vmware/Vapi/Std/AuthenticationScheme.pm