RestApi Constants


AuthError

If the access token request is invalid, such as the redirect URL didn't match the one used during authorization, then the server needs to return an error response.

Please see Unsuccessful Response for more information.

NameValue
AuthError::INVALID_REQUESTinvalid_request
AuthError::INVALID_CLIENTinvalid_client
AuthError::INVALID_GRANTinvalid_grant
AuthError::INVALID_SCOPEinvalid_scope
AuthError::UNAUTHORIZED_CLIENTunauthorized_client
AuthError::UNSUPPORTED_GRANT_TYPEunsupported_grant_type
AuthError::INVALID_REQUEST_DESCRIPTIONmissing parameter
AuthError::INVALID_CLIENT_DESCRIPTIONauthentication failed
AuthError::INVALID_GRANT_DESCRIPTIONauthorization is invalid or expired
AuthError::INVALID_SCOPE_DESCRIPTIONinvalid scope value
AuthError::UNAUTHORIZED_CLIENT_DESCRIPTIONclient is not authorized
AuthError::UNSUPPORTED_GRANT_TYPE_DESCRIPTIONthe authorization server does not recogniz

AuthType

HTTP Authentication type.

Please see Authentication schemes for more information.

NameValue
AuthType::BASICBasic
AuthType::BEARERBearer
AuthType::DIGISTDigest
AuthType::HOBAHOBA

GrantType

Describes oauth2 grant type.

Please see "grant_type" Syntax for more information.

NameValue
GrantType::CLIENT_CREDENTIALSclient_credentials
GrantType::PASSWORDpassword
GrantType::AUTHORIZATION_CODEauthorization_code
GrantType::REFRESH_TOKENrefresh_token

HttpStatus

Describes HTTP status.

Please see HTTP Status Codes for more information.

NameValue
HttpStatus::OK200
HttpStatus::BAD_REQUEST400
HttpStatus::UNAUTHORIZED401
HttpStatus::INTERNAL_SERVER_ERROR500