REST API - get

REST API - get

com.vmware.vapi.metadata.authentication.package

The package service provides operations to retrieve authentication information of a package element.

A package element is said to contain authentication information if there is a default authentication assigned to all service elements contained in the package element or if one of the service element contained in this package element has authentication information.

get

GET /com/vmware/vapi/metadata/authentication/package/id:{package_id}
POST /com/vmware/vapi/metadata/authentication/package/id:{package_id}?~action=get
POST /com/vmware/vapi/metadata/authentication/package?~action=get

Retrieves authentication information about the package element corresponding to package_id.
Request:
Representations:
{
    "package_id": "obj-103"
}
<?xml version="1.0" ?>
<ns0:Get-Input xmlns:ns0="http://vmware.com/vapi/metadata/authentication/package" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <package_id>obj-103</package_id>
</ns0:Get-Input>
POST /com/vmware/vapi/metadata/authentication/package?~action=get
&package_id=obj-103

Parameters:
Name Type Required Description
package_id
 *
 ID Yes Identifier of the package element. Id of type com.vmware.vapi.package.

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

Parameters:
Name Type Required Description
result package_info Yes The com.vmware.vapi.metadata.authentication.package_info instance that corresponds to package_id

Errors:
Type Description HTTP Status Code
not_found if the package element associated with package_id does not have any authentication information. 404

Copyright © 2014. All Rights Reserved.