Vapi Metadata Authentication Package get

Vapi Metadata Authentication Package get

Retrieves authentication information about the package element corresponding to packageId.

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

Identifier of the package element.

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


Authentication
This operation uses the following authentication methods.
Responses
200

The Vapi Metadata Authentication PackageInfo instance that corresponds to packageId

Returns Vapi Metadata Authentication PackageInfo of type(s) application/json
{
    "schemes": [
        {
            "scheme_type": "string",
            "session_manager": "string",
            "scheme": "string"
        }
    ],
    "services": {
        "services": {
            "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 package element. If a particular service or operation element has no explicit authentications defined in the authentication defintion file, these authentication schemes are used for authenticating the user.

object
services
Required

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

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

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.service. 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.service.


404

if the package element associated with packageId 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/package/{packageId}