com.vmware.vapi.std.errors

Class Unauthorized

java.lang.Object

com.vmware.vapi.std.errors.Unauthorized

public static class Unauthorized
extends java.lang.Object

The Unauthorized exception indicates that the user is not authorized to perform the method.

API requests may include a security context containing user credentials. For example, the user credentials could be a SAML token, a user name and password, or the session identifier for a previously established session. Invoking the method may require that the user identified by those credentials has particular privileges on the method or on one or more resource identifiers passed to the method.

Examples:

• The method requires that the user have one or more privileges on the method, but the user identified by the credentials in the security context does not have the required privileges.
• The method requires that the user have one or more privileges on a resource identifier passed to the method, but the user identified by the credentials in the security context does not have the required privileges.

Counterexamples:

• The SAML token in the request's security context has expired. A Unauthenticated exception would be used instead.
• The user name and password in the request's security context are invalid. The Unauthenticated exception would be used instead.
• The session identifier in the request's security context identifies a session that has expired. The Unauthenticated exception would be used instead.

For security reasons, the Error.getData() property in this exception is null, and the Error.getMessages() property in this exception does not disclose why the user is not authorized to perform the method. For example the messages would not disclose which privilege the user did not have or which resource identifier the user did not have the required privilege to access. The API documentation should indicate what privileges are required.

See Also:

Serialized Form

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait