This API has a deprecated equivalent from v7.0U1.
Get Authentication Component
Retrieves authentication information about the component element corresponding to componentId. The 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.
Request
URLURL
https://{api_host}/api/vapi/metadata/authentication/component/{component_id}
Path Parameters
Path Parameters
string
component_id
Required
Identifier of the component element. The parameter must be an identifier for the resource type: com.vmware.vapi.component.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
MetadataAuthenticationComponentData
of type application/json
The ComponentData instance that corresponds to componentId
{
"fingerprint": "string",
"info": {
"packages": {
"key": {
"schemes": [
{
"scheme": "string",
"scheme_type": "SESSIONLESS",
"session_manager": "string"
}
],
"services": {
"key": {
"operations": {
"key": {
"schemes": [
{
"scheme": "string",
"scheme_type": "SESSIONLESS",
"session_manager": "string"
}
]
}
},
"schemes": [
{
"scheme": "string",
"scheme_type": "SESSIONLESS",
"session_manager": "string"
}
]
}
}
}
}
}
}
string
fingerprint
Required
Fingerprint of the metadata of the component. Authentication information could change when there is an infrastructure update. Since the data present in ComponentData.info could be quite large, ComponentData.fingerprint provides a convenient way to check if the data for a particular component is updated.
You should store the fingerprint associated with a component. After an update, by invoking the Component.fingerprint operation, you can retrieve the new fingerprint for the component. If the new fingerprint and the previously stored fingerprint do not match, clients can then use the Component.get to retrieve the new authentication information for the component.
info
Required
Authentication information of the component. This includes information about all the packages in the component.
Errors
404
com.vmware.vapi.std.errors.not_found : if the component element associated with componentId does not have any authentication information.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-GetComponentIdAuthentication -ComponentId "MyComponentId"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vapi/metadata/authentication/component/{component_id}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/com/vmware/vapi/metadata/authentication/component/id:{component_id}
x-vmw-doc-operation: get
Availability
Added in 7.0U2
