This API has a deprecated equivalent from v7.0U1.
Get Authentication Package
Retrieves authentication information about the package element corresponding to packageId.
Request
URLURL
https://{api_host}/api/vapi/metadata/authentication/package/{package_id}
Path Parameters
Path Parameters
string
package_id
Required
Identifier of the package element. The parameter must be an identifier for the resource type: com.vmware.vapi.package.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
MetadataAuthenticationPackageInfo
of type application/json
The PackageInfo instance that corresponds to packageId
{
"schemes": [
{
"scheme": "string",
"scheme_type": "SESSIONLESS",
"session_manager": "string"
}
],
"services": {
"key": {
"operations": {
"key": {
"schemes": [
{
"scheme": "string",
"scheme_type": "SESSIONLESS",
"session_manager": "string"
}
]
}
},
"schemes": [
{
"scheme": "string",
"scheme_type": "SESSIONLESS",
"session_manager": "string"
}
]
}
}
}
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.
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 Service.
When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: com.vmware.vapi.service. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: com.vmware.vapi.service.
Errors
404
com.vmware.vapi.std.errors.not_found : if the package element associated with packageId does not have any authentication information.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-GetPackageIdAuthentication -PackageId "MyPackageId"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vapi/metadata/authentication/package/{package_id}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/com/vmware/vapi/metadata/authentication/package/id:{package_id}
x-vmw-doc-operation: get
Availability
Added in 7.0U2
