AuthenticationRequired

AuthenticationRequired
AuthenticationRequired

The AuthenticationRequired fault indicates that the client must authenticate or re-authenticate to access the requested resource.

This fault is thrown when:

  • No authentication credentials are provided in the request
  • The provided access token is invalid, expired, or revoked
  • The authentication scheme used is not supported
  • The request has malformed authentication parameters

When this fault occurs, clients should examine the authenticate challenges to determine the appropriate authentication method and parameters. The VI/JSON infrastructure automatically converts this fault into standard HTTP authentication responses with appropriate status codes (400, 401, 403) and WWW-Authenticate headers based on the challenge details.

For OAuth 2.0 Bearer token authentication, clients may need to:

  • Obtain a new access token if the current one is expired
  • Register full user claims with vCenter
  • Discover authentication endpoint from OpenID Connect Configuration
AllOf
This class requires all of the following:
JSON Example 
{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ],
    "authenticate": [
        {
            "_typeName": "string",
            "scheme": "string",
            "realm": "string",
            "error": "string",
            "errorDescription": "string",
            "ovl": "string",
            "oidcConfigUrl": "string"
        }
    ]
}
array of AuthenticationRequiredChallenge
authenticate
Required

Applicable to the request authentication schemes and their requirements.

Property Of