Shrink

Shrink

This request will make the C4 service to forget the associated authentication for the given site(peer) (if any) with the current session

Request
URI
DELETE
https://{api_host}//sessions/{site}
COPY
Path Parameters
string
site
Required

site

Header Parameters
string
operationID
Optional

Operation ID for correlating logs across multiple services

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns C4SessionDetails of type(s) application/vnd.vmware.h4-v3.5+json;charset=UTF-8 
{
    "authenticatedSites": [
        {
            "org": "Org1",
            "site": "site1"
        }
    ],
    "roles": [
        "EVERYONE"
    ],
    "user": "admin1@Org1"
}
array of AuthenticatedSiteDetails
authenticatedSites
Optional

vCloud Director sites the current session has authenticated with. The site specified in the request should be present here

array of string
roles
Optional

Roles granted to the session

string
user
Optional

The currently authenticated user


400

Returned error codes include (but are not limited to):

  • BadUserInput
Returns ApiError of type(s) application/vnd.vmware.h4-v3.5+json;charset=UTF-8 
{
    "args": [
        "string"
    ],
    "code": "string",
    "msg": "string",
    "stacktrace": "string"
}
array of string
args
Optional

Positional arguments.

string
code
Optional

Specific error code.

string
msg
Optional

Detailed error message.

string
stacktrace
Optional

Exception stacktrace.


401

Returned error codes include (but are not limited to):

  • NotAuthenticated
Returns ApiError of type(s) application/vnd.vmware.h4-v3.5+json;charset=UTF-8 
{
    "args": [
        "string"
    ],
    "code": "string",
    "msg": "string",
    "stacktrace": "string"
}
array of string
args
Optional

Positional arguments.

string
code
Optional

Specific error code.

string
msg
Optional

Detailed error message.

string
stacktrace
Optional

Exception stacktrace.


500

Returned error codes include (but are not limited to):

  • GeneralServerFailure
Returns ApiError of type(s) application/vnd.vmware.h4-v3.5+json;charset=UTF-8 
{
    "args": [
        "string"
    ],
    "code": "string",
    "msg": "string",
    "stacktrace": "string"
}
array of string
args
Optional

Positional arguments.

string
code
Optional

Specific error code.

string
msg
Optional

Detailed error message.

string
stacktrace
Optional

Exception stacktrace.


On This Page
Session Operations
POST
Extend
GET
Get Session
POST
Login
DELETE
Logout
DELETE
Shrink