REST API - get

REST API - get

com.vmware.vapi.metadata.authentication.source

The source service provides operations to manage the sources of authentication metadata information.

The interface definition language infrastructure provides tools to generate various kinds of metadata in JSON format from the interface definition files and additional properties files. One of the generated files contains authentication information. The generated file can be registered as a source of metadata.

The authentication file contains all the data present in the interface definition files. Each authentication file contains data about one component element. When a authentication file is added as a source, each source contributes only one component element's metadata.

Authentication metadata can also be discovered from a remote server that supports the authentication metadata services (see com.vmware.vapi.metadata.authentication). Since multiple components can be registered with a single metadata server, when a remote server is registered as a source, that source can contribute more than one component.

get

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

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

Parameters:
Name Type Required Description
source_id
 *
 ID Yes Identifier of the metadata source. Id of type com.vmware.vapi.metadata.authentication.source.

Response:
Representations:
{
    "value": {
        "address": "http://myurl.com",
        "description": "string",
        "filepath": "string",
        "type": "FILE"
    }
}
<?xml version="1.0" ?>
<ns0:Get-Result xmlns:ns0="http://vmware.com/vapi/metadata/authentication/source" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <value>
    <filepath>string</filepath>
    <address>http://myurl.com</address>
    <description>string</description>
    <type>FILE</type>
  </value>
</ns0:Get-Result>

Parameters:
Name Type Required Description
result info Yes The com.vmware.vapi.metadata.authentication.source.info instance that corresponds to source_id

Errors:
Type Description HTTP Status Code
not_found if the metadata source associated with source_id is not found. 404

Copyright © 2014. All Rights Reserved.