Class: Com::Vmware::Vapi::Std::Errors::Unauthenticated

Inherits:
Error
  • Object
show all
Defined in:
/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/std/errors.rb

Overview

The ``Com::Vmware::Vapi::Std::Errors::Unauthenticated`` error indicates that the method requires authentication and the user is not authenticated. 


 API requests may include a security context containing user credentials. For example, the user credentials could be a SAML token, a user name and password, or the session identifier for a previously established session.  

 Examples:  

  * The SAML token in the request's security context has expired. 
   * The user name and password in the request's security context are invalid. 
   * The session identifier in the request's security context identifies a session that has expired. 
  
  Counterexamples:  

  *  The user is authenticated but isn't authorized to perform the requested  method . The   :class:`Com::Vmware::Vapi::Std::Errors::Unauthorized`    error  would be used instead. 
  
   

 For security reasons, the   :attr:`Com::Vmware::Vapi::Std::Errors::Error.data`    field  in this  error  is  nil , and the   :attr:`Com::Vmware::Vapi::Std::Errors::Error.messages`    field  in this  error  does not disclose which part of the security context is correct or incorrect. For example the messages would not disclose whether a username or a password is valid or invalid, but only that a combination of username and password is invalid.

Instance Attribute Summary

Attributes inherited from Error

#data, #messages

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (Unauthenticated) initialize(binding_type = self.class.binding_type, error_value = nil)

Constructs a new instance.

Parameters:

  • binding_type (VAPI::Bindings::BindingType) (defaults to: self.class.binding_type) —

    the specific BindingType declaration for this concrete VapiError type

  • error_value (VAPI::Data::ErrorValue) (defaults to: nil) —

    the error value (default nil) 



350
351
352
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/std/errors.rb', line 350

def initialize(binding_type=self.class.binding_type, error_value=nil)
    super(binding_type, error_value)
end

Class Method Details

+ (VAPI::Bindings::ErrorType) binding_type

Holds (gets or creates) the binding type metadata for this error type.

Returns:

  • (VAPI::Bindings::ErrorType) —

    the binding type 



334
335
336
337
338
339
340
341
342
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/std/errors.rb', line 334

def binding_type
    @binding_type ||= VAPI::Bindings::ErrorType.new(
        'com.vmware.vapi.std.errors.unauthenticated',
        {
            'messages' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Std::LocalizableMessage')),
            'data' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::DynamicStructType.new()),
        },
        Unauthenticated)
end