Package sh.ory.hydra.model

Class ConsentRequest

  • @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2021-01-12T16:13:57.119092Z[GMT]")
public class ConsentRequest
extends Object
    ConsentRequest

    • Constructor Detail

      • ConsentRequest

        public ConsentRequest()

    • Method Detail

      • getAcr

        @Nullable
public String getAcr()
        ACR represents the Authentication AuthorizationContext Class Reference value for this authentication session. You can use it to express that, for example, a user authenticated using two factor authentication.
        Returns:
        acr

      • setAcr

        public void setAcr​(String acr)

      • getChallenge

        public String getChallenge()
        ID is the identifier (\"authorization challenge\") of the consent authorization request. It is used to identify the session.
        Returns:
        challenge

      • setChallenge

        public void setChallenge​(String challenge)

      • setClient

        public void setClient​(OAuth2Client client)

      • getContext

        @Nullable
public Object getContext()
        Get context
        Returns:
        context

      • setContext

        public void setContext​(Object context)

      • getLoginChallenge

        @Nullable
public String getLoginChallenge()
        LoginChallenge is the login challenge this consent challenge belongs to. It can be used to associate a login and consent request in the login & consent app.
        Returns:
        loginChallenge

      • setLoginChallenge

        public void setLoginChallenge​(String loginChallenge)

      • getLoginSessionId

        @Nullable
public String getLoginSessionId()
        LoginSessionID is the login session ID. If the user-agent reuses a login session (via cookie / remember flag) this ID will remain the same. If the user-agent did not have an existing authentication session (e.g. remember is false) this will be a new random value. This value is used as the \"sid\" parameter in the ID Token and in OIDC Front-/Back- channel logout. It's value can generally be used to associate consecutive login requests by a certain user.
        Returns:
        loginSessionId

      • setLoginSessionId

        public void setLoginSessionId​(String loginSessionId)

      • getRequestUrl

        @Nullable
public String getRequestUrl()
        RequestURL is the original OAuth 2.0 Authorization URL requested by the OAuth 2.0 client. It is the URL which initiates the OAuth 2.0 Authorization Code or OAuth 2.0 Implicit flow. This URL is typically not needed, but might come in handy if you want to deal with additional request parameters.
        Returns:
        requestUrl

      • setRequestUrl

        public void setRequestUrl​(String requestUrl)

      • requestedAccessTokenAudience

        public ConsentRequest requestedAccessTokenAudience​(List<String> requestedAccessTokenAudience)

      • addRequestedAccessTokenAudienceItem

        public ConsentRequest addRequestedAccessTokenAudienceItem​(String requestedAccessTokenAudienceItem)

      • getRequestedAccessTokenAudience

        @Nullable
public List<String> getRequestedAccessTokenAudience()
        Get requestedAccessTokenAudience
        Returns:
        requestedAccessTokenAudience

      • setRequestedAccessTokenAudience

        public void setRequestedAccessTokenAudience​(List<String> requestedAccessTokenAudience)

      • addRequestedScopeItem

        public ConsentRequest addRequestedScopeItem​(String requestedScopeItem)

      • getRequestedScope

        @Nullable
public List<String> getRequestedScope()
        Get requestedScope
        Returns:
        requestedScope

      • setRequestedScope

        public void setRequestedScope​(List<String> requestedScope)

      • getSkip

        @Nullable
public Boolean getSkip()
        Skip, if true, implies that the client has requested the same scopes from the same user previously. If true, you must not ask the user to grant the requested scopes. You must however either allow or deny the consent request using the usual API call.
        Returns:
        skip

      • setSkip

        public void setSkip​(Boolean skip)

      • getSubject

        @Nullable
public String getSubject()
        Subject is the user ID of the end-user that authenticated. Now, that end user needs to grant or deny the scope requested by the OAuth 2.0 client.
        Returns:
        subject

      • setSubject

        public void setSubject​(String subject)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object