Vapi Metadata Authentication Component get

Vapi Metadata Authentication Component get

Retrieves authentication information about the component element corresponding to componentId.

The Vapi Metadata Authentication 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
URI
GET
https://{api_host}/api/vapi/metadata/authentication/component/{componentId}
COPY
Path Parameters
string
componentId
Required

Identifier of the component element.

The parameter must be an identifier for the resource type: com.vmware.vapi.component.

Authentication
This operation uses the following authentication methods.
Responses
200

The Vapi Metadata Authentication ComponentData instance that corresponds to componentId

Returns Vapi Metadata Authentication ComponentData of type(s) application/json 
{
    "info": {
        "packages": {
            "packages": {
                "schemes": [
                    {
                        "scheme_type": "string",
                        "session_manager": "string",
                        "scheme": "string"
                    }
                ],
                "services": {
                    "services": {
                        "schemes": [
                            {
                                "scheme_type": "string",
                                "session_manager": "string",
                                "scheme": "string"
                            }
                        ],
                        "operations": {
                            "operations": {
                                "schemes": [
                                    {
                                        "scheme_type": "string",
                                        "session_manager": "string",
                                        "scheme": "string"
                                    }
                                ]
                            }
                        }
                    }
                }
            }
        }
    },
    "fingerprint": "string"
}
info
Required

Authentication information of the component. This includes information about all the namespaces in the component.

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 Vapi Metadata Authentication ComponentData.info could be quite large, 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 GET /vapi/metadata/authentication/component/{componentId}/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 GET /vapi/metadata/authentication/component/{componentId} to retrieve the new authentication information for the component.


404

if the component element associated with componentId does not have any authentication information.

Returns Vapi Std Errors NotFound of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors NotFound0 
"Vapi Std Errors NotFound Object"

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/vapi/metadata/authentication/component/{componentId}
On This Page
Vapi Operations
GET
Vapi Metadata Authentication Component list
GET
Vapi Metadata Authentication Component get
GET
Vapi Metadata Authentication Component fingerprint