AuthenticationRequiredChallenge

AuthenticationRequiredChallenge
AuthenticationRequiredChallenge

Authentication challenge comprised of authentication scheme and requirements.

The authentication challenge descries a procedure and parameters the client application can use to successfully authorize access.

AllOf
This class requires all of the following:
JSON Example 
{
    "_typeName": "string",
    "scheme": "string",
    "realm": "string",
    "error": "string",
    "errorDescription": "string",
    "ovl": "string",
    "oidcConfigUrl": "string"
}
string
scheme
Required

Authentication scheme described in the challenge.

The field possible values are described by AuthenticationRequiredAuthenticationSchemeEnum enum.

string
realm
Optional

Defines the protection space of the scheme.

The protection space determines the domain over which credentials might be automatically applied. If a prior request has been authorized the application may reuse the same credentials for all other requests within the same protection space for a period of time determined by the authentication scheme, parameters or application preferences.

string
error
Optional

The reason why the access request was declined.

The field possible values are described by AuthenticationRequiredErrorTypeEnum enum.

string
errorDescription
Optional

Provides developers human-readable explanation that is not meant to be displayed to end-users.

string
ovl
Optional

Full claims token URI.

An application uses this value to obtain Full Claims Token that is then registered with vCenter to enable the provided access token use in vCenter.

string
oidcConfigUrl
Optional

OpenID Connect Configuration URI.

An application uses this value to obtain OpenID Connect Configuration.

Property Of