This API has a deprecated equivalent from v7.0U1.
Get Authentication Service Operation
Retrieves the authentication information about an operation element corresponding to operationId contained in the service element corresponding to serviceId.
Request
URLURL
https://{api_host}/api/vapi/metadata/authentication/service/{service_id}/operation/{operation_id}
Path Parameters
Path Parameters
string
service_id
Required
Identifier of the service element. The parameter must be an identifier for the resource type: com.vmware.vapi.service.
string
operation_id
Required
Identifier of the operation element. The parameter must be an identifier for the resource type: com.vmware.vapi.operation.
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
MetadataAuthenticationOperationInfo
of type application/json
The OperationInfo instance that corresponds to operationId.
{
"schemes": [
{
"scheme": "string",
"scheme_type": "SESSIONLESS",
"session_manager": "string"
}
]
}
schemes
Required
List of authentication schemes used by an operation element. The authentication scheme specified on the service element corresponding to this operation element is ignored.
Errors
404
com.vmware.vapi.std.errors.not_found : if the service element associated with serviceId does not exist. if the operation element associated with operationId does not exist. if the operation element associated with operationId 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-GetServiceIdOperationIdAuthentication -ServiceId "MyServiceId" -OperationId "MyOperationId"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vapi/metadata/authentication/service/{service_id}/operation/{operation_id}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: post
x-vmw-doc-deprecated-path: /rest/com/vmware/vapi/metadata/authentication/service/operation/id:{service_id}?~action=get
x-vmw-doc-operation: get
Availability
Added in 7.0U2
