Package sh.ory.hydra.model

Class WellKnown

  • @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2021-01-12T16:13:57.119092Z[GMT]")
public class WellKnown
extends Object
    It includes links to several endpoints (e.g. /oauth2/token) and exposes information on supported signature algorithms among others.

    • Field Detail

      • SERIALIZED_NAME_AUTHORIZATION_ENDPOINT

        public static final String SERIALIZED_NAME_AUTHORIZATION_ENDPOINT
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_BACKCHANNEL_LOGOUT_SESSION_SUPPORTED

        public static final String SERIALIZED_NAME_BACKCHANNEL_LOGOUT_SESSION_SUPPORTED
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_BACKCHANNEL_LOGOUT_SUPPORTED

        public static final String SERIALIZED_NAME_BACKCHANNEL_LOGOUT_SUPPORTED
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_CLAIMS_PARAMETER_SUPPORTED

        public static final String SERIALIZED_NAME_CLAIMS_PARAMETER_SUPPORTED
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_END_SESSION_ENDPOINT

        public static final String SERIALIZED_NAME_END_SESSION_ENDPOINT
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_FRONTCHANNEL_LOGOUT_SESSION_SUPPORTED

        public static final String SERIALIZED_NAME_FRONTCHANNEL_LOGOUT_SESSION_SUPPORTED
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_FRONTCHANNEL_LOGOUT_SUPPORTED

        public static final String SERIALIZED_NAME_FRONTCHANNEL_LOGOUT_SUPPORTED
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_GRANT_TYPES_SUPPORTED

        public static final String SERIALIZED_NAME_GRANT_TYPES_SUPPORTED
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_ID_TOKEN_SIGNING_ALG_VALUES_SUPPORTED

        public static final String SERIALIZED_NAME_ID_TOKEN_SIGNING_ALG_VALUES_SUPPORTED
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_REGISTRATION_ENDPOINT

        public static final String SERIALIZED_NAME_REGISTRATION_ENDPOINT
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_REQUEST_OBJECT_SIGNING_ALG_VALUES_SUPPORTED

        public static final String SERIALIZED_NAME_REQUEST_OBJECT_SIGNING_ALG_VALUES_SUPPORTED
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_REQUEST_PARAMETER_SUPPORTED

        public static final String SERIALIZED_NAME_REQUEST_PARAMETER_SUPPORTED
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_REQUEST_URI_PARAMETER_SUPPORTED

        public static final String SERIALIZED_NAME_REQUEST_URI_PARAMETER_SUPPORTED
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_REQUIRE_REQUEST_URI_REGISTRATION

        public static final String SERIALIZED_NAME_REQUIRE_REQUEST_URI_REGISTRATION
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_RESPONSE_MODES_SUPPORTED

        public static final String SERIALIZED_NAME_RESPONSE_MODES_SUPPORTED
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_RESPONSE_TYPES_SUPPORTED

        public static final String SERIALIZED_NAME_RESPONSE_TYPES_SUPPORTED
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_SUBJECT_TYPES_SUPPORTED

        public static final String SERIALIZED_NAME_SUBJECT_TYPES_SUPPORTED
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_TOKEN_ENDPOINT_AUTH_METHODS_SUPPORTED

        public static final String SERIALIZED_NAME_TOKEN_ENDPOINT_AUTH_METHODS_SUPPORTED
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_USERINFO_SIGNING_ALG_VALUES_SUPPORTED

        public static final String SERIALIZED_NAME_USERINFO_SIGNING_ALG_VALUES_SUPPORTED
        See Also:
        Constant Field Values

    • Constructor Detail

      • WellKnown

        public WellKnown()

    • Method Detail

      • authorizationEndpoint

        public WellKnown authorizationEndpoint​(String authorizationEndpoint)

      • getAuthorizationEndpoint

        public String getAuthorizationEndpoint()
        URL of the OP's OAuth 2.0 Authorization Endpoint.
        Returns:
        authorizationEndpoint

      • setAuthorizationEndpoint

        public void setAuthorizationEndpoint​(String authorizationEndpoint)

      • backchannelLogoutSessionSupported

        public WellKnown backchannelLogoutSessionSupported​(Boolean backchannelLogoutSessionSupported)

      • getBackchannelLogoutSessionSupported

        @Nullable
public Boolean getBackchannelLogoutSessionSupported()
        Boolean value specifying whether the OP can pass a sid (session ID) Claim in the Logout Token to identify the RP session with the OP. If supported, the sid Claim is also included in ID Tokens issued by the OP
        Returns:
        backchannelLogoutSessionSupported

      • setBackchannelLogoutSessionSupported

        public void setBackchannelLogoutSessionSupported​(Boolean backchannelLogoutSessionSupported)

      • backchannelLogoutSupported

        public WellKnown backchannelLogoutSupported​(Boolean backchannelLogoutSupported)

      • getBackchannelLogoutSupported

        @Nullable
public Boolean getBackchannelLogoutSupported()
        Boolean value specifying whether the OP supports back-channel logout, with true indicating support.
        Returns:
        backchannelLogoutSupported

      • setBackchannelLogoutSupported

        public void setBackchannelLogoutSupported​(Boolean backchannelLogoutSupported)

      • claimsParameterSupported

        public WellKnown claimsParameterSupported​(Boolean claimsParameterSupported)

      • getClaimsParameterSupported

        @Nullable
public Boolean getClaimsParameterSupported()
        Boolean value specifying whether the OP supports use of the claims parameter, with true indicating support.
        Returns:
        claimsParameterSupported

      • setClaimsParameterSupported

        public void setClaimsParameterSupported​(Boolean claimsParameterSupported)

      • addClaimsSupportedItem

        public WellKnown addClaimsSupportedItem​(String claimsSupportedItem)

      • getClaimsSupported

        @Nullable
public List<String> getClaimsSupported()
        JSON array containing a list of the Claim Names of the Claims that the OpenID Provider MAY be able to supply values for. Note that for privacy or other reasons, this might not be an exhaustive list.
        Returns:
        claimsSupported

      • setClaimsSupported

        public void setClaimsSupported​(List<String> claimsSupported)

      • endSessionEndpoint

        public WellKnown endSessionEndpoint​(String endSessionEndpoint)

      • getEndSessionEndpoint

        @Nullable
public String getEndSessionEndpoint()
        URL at the OP to which an RP can perform a redirect to request that the End-User be logged out at the OP.
        Returns:
        endSessionEndpoint

      • setEndSessionEndpoint

        public void setEndSessionEndpoint​(String endSessionEndpoint)

      • frontchannelLogoutSessionSupported

        public WellKnown frontchannelLogoutSessionSupported​(Boolean frontchannelLogoutSessionSupported)

      • getFrontchannelLogoutSessionSupported

        @Nullable
public Boolean getFrontchannelLogoutSessionSupported()
        Boolean value specifying whether the OP can pass iss (issuer) and sid (session ID) query parameters to identify the RP session with the OP when the frontchannel_logout_uri is used. If supported, the sid Claim is also included in ID Tokens issued by the OP.
        Returns:
        frontchannelLogoutSessionSupported

      • setFrontchannelLogoutSessionSupported

        public void setFrontchannelLogoutSessionSupported​(Boolean frontchannelLogoutSessionSupported)

      • frontchannelLogoutSupported

        public WellKnown frontchannelLogoutSupported​(Boolean frontchannelLogoutSupported)

      • getFrontchannelLogoutSupported

        @Nullable
public Boolean getFrontchannelLogoutSupported()
        Boolean value specifying whether the OP supports HTTP-based logout, with true indicating support.
        Returns:
        frontchannelLogoutSupported

      • setFrontchannelLogoutSupported

        public void setFrontchannelLogoutSupported​(Boolean frontchannelLogoutSupported)

      • grantTypesSupported

        public WellKnown grantTypesSupported​(List<String> grantTypesSupported)

      • addGrantTypesSupportedItem

        public WellKnown addGrantTypesSupportedItem​(String grantTypesSupportedItem)

      • getGrantTypesSupported

        @Nullable
public List<String> getGrantTypesSupported()
        JSON array containing a list of the OAuth 2.0 Grant Type values that this OP supports.
        Returns:
        grantTypesSupported

      • setGrantTypesSupported

        public void setGrantTypesSupported​(List<String> grantTypesSupported)

      • idTokenSigningAlgValuesSupported

        public WellKnown idTokenSigningAlgValuesSupported​(List<String> idTokenSigningAlgValuesSupported)

      • addIdTokenSigningAlgValuesSupportedItem

        public WellKnown addIdTokenSigningAlgValuesSupportedItem​(String idTokenSigningAlgValuesSupportedItem)

      • getIdTokenSigningAlgValuesSupported

        public List<String> getIdTokenSigningAlgValuesSupported()
        JSON array containing a list of the JWS signing algorithms (alg values) supported by the OP for the ID Token to encode the Claims in a JWT.
        Returns:
        idTokenSigningAlgValuesSupported

      • setIdTokenSigningAlgValuesSupported

        public void setIdTokenSigningAlgValuesSupported​(List<String> idTokenSigningAlgValuesSupported)

      • getIssuer

        public String getIssuer()
        URL using the https scheme with no query or fragment component that the OP asserts as its IssuerURL Identifier. If IssuerURL discovery is supported , this value MUST be identical to the issuer value returned by WebFinger. This also MUST be identical to the iss Claim value in ID Tokens issued from this IssuerURL.
        Returns:
        issuer

      • setIssuer

        public void setIssuer​(String issuer)

      • getJwksUri

        public String getJwksUri()
        URL of the OP's JSON Web Key Set [JWK] document. This contains the signing key(s) the RP uses to validate signatures from the OP. The JWK Set MAY also contain the Server's encryption key(s), which are used by RPs to encrypt requests to the Server. When both signing and encryption keys are made available, a use (Key Use) parameter value is REQUIRED for all keys in the referenced JWK Set to indicate each key's intended usage. Although some algorithms allow the same key to be used for both signatures and encryption, doing so is NOT RECOMMENDED, as it is less secure. The JWK x5c parameter MAY be used to provide X.509 representations of keys provided. When used, the bare key values MUST still be present and MUST match those in the certificate.
        Returns:
        jwksUri

      • setJwksUri

        public void setJwksUri​(String jwksUri)

      • registrationEndpoint

        public WellKnown registrationEndpoint​(String registrationEndpoint)

      • getRegistrationEndpoint

        @Nullable
public String getRegistrationEndpoint()
        URL of the OP's Dynamic Client Registration Endpoint.
        Returns:
        registrationEndpoint

      • setRegistrationEndpoint

        public void setRegistrationEndpoint​(String registrationEndpoint)

      • requestObjectSigningAlgValuesSupported

        public WellKnown requestObjectSigningAlgValuesSupported​(List<String> requestObjectSigningAlgValuesSupported)

      • addRequestObjectSigningAlgValuesSupportedItem

        public WellKnown addRequestObjectSigningAlgValuesSupportedItem​(String requestObjectSigningAlgValuesSupportedItem)

      • getRequestObjectSigningAlgValuesSupported

        @Nullable
public List<String> getRequestObjectSigningAlgValuesSupported()
        JSON array containing a list of the JWS signing algorithms (alg values) supported by the OP for Request Objects, which are described in Section 6.1 of OpenID Connect Core 1.0 [OpenID.Core]. These algorithms are used both when the Request Object is passed by value (using the request parameter) and when it is passed by reference (using the request_uri parameter).
        Returns:
        requestObjectSigningAlgValuesSupported

      • setRequestObjectSigningAlgValuesSupported

        public void setRequestObjectSigningAlgValuesSupported​(List<String> requestObjectSigningAlgValuesSupported)

      • requestParameterSupported

        public WellKnown requestParameterSupported​(Boolean requestParameterSupported)

      • getRequestParameterSupported

        @Nullable
public Boolean getRequestParameterSupported()
        Boolean value specifying whether the OP supports use of the request parameter, with true indicating support.
        Returns:
        requestParameterSupported

      • setRequestParameterSupported

        public void setRequestParameterSupported​(Boolean requestParameterSupported)

      • requestUriParameterSupported

        public WellKnown requestUriParameterSupported​(Boolean requestUriParameterSupported)

      • getRequestUriParameterSupported

        @Nullable
public Boolean getRequestUriParameterSupported()
        Boolean value specifying whether the OP supports use of the request_uri parameter, with true indicating support.
        Returns:
        requestUriParameterSupported

      • setRequestUriParameterSupported

        public void setRequestUriParameterSupported​(Boolean requestUriParameterSupported)

      • requireRequestUriRegistration

        public WellKnown requireRequestUriRegistration​(Boolean requireRequestUriRegistration)

      • getRequireRequestUriRegistration

        @Nullable
public Boolean getRequireRequestUriRegistration()
        Boolean value specifying whether the OP requires any request_uri values used to be pre-registered using the request_uris registration parameter.
        Returns:
        requireRequestUriRegistration

      • setRequireRequestUriRegistration

        public void setRequireRequestUriRegistration​(Boolean requireRequestUriRegistration)

      • responseModesSupported

        public WellKnown responseModesSupported​(List<String> responseModesSupported)

      • addResponseModesSupportedItem

        public WellKnown addResponseModesSupportedItem​(String responseModesSupportedItem)

      • getResponseModesSupported

        @Nullable
public List<String> getResponseModesSupported()
        JSON array containing a list of the OAuth 2.0 response_mode values that this OP supports.
        Returns:
        responseModesSupported

      • setResponseModesSupported

        public void setResponseModesSupported​(List<String> responseModesSupported)

      • responseTypesSupported

        public WellKnown responseTypesSupported​(List<String> responseTypesSupported)

      • addResponseTypesSupportedItem

        public WellKnown addResponseTypesSupportedItem​(String responseTypesSupportedItem)

      • getResponseTypesSupported

        public List<String> getResponseTypesSupported()
        JSON array containing a list of the OAuth 2.0 response_type values that this OP supports. Dynamic OpenID Providers MUST support the code, id_token, and the token id_token Response Type values.
        Returns:
        responseTypesSupported

      • setResponseTypesSupported

        public void setResponseTypesSupported​(List<String> responseTypesSupported)

      • revocationEndpoint

        public WellKnown revocationEndpoint​(String revocationEndpoint)

      • getRevocationEndpoint

        @Nullable
public String getRevocationEndpoint()
        URL of the authorization server's OAuth 2.0 revocation endpoint.
        Returns:
        revocationEndpoint

      • setRevocationEndpoint

        public void setRevocationEndpoint​(String revocationEndpoint)

      • addScopesSupportedItem

        public WellKnown addScopesSupportedItem​(String scopesSupportedItem)

      • getScopesSupported

        @Nullable
public List<String> getScopesSupported()
        SON array containing a list of the OAuth 2.0 [RFC6749] scope values that this server supports. The server MUST support the openid scope value. Servers MAY choose not to advertise some supported scope values even when this parameter is used
        Returns:
        scopesSupported

      • setScopesSupported

        public void setScopesSupported​(List<String> scopesSupported)

      • subjectTypesSupported

        public WellKnown subjectTypesSupported​(List<String> subjectTypesSupported)

      • addSubjectTypesSupportedItem

        public WellKnown addSubjectTypesSupportedItem​(String subjectTypesSupportedItem)

      • getSubjectTypesSupported

        public List<String> getSubjectTypesSupported()
        JSON array containing a list of the Subject Identifier types that this OP supports. Valid types include pairwise and public.
        Returns:
        subjectTypesSupported

      • setSubjectTypesSupported

        public void setSubjectTypesSupported​(List<String> subjectTypesSupported)

      • getTokenEndpoint

        public String getTokenEndpoint()
        URL of the OP's OAuth 2.0 Token Endpoint
        Returns:
        tokenEndpoint

      • setTokenEndpoint

        public void setTokenEndpoint​(String tokenEndpoint)

      • tokenEndpointAuthMethodsSupported

        public WellKnown tokenEndpointAuthMethodsSupported​(List<String> tokenEndpointAuthMethodsSupported)

      • addTokenEndpointAuthMethodsSupportedItem

        public WellKnown addTokenEndpointAuthMethodsSupportedItem​(String tokenEndpointAuthMethodsSupportedItem)

      • getTokenEndpointAuthMethodsSupported

        @Nullable
public List<String> getTokenEndpointAuthMethodsSupported()
        JSON array containing a list of Client Authentication methods supported by this Token Endpoint. The options are client_secret_post, client_secret_basic, client_secret_jwt, and private_key_jwt, as described in Section 9 of OpenID Connect Core 1.0
        Returns:
        tokenEndpointAuthMethodsSupported

      • setTokenEndpointAuthMethodsSupported

        public void setTokenEndpointAuthMethodsSupported​(List<String> tokenEndpointAuthMethodsSupported)

      • userinfoEndpoint

        public WellKnown userinfoEndpoint​(String userinfoEndpoint)

      • getUserinfoEndpoint

        @Nullable
public String getUserinfoEndpoint()
        URL of the OP's UserInfo Endpoint.
        Returns:
        userinfoEndpoint

      • setUserinfoEndpoint

        public void setUserinfoEndpoint​(String userinfoEndpoint)

      • userinfoSigningAlgValuesSupported

        public WellKnown userinfoSigningAlgValuesSupported​(List<String> userinfoSigningAlgValuesSupported)

      • addUserinfoSigningAlgValuesSupportedItem

        public WellKnown addUserinfoSigningAlgValuesSupportedItem​(String userinfoSigningAlgValuesSupportedItem)

      • getUserinfoSigningAlgValuesSupported

        @Nullable
public List<String> getUserinfoSigningAlgValuesSupported()
        JSON array containing a list of the JWS [JWS] signing algorithms (alg values) [JWA] supported by the UserInfo Endpoint to encode the Claims in a JWT [JWT].
        Returns:
        userinfoSigningAlgValuesSupported

      • setUserinfoSigningAlgValuesSupported

        public void setUserinfoSigningAlgValuesSupported​(List<String> userinfoSigningAlgValuesSupported)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object