MetadataAuthenticationComponentApi.md

VSphereAutomation::VAPI::MetadataAuthenticationComponentApi

All URIs are relative to https://<vcenter>/rest

Method	HTTP request	Description
fingerprint	POST /com/vmware/vapi/metadata/authentication/component/id:{component_id}?~action=fingerprint	Retrieves the fingerprint computed from the authentication metadata of the component element corresponding to {@param.name componentId}. <p> The fingerprint provides clients an efficient way to check if the metadata for a particular component has been modified on the server. The client can do this by comparing the result of this operation with the fingerprint returned in the result of {@link vapi.metadata.authentication.Component#get}.
get	GET /com/vmware/vapi/metadata/authentication/component/id:{component_id}	Retrieves authentication information about the component element corresponding to {@param.name componentId}. <p> The {@link ComponentData} contains the authentication information about the component element and it's fingerprint. It contains information about all the package elements that belong to this component element.
list	GET /com/vmware/vapi/metadata/authentication/component	Returns the identifiers for the component elements that have authentication information.

fingerprint

VapiMetadataAuthenticationComponentFingerprintResult fingerprint(component_id)

Retrieves the fingerprint computed from the authentication metadata of the component element corresponding to {@param.name componentId}.

The fingerprint provides clients an efficient way to check if the metadata for a particular component has been modified on the server. The client can do this by comparing the result of this operation with the fingerprint returned in the result of {@link vapi.metadata.authentication.Component#get}.

Example

# load the gem
require 'vsphere-automation-vapi'
# setup authorization
VSphereAutomation::Configuration.new.tap do |config|
  # Configure API key authorization: api_key
  config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
end

api_instance = VSphereAutomation::VAPI::MetadataAuthenticationComponentApi.new
component_id = 'component_id_example' # String | Identifier of the component element.

begin
  #Retrieves the fingerprint computed from the authentication metadata of the component element corresponding to {@param.name componentId}. <p> The fingerprint provides clients an efficient way to check if the metadata for a particular component has been modified on the server. The client can do this by comparing the result of this operation with the fingerprint returned in the result of {@link vapi.metadata.authentication.Component#get}.
  result = api_instance.fingerprint(component_id)
  p result
rescue VSphereAutomation::ApiError => e
  puts "Exception when calling MetadataAuthenticationComponentApi->fingerprint: #{e}"
end

Parameters

Name	Type	Description	Notes
component_id	String	Identifier of the component element.

Return type

VapiMetadataAuthenticationComponentFingerprintResult

Authorization

api_key

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

get

VapiMetadataAuthenticationComponentResult get(component_id)

Retrieves authentication information about the component element corresponding to {@param.name componentId}.

The {@link ComponentData} contains the authentication information about the component element and it's fingerprint. It contains information about all the package elements that belong to this component element.

Example

# load the gem
require 'vsphere-automation-vapi'
# setup authorization
VSphereAutomation::Configuration.new.tap do |config|
  # Configure API key authorization: api_key
  config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
end

api_instance = VSphereAutomation::VAPI::MetadataAuthenticationComponentApi.new
component_id = 'component_id_example' # String | Identifier of the component element.

begin
  #Retrieves authentication information about the component element corresponding to {@param.name componentId}. <p> The {@link ComponentData} contains the authentication information about the component element and it's fingerprint. It contains information about all the package elements that belong to this component element.
  result = api_instance.get(component_id)
  p result
rescue VSphereAutomation::ApiError => e
  puts "Exception when calling MetadataAuthenticationComponentApi->get: #{e}"
end

Parameters

Name	Type	Description	Notes
component_id	String	Identifier of the component element.

Return type

VapiMetadataAuthenticationComponentResult

Authorization

api_key

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

list

VapiMetadataAuthenticationComponentListResult list

Returns the identifiers for the component elements that have authentication information.

Example

# load the gem
require 'vsphere-automation-vapi'
# setup authorization
VSphereAutomation::Configuration.new.tap do |config|
  # Configure API key authorization: api_key
  config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
end

api_instance = VSphereAutomation::VAPI::MetadataAuthenticationComponentApi.new

begin
  #Returns the identifiers for the component elements that have authentication information.
  result = api_instance.list
  p result
rescue VSphereAutomation::ApiError => e
  puts "Exception when calling MetadataAuthenticationComponentApi->list: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

VapiMetadataAuthenticationComponentListResult

Authorization

api_key

HTTP request headers

• Content-Type: Not defined
• Accept: application/json