REST API - get

REST API - get

com.vmware.vapi.metadata.authentication.service.operation

The operation service provides operations to retrieve authentication information of an operation element.

An operation element is said to contain authentication information if authentication schemes are specified in the authentication definition file.

get

POST /com/vmware/vapi/metadata/authentication/service/operation/id:{service_id}?~action=get
POST /com/vmware/vapi/metadata/authentication/service/operation?~action=get

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

Parameters:
Name Type Required Description
service_id
 *
 ID Yes Identifier of the service element. Id of type com.vmware.vapi.service.
operation_id
 *
 ID Yes Identifier of the operation element. Id of type com.vmware.vapi.operation.

Response:
Representations:
{
    "value": {
        "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/service/operation" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <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>
</ns0:Get-Result>

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

Errors:
Type Description HTTP Status Code
not_found if the service element associated with service_id does not exist. 404

Copyright © 2014. All Rights Reserved.