1. Types
  2. vapi
  3. metadata
  4. authentication

vapi metadata authentication: component data

The component_data structure contains the authentication information of the component along with its fingerprint.

Representations:

{
    "fingerprint": "string",
    "info": {
        "packages": [
            {
                "key": "obj-103",
                "value": {
                    "schemes": [
                        {
                            "scheme": "string",
                            "scheme_type": "SESSIONLESS",
                            "session_manager": "string"
                        },
                        {
                            "scheme": "string",
                            "scheme_type": "SESSIONLESS",
                            "session_manager": "string"
                        }
                    ],
                    "services": [
                        {
                            "key": "obj-103",
                            "value": {
                                "operations": [
                                    {
                                        "key": "obj-103",
                                        "value": {
                                            "schemes": [
                                                {
                                                    "scheme": "string",
                                                    "scheme_type": "SESSIONLESS",
                                                    "session_manager": "string"
                                                },
                                                {
                                                    "scheme": "string",
                                                    "scheme_type": "SESSIONLESS",
                                                    "session_manager": "string"
                                                }
                                            ]
                                        }
                                    }
                                ],
                                "schemes": [
                                    {
                                        "scheme": "string",
                                        "scheme_type": "SESSIONLESS",
                                        "session_manager": "string"
                                    },
                                    {
                                        "scheme": "string",
                                        "scheme_type": "SESSIONLESS",
                                        "session_manager": "string"
                                    }
                                ]
                            }
                        }
                    ]
                }
            }
        ]
    }
}
<?xml version="1.0" ?>
<ns0:ComponentData xmlns:ns0="http://vmware.com/vapi/metadata/authentication" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <fingerprint>string</fingerprint>
  <info>
    <packages-array>
      <array-item>
        <value>
          <services-array>
            <array-item>
              <value>
                <schemes-array>
                  <array-item>
                    <scheme_type>SESSIONLESS</scheme_type>
                    <scheme>string</scheme>
                    <session_manager>string</session_manager>
                  </array-item>
                  <array-item>
                    <scheme_type>SESSIONLESS</scheme_type>
                    <scheme>string</scheme>
                    <session_manager>string</session_manager>
                  </array-item>
                </schemes-array>
                <operations-array>
                  <array-item>
                    <value>
                      <schemes-array>
                        <array-item>
                          <scheme_type>SESSIONLESS</scheme_type>
                          <scheme>string</scheme>
                          <session_manager>string</session_manager>
                        </array-item>
                        <array-item>
                          <scheme_type>SESSIONLESS</scheme_type>
                          <scheme>string</scheme>
                          <session_manager>string</session_manager>
                        </array-item>
                      </schemes-array>
                    </value>
                    <key>obj-103</key>
                  </array-item>
                </operations-array>
              </value>
              <key>obj-103</key>
            </array-item>
          </services-array>
          <schemes-array>
            <array-item>
              <scheme_type>SESSIONLESS</scheme_type>
              <scheme>string</scheme>
              <session_manager>string</session_manager>
            </array-item>
            <array-item>
              <scheme_type>SESSIONLESS</scheme_type>
              <scheme>string</scheme>
              <session_manager>string</session_manager>
            </array-item>
          </schemes-array>
        </value>
        <key>obj-103</key>
      </array-item>
    </packages-array>
  </info>
</ns0:ComponentData>

Attributes:

Name Type Description
Required
info component_info Authentication information of the component. This includes information about all the API in the component.
fingerprint string 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.component_data.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 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 to retrieve the new authentication information for the component.