Shrink

Shrink

This request causes the Cloud service to forget the associated authentication for the specified site (peer) (if any) with the current session.

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

The VCDA site to exclude from the current session

site example 
site1
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/json;charset=UTF-8
This response body class contains all of the following: SessionDetails 
{
    "roles": [
        "EVERYONE"
    ],
    "user": "admin1@Org1",
    "authenticatedSites": [
        {
            "org": "Org1",
            "site": "site1"
        }
    ]
}
array of AuthenticatedSiteDetails
authenticatedSites
Optional

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


400

The returned error codes include (but are not limited to): BadUserInput

Returns ApiError of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8 
{
    "args": [],
    "code": "Forbidden",
    "msg": "Permission denied.",
    "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}
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

The returned error codes include (but are not limited to): NotAuthenticated

Returns ApiError of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8 
{
    "args": [],
    "code": "Forbidden",
    "msg": "Permission denied.",
    "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}
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

The returned error codes include (but are not limited to): GeneralServerFailure

Returns ApiError of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8 
{
    "args": [],
    "code": "Forbidden",
    "msg": "Permission denied.",
    "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}
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