This API has a deprecated equivalent from v7.0U1.
Get Authentication Service
Retrieves authentication information about the service element corresponding to serviceId.
Request
URLURL
https://{api_host}/api/vapi/metadata/authentication/service/{service_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.
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
MetadataAuthenticationServiceInfo
of type application/json
The ServiceInfo instance that corresponds to serviceId
{
"operations": {
"key": {
"schemes": [
{
"scheme": "string",
"scheme_type": "SESSIONLESS",
"session_manager": "string"
}
]
}
},
"schemes": [
{
"scheme": "string",
"scheme_type": "SESSIONLESS",
"session_manager": "string"
}
]
}
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 Operation.
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.operation. 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.operation.
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.
Errors
404
com.vmware.vapi.std.errors.not_found : if the service element associated with serviceId 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-GetServiceIdAuthentication -ServiceId "MyServiceId"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vapi/metadata/authentication/service/{service_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/service/id:{service_id}
x-vmw-doc-operation: get
Availability
Added in 7.0U2
