REST API - package

vapi metadata authentication: package info

The package_info structure contains authentication information of a package element.

For an explanation of authentication information contained within package elements, see vapi.metadata.authentication.package.

Representations:

JSON
XML

{
    "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:PackageInfo xmlns:ns0="http://vmware.com/vapi/metadata/authentication" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <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>
</ns0:PackageInfo>

Attributes:

Name Type Description

Required

Name	Type	Description
Required
schemes	authentication_info[]	List of authentication schemes to be used for all the operation elements contained in this package element. If a particular service or operation element has no explicit authentications defined in the authentication defintion file, these authentication schemes are used for authenticating the user.
services	list	Information about all service elements contained in this package element that contain authentication information. The key in the key/value pairs is the identifier of the service element and the value in the key/value pairs is the authentication information for the service element. For an explanation of authentication information containment within service elements, see vapi.metadata.authentication.service. When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: `com.vmware.vapi.service`. When operations return a value of this structure as a result, the key in the field key/value pairs will be an identifier for the resource type: `com.vmware.vapi.service`.List of {"key": string, "value": service_info}

schemes

authentication_info[]

List of authentication schemes to be used for all the operation elements contained in this package element. If a particular service or operation element has no explicit authentications defined in the authentication defintion file, these authentication schemes are used for authenticating the user.

services

list

Information about all service elements contained in this package element that contain authentication information. The key in the key/value pairs is the identifier of the service element and the value in the key/value pairs is the authentication information for the service element.

For an explanation of authentication information containment within service elements, see vapi.metadata.authentication.service.

When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: com.vmware.vapi.service. When operations return a value of this structure as a result, the key in the field key/value pairs will be an identifier for the resource type: com.vmware.vapi.service.List of {"key": string, "value": service_info}