REST API - get

vapi metadata authentication service operation: get

Retrieves the authentication information about an operation element corresponding to operation_id contained in the service element corresponding to service_id.

Request:

HTTP request

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

Path Parameters

Name	Type	Description
Required
service_id	string	Identifier of the service element.

{
"operation_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">
<operation_id>obj-103</operation_id>
</ns0:Get-Input>

Request Body Parameters:

Name	Type	Description
bold = required
operation_id	string	Identifier of the operation element.

Response:

HTTP Status Code: 200

Representations:

JSON
XML

{
    "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>

Response Type:

Name	Type	Description
bold = required
value	operation_info	The vapi.metadata.authentication.operation_info instance that corresponds to `operation_id`.
value.schemes	authentication_info[]	List of authentication schemes used by an operation element. The authentication scheme specified on the service element corresponding to this operation element is ignored.
value.schemes[].scheme_type	string	The type of the authentication scheme. Provides enumeration values for the set of valid authentication scheme types. Value is one of: SESSIONLESS: Indicates that the scheme is a session less authentication scheme, the user is authenticated on every operation. There is no explicit session establishment. SESSION_AWARE: Indicates that the scheme is a session aware authentication scheme. It requires an explicit login before executing a operation and logout when a session terminates. A service might choose to have a session aware scheme if it wants to associate some state corresponding to the user until the user logs out or if it wants to mitigate the cost of authenticating the user on every operation.
value.schemes[].session_manager	string	In a session aware authentication scheme, a session manager is required that supports `create`, `delete` and `keepAlive` operations. The fully qualified service name of the session manager is provided in vapi.metadata.authentication.authentication_info.session_manager field. This service is responsible for handling sessions. Optional. It is only relevant when scheme_type has value SESSION_AWARE. This field is optional and it is only relevant when the value of `scheme_type` is SESSION_AWARE.
value.schemes[].scheme	string	String identifier of the authentication scheme. Following are the supported authentication schemes by the infrastructure: The identifier `com.vmware.vapi.std.security.saml_hok_token` for SAML holder of key token based authentication mechanism. The identifier `com.vmware.vapi.std.security.bearer_token` for SAML bearer token based authentication mechanism. The identifier `com.vmware.vapi.std.security.session_id` for session based authentication mechanism. The identifier `com.vmware.vapi.std.security.user_pass` for username and password based authentication mechanism.

Errors:

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