public interface SessionTypes
Session
interface allows API clients to manage session tokens
including creating, deleting and obtaining information about sessions.
Session.create()
method creates session
token in exchange for another authentication token.Session.delete()
method invalidates a session token.Session.get()
retrieves information about a session
token. The call to the Session.create()
method is part of the overall authentication process for API clients. For
example, the sequence of steps for establishing a session with SAML token is:
Session.create()
method. The
Session.create()
call must include the SAML token.See the programming guide and samples for additional information about establishing API sessions.
Execution Context and Security Context
To use session based authentication a client should supply
the session token obtained through the Session.create()
method. The client should add the session token in the security context when
using SDK classes. Clients using the REST API should supply the session token
using the vmware-api-session-id
HTTP header field.
Session Lifetime
A session begins with call to the Session.create()
method to exchange a SAML token for a API session
token. A session ends under the following circumstances:
Session.delete()
method. When a session ends, the authentication logic will reject any subsequent client requests that specify that session. Any operations in progress will continue to completion.
Error Handling
The Session
returns the
following exceptions:
Unauthenticated
exception for any exceptions related
to the request.ServiceUnavailable
exception for all exceptions caused by internal service failure.Modifier and Type | Interface and Description |
---|---|
static class |
SessionTypes.Info
Represents data associated with an API session.
|
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
_VAPI_SERVICE_ID
Identifier of the service
|
static final java.lang.String _VAPI_SERVICE_ID