VMware vCloud Suite SDK for .NET 6.0.0
|
The Session
interface allows API clients to manage session tokens including creating, deleting and obtaining information about sessions.
More...
Inherited by vmware::cis::SessionStub.
Public Member Functions | |
char[] | Create () |
Creates a session with the API. | |
char[] | Create (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig) |
Creates a session with the API. | |
global::System.Threading.Tasks.Task < char[]> | CreateAsync () |
Creates a session with the API. | |
global::System.Threading.Tasks.Task < char[]> | CreateAsync (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig) |
Creates a session with the API. | |
void | Delete () |
Terminates the validity of a session token. | |
void | Delete (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig) |
Terminates the validity of a session token. | |
global::System.Threading.Tasks.Task | DeleteAsync () |
Terminates the validity of a session token. | |
global::System.Threading.Tasks.Task | DeleteAsync (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig) |
Terminates the validity of a session token. | |
vmware.cis.SessionTypes.Info | Get () |
Returns information about the current session. | |
vmware.cis.SessionTypes.Info | Get (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig) |
Returns information about the current session. | |
global::System.Threading.Tasks.Task < vmware.cis.SessionTypes.Info > | GetAsync () |
Returns information about the current session. | |
global::System.Threading.Tasks.Task < vmware.cis.SessionTypes.Info > | GetAsync (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig) |
Returns information about the current session. |
The Session
interface allows API clients to manage session tokens including creating, deleting and obtaining information about sessions.
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:
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 as a HTTP header.
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:
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 errors:
char [] vmware::cis::Session::Create | ( | ) |
Creates a session with the API.
This is the equivalent of login. This method exchanges user credentials supplied in the security context for a session identifier that is to be used for authenticating subsequent calls. To authenticate subsequent calls clients are expected to include the session key.
vmware.vapi.std.errors.Unauthenticated | if the session creation fails due to request specific issues. Due to the security nature of the API the details of the error are not disclosed. |
Please check the following preconditions if using a SAML token to authenticate:
vmware.vapi.std.errors.ServiceUnavailable | if session creation fails due to server specific issues, for example connection to a back end component is failing. Due to the security nature of this API further details will not be disclosed in the error. Please refer to component health information, administrative logs and product specific documentation for possible causes. |
Implemented in vmware::cis::SessionStub.
char [] vmware::cis::Session::Create | ( | global::System.Action< vmware.vapi.std.Progress > | _progress, |
vmware.vapi.bindings.client.InvocationConfig | _invocationConfig | ||
) |
Creates a session with the API.
This is the equivalent of login. This method exchanges user credentials supplied in the security context for a session identifier that is to be used for authenticating subsequent calls. To authenticate subsequent calls clients are expected to include the session key.
vmware.vapi.std.errors.Unauthenticated | if the session creation fails due to request specific issues. Due to the security nature of the API the details of the error are not disclosed. |
Please check the following preconditions if using a SAML token to authenticate:
vmware.vapi.std.errors.ServiceUnavailable | if session creation fails due to server specific issues, for example connection to a back end component is failing. Due to the security nature of this API further details will not be disclosed in the error. Please refer to component health information, administrative logs and product specific documentation for possible causes. |
Implemented in vmware::cis::SessionStub.
global::System.Threading.Tasks.Task<char[]> vmware::cis::Session::CreateAsync | ( | global::System.Action< vmware.vapi.std.Progress > | _progress, |
vmware.vapi.bindings.client.InvocationConfig | _invocationConfig | ||
) |
Creates a session with the API.
This is the equivalent of login. This method exchanges user credentials supplied in the security context for a session identifier that is to be used for authenticating subsequent calls. To authenticate subsequent calls clients are expected to include the session key.
vmware.vapi.std.errors.Unauthenticated | if the session creation fails due to request specific issues. Due to the security nature of the API the details of the error are not disclosed. |
Please check the following preconditions if using a SAML token to authenticate:
vmware.vapi.std.errors.ServiceUnavailable | if session creation fails due to server specific issues, for example connection to a back end component is failing. Due to the security nature of this API further details will not be disclosed in the error. Please refer to component health information, administrative logs and product specific documentation for possible causes. |
Implemented in vmware::cis::SessionStub.
global::System.Threading.Tasks.Task<char[]> vmware::cis::Session::CreateAsync | ( | ) |
Creates a session with the API.
This is the equivalent of login. This method exchanges user credentials supplied in the security context for a session identifier that is to be used for authenticating subsequent calls. To authenticate subsequent calls clients are expected to include the session key.
vmware.vapi.std.errors.Unauthenticated | if the session creation fails due to request specific issues. Due to the security nature of the API the details of the error are not disclosed. |
Please check the following preconditions if using a SAML token to authenticate:
vmware.vapi.std.errors.ServiceUnavailable | if session creation fails due to server specific issues, for example connection to a back end component is failing. Due to the security nature of this API further details will not be disclosed in the error. Please refer to component health information, administrative logs and product specific documentation for possible causes. |
Implemented in vmware::cis::SessionStub.
void vmware::cis::Session::Delete | ( | ) |
Terminates the validity of a session token.
This is the equivalent of log out.
A session identifier is expected as part of the request.
vmware.vapi.std.errors.Unauthenticated | if the session id is missing from the request or the corresponding session object cannot be found. |
vmware.vapi.std.errors.ServiceUnavailable | if session deletion fails due to server specific issues, for example connection to a back end component is failing. Due to the security nature of this API further details will not be disclosed in the error. Please refer to component health information, administrative logs and product specific documentation for possible causes. |
Implemented in vmware::cis::SessionStub.
void vmware::cis::Session::Delete | ( | global::System.Action< vmware.vapi.std.Progress > | _progress, |
vmware.vapi.bindings.client.InvocationConfig | _invocationConfig | ||
) |
Terminates the validity of a session token.
This is the equivalent of log out.
A session identifier is expected as part of the request.
vmware.vapi.std.errors.Unauthenticated | if the session id is missing from the request or the corresponding session object cannot be found. |
vmware.vapi.std.errors.ServiceUnavailable | if session deletion fails due to server specific issues, for example connection to a back end component is failing. Due to the security nature of this API further details will not be disclosed in the error. Please refer to component health information, administrative logs and product specific documentation for possible causes. |
Implemented in vmware::cis::SessionStub.
global::System.Threading.Tasks.Task vmware::cis::Session::DeleteAsync | ( | global::System.Action< vmware.vapi.std.Progress > | _progress, |
vmware.vapi.bindings.client.InvocationConfig | _invocationConfig | ||
) |
Terminates the validity of a session token.
This is the equivalent of log out.
A session identifier is expected as part of the request.
vmware.vapi.std.errors.Unauthenticated | if the session id is missing from the request or the corresponding session object cannot be found. |
vmware.vapi.std.errors.ServiceUnavailable | if session deletion fails due to server specific issues, for example connection to a back end component is failing. Due to the security nature of this API further details will not be disclosed in the error. Please refer to component health information, administrative logs and product specific documentation for possible causes. |
Implemented in vmware::cis::SessionStub.
global::System.Threading.Tasks.Task vmware::cis::Session::DeleteAsync | ( | ) |
Terminates the validity of a session token.
This is the equivalent of log out.
A session identifier is expected as part of the request.
vmware.vapi.std.errors.Unauthenticated | if the session id is missing from the request or the corresponding session object cannot be found. |
vmware.vapi.std.errors.ServiceUnavailable | if session deletion fails due to server specific issues, for example connection to a back end component is failing. Due to the security nature of this API further details will not be disclosed in the error. Please refer to component health information, administrative logs and product specific documentation for possible causes. |
Implemented in vmware::cis::SessionStub.
vmware.cis.SessionTypes.Info vmware::cis::Session::Get | ( | global::System.Action< vmware.vapi.std.Progress > | _progress, |
vmware.vapi.bindings.client.InvocationConfig | _invocationConfig | ||
) |
Returns information about the current session.
This method expects a valid session identifier to be supplied.
A side effect of invoking this method may be a change to the session's last accessed time to the current time if this is supported by the session implementation. Invoking any other method in the API will also update the session's last accessed time.
This API is meant to serve the needs of various front end projects that may want to display the name of the user. Examples of this include various web based user interfaces and logging facilities.
vmware.vapi.std.errors.Unauthenticated | if the session id is missing from the request or the corresponding session object cannot be found. |
vmware.vapi.std.errors.ServiceUnavailable | if session retrieval fails due to server specific issues e.g. connection to back end component is failing. Due to the security nature of this API further details will not be disclosed in the error. Please refer to component health information, administrative logs and product specific documentation for possible causes. |
Implemented in vmware::cis::SessionStub.
vmware.cis.SessionTypes.Info vmware::cis::Session::Get | ( | ) |
Returns information about the current session.
This method expects a valid session identifier to be supplied.
A side effect of invoking this method may be a change to the session's last accessed time to the current time if this is supported by the session implementation. Invoking any other method in the API will also update the session's last accessed time.
This API is meant to serve the needs of various front end projects that may want to display the name of the user. Examples of this include various web based user interfaces and logging facilities.
vmware.vapi.std.errors.Unauthenticated | if the session id is missing from the request or the corresponding session object cannot be found. |
vmware.vapi.std.errors.ServiceUnavailable | if session retrieval fails due to server specific issues e.g. connection to back end component is failing. Due to the security nature of this API further details will not be disclosed in the error. Please refer to component health information, administrative logs and product specific documentation for possible causes. |
Implemented in vmware::cis::SessionStub.
global::System.Threading.Tasks.Task<vmware.cis.SessionTypes.Info> vmware::cis::Session::GetAsync | ( | ) |
Returns information about the current session.
This method expects a valid session identifier to be supplied.
A side effect of invoking this method may be a change to the session's last accessed time to the current time if this is supported by the session implementation. Invoking any other method in the API will also update the session's last accessed time.
This API is meant to serve the needs of various front end projects that may want to display the name of the user. Examples of this include various web based user interfaces and logging facilities.
vmware.vapi.std.errors.Unauthenticated | if the session id is missing from the request or the corresponding session object cannot be found. |
vmware.vapi.std.errors.ServiceUnavailable | if session retrieval fails due to server specific issues e.g. connection to back end component is failing. Due to the security nature of this API further details will not be disclosed in the error. Please refer to component health information, administrative logs and product specific documentation for possible causes. |
Implemented in vmware::cis::SessionStub.
global::System.Threading.Tasks.Task<vmware.cis.SessionTypes.Info> vmware::cis::Session::GetAsync | ( | global::System.Action< vmware.vapi.std.Progress > | _progress, |
vmware.vapi.bindings.client.InvocationConfig | _invocationConfig | ||
) |
Returns information about the current session.
This method expects a valid session identifier to be supplied.
A side effect of invoking this method may be a change to the session's last accessed time to the current time if this is supported by the session implementation. Invoking any other method in the API will also update the session's last accessed time.
This API is meant to serve the needs of various front end projects that may want to display the name of the user. Examples of this include various web based user interfaces and logging facilities.
vmware.vapi.std.errors.Unauthenticated | if the session id is missing from the request or the corresponding session object cannot be found. |
vmware.vapi.std.errors.ServiceUnavailable | if session retrieval fails due to server specific issues e.g. connection to back end component is failing. Due to the security nature of this API further details will not be disclosed in the error. Please refer to component health information, administrative logs and product specific documentation for possible causes. |
Implemented in vmware::cis::SessionStub.