Vapi Metadata Authentication Service get

Vapi Metadata Authentication Service get

Retrieves authentication information about the service element corresponding to serviceId.

Request
URI
GET
https://{api_host}/api/vapi/metadata/authentication/service/{serviceId}
COPY
Path Parameters
string
serviceId
Required

Identifier of the service element.

The parameter must be an identifier for the resource type: com.vmware.vapi.service.


Authentication
This operation uses the following authentication methods.
Responses
200

The Vapi Metadata Authentication ServiceInfo instance that corresponds to serviceId

Returns Vapi Metadata Authentication ServiceInfo of type(s) application/json
{
    "schemes": [
        {
            "scheme_type": "string",
            "session_manager": "string",
            "scheme": "string"
        }
    ],
    "operations": {
        "operations": {
            "schemes": [
                {
                    "scheme_type": "string",
                    "session_manager": "string",
                    "scheme": "string"
                }
            ]
        }
    }
}
array of object
schemes
Required

List of authentication schemes to be used for all the operation elements contained in this service element. The authentication scheme specified on the package element corresponding to this service element is ignored.

object
operations
Required

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

For an explanation of containment of authentication information within operation elements, see Vapi Metadata Authentication Service Operation.

When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.vapi.operation. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.vapi.operation.


404

if the service element associated with serviceId does not have any authentication information.

Returns Vapi Std Errors NotFound of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors NotFound0
"Vapi Std Errors NotFound Object"

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/vapi/metadata/authentication/service/{serviceId}