Package sh.ory.hydra.model

Class OAuth2Client

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

    • Constructor Detail

      • OAuth2Client

        public OAuth2Client()

    • Method Detail

      • addAllowedCorsOriginsItem

        public OAuth2Client addAllowedCorsOriginsItem​(String allowedCorsOriginsItem)

      • getAllowedCorsOrigins

        @Nullable
public List<String> getAllowedCorsOrigins()
        Get allowedCorsOrigins
        Returns:
        allowedCorsOrigins

      • setAllowedCorsOrigins

        public void setAllowedCorsOrigins​(List<String> allowedCorsOrigins)

      • setAudience

        public void setAudience​(List<String> audience)

      • backchannelLogoutSessionRequired

        public OAuth2Client backchannelLogoutSessionRequired​(Boolean backchannelLogoutSessionRequired)

      • getBackchannelLogoutSessionRequired

        @Nullable
public Boolean getBackchannelLogoutSessionRequired()
        Boolean value specifying whether the RP requires that a sid (session ID) Claim be included in the Logout Token to identify the RP session with the OP when the backchannel_logout_uri is used. If omitted, the default value is false.
        Returns:
        backchannelLogoutSessionRequired

      • setBackchannelLogoutSessionRequired

        public void setBackchannelLogoutSessionRequired​(Boolean backchannelLogoutSessionRequired)

      • backchannelLogoutUri

        public OAuth2Client backchannelLogoutUri​(String backchannelLogoutUri)

      • getBackchannelLogoutUri

        @Nullable
public String getBackchannelLogoutUri()
        RP URL that will cause the RP to log itself out when sent a Logout Token by the OP.
        Returns:
        backchannelLogoutUri

      • setBackchannelLogoutUri

        public void setBackchannelLogoutUri​(String backchannelLogoutUri)

      • getClientId

        @Nullable
public String getClientId()
        ID is the id for this client.
        Returns:
        clientId

      • setClientId

        public void setClientId​(String clientId)

      • getClientName

        @Nullable
public String getClientName()
        Name is the human-readable string name of the client to be presented to the end-user during authorization.
        Returns:
        clientName

      • setClientName

        public void setClientName​(String clientName)

      • getClientSecret

        @Nullable
public String getClientSecret()
        Secret is the client's secret. The secret will be included in the create request as cleartext, and then never again. The secret is stored using BCrypt so it is impossible to recover it. Tell your users that they need to write the secret down as it will not be made available again.
        Returns:
        clientSecret

      • setClientSecret

        public void setClientSecret​(String clientSecret)

      • clientSecretExpiresAt

        public OAuth2Client clientSecretExpiresAt​(Long clientSecretExpiresAt)

      • getClientSecretExpiresAt

        @Nullable
public Long getClientSecretExpiresAt()
        SecretExpiresAt is an integer holding the time at which the client secret will expire or 0 if it will not expire. The time is represented as the number of seconds from 1970-01-01T00:00:00Z as measured in UTC until the date/time of expiration. This feature is currently not supported and it's value will always be set to 0.
        Returns:
        clientSecretExpiresAt

      • setClientSecretExpiresAt

        public void setClientSecretExpiresAt​(Long clientSecretExpiresAt)

      • getClientUri

        @Nullable
public String getClientUri()
        ClientURI is an URL string of a web page providing information about the client. If present, the server SHOULD display this URL to the end-user in a clickable fashion.
        Returns:
        clientUri

      • setClientUri

        public void setClientUri​(String clientUri)

      • setContacts

        public void setContacts​(List<String> contacts)

      • createdAt

        public OAuth2Client createdAt​(org.threeten.bp.OffsetDateTime createdAt)

      • getCreatedAt

        @Nullable
public org.threeten.bp.OffsetDateTime getCreatedAt()
        CreatedAt returns the timestamp of the client's creation.
        Returns:
        createdAt

      • setCreatedAt

        public void setCreatedAt​(org.threeten.bp.OffsetDateTime createdAt)

      • frontchannelLogoutSessionRequired

        public OAuth2Client frontchannelLogoutSessionRequired​(Boolean frontchannelLogoutSessionRequired)

      • getFrontchannelLogoutSessionRequired

        @Nullable
public Boolean getFrontchannelLogoutSessionRequired()
        Boolean value specifying whether the RP requires that iss (issuer) and sid (session ID) query parameters be included to identify the RP session with the OP when the frontchannel_logout_uri is used. If omitted, the default value is false.
        Returns:
        frontchannelLogoutSessionRequired

      • setFrontchannelLogoutSessionRequired

        public void setFrontchannelLogoutSessionRequired​(Boolean frontchannelLogoutSessionRequired)

      • frontchannelLogoutUri

        public OAuth2Client frontchannelLogoutUri​(String frontchannelLogoutUri)

      • getFrontchannelLogoutUri

        @Nullable
public String getFrontchannelLogoutUri()
        RP URL that will cause the RP to log itself out when rendered in an iframe by the OP. An iss (issuer) query parameter and a sid (session ID) query parameter MAY be included by the OP to enable the RP to validate the request and to determine which of the potentially multiple sessions is to be logged out; if either is included, both MUST be.
        Returns:
        frontchannelLogoutUri

      • setFrontchannelLogoutUri

        public void setFrontchannelLogoutUri​(String frontchannelLogoutUri)

      • getGrantTypes

        @Nullable
public List<String> getGrantTypes()
        Get grantTypes
        Returns:
        grantTypes

      • setGrantTypes

        public void setGrantTypes​(List<String> grantTypes)

      • setJwks

        public void setJwks​(Object jwks)

      • getJwksUri

        @Nullable
public String getJwksUri()
        URL for the Client's JSON Web Key Set [JWK] document. If the Client signs requests to the Server, it contains the signing key(s) the Server uses to validate signatures from the Client. The JWK Set MAY also contain the Client's encryption keys(s), which are used by the Server to encrypt responses to the Client. 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)

      • getLogoUri

        @Nullable
public String getLogoUri()
        LogoURI is an URL string that references a logo for the client.
        Returns:
        logoUri

      • setLogoUri

        public void setLogoUri​(String logoUri)

      • getMetadata

        @Nullable
public Object getMetadata()
        Get metadata
        Returns:
        metadata

      • setMetadata

        public void setMetadata​(Object metadata)

      • getOwner

        @Nullable
public String getOwner()
        Owner is a string identifying the owner of the OAuth 2.0 Client.
        Returns:
        owner

      • setOwner

        public void setOwner​(String owner)

      • getPolicyUri

        @Nullable
public String getPolicyUri()
        PolicyURI is a URL string that points to a human-readable privacy policy document that describes how the deployment organization collects, uses, retains, and discloses personal data.
        Returns:
        policyUri

      • setPolicyUri

        public void setPolicyUri​(String policyUri)

      • postLogoutRedirectUris

        public OAuth2Client postLogoutRedirectUris​(List<String> postLogoutRedirectUris)

      • addPostLogoutRedirectUrisItem

        public OAuth2Client addPostLogoutRedirectUrisItem​(String postLogoutRedirectUrisItem)

      • getPostLogoutRedirectUris

        @Nullable
public List<String> getPostLogoutRedirectUris()
        Get postLogoutRedirectUris
        Returns:
        postLogoutRedirectUris

      • setPostLogoutRedirectUris

        public void setPostLogoutRedirectUris​(List<String> postLogoutRedirectUris)

      • addRedirectUrisItem

        public OAuth2Client addRedirectUrisItem​(String redirectUrisItem)

      • getRedirectUris

        @Nullable
public List<String> getRedirectUris()
        Get redirectUris
        Returns:
        redirectUris

      • setRedirectUris

        public void setRedirectUris​(List<String> redirectUris)

      • requestObjectSigningAlg

        public OAuth2Client requestObjectSigningAlg​(String requestObjectSigningAlg)

      • getRequestObjectSigningAlg

        @Nullable
public String getRequestObjectSigningAlg()
        JWS [JWS] alg algorithm [JWA] that MUST be used for signing Request Objects sent to the OP. All Request Objects from this Client MUST be rejected, if not signed with this algorithm.
        Returns:
        requestObjectSigningAlg

      • setRequestObjectSigningAlg

        public void setRequestObjectSigningAlg​(String requestObjectSigningAlg)

      • getRequestUris

        @Nullable
public List<String> getRequestUris()
        Get requestUris
        Returns:
        requestUris

      • setRequestUris

        public void setRequestUris​(List<String> requestUris)

      • addResponseTypesItem

        public OAuth2Client addResponseTypesItem​(String responseTypesItem)

      • getResponseTypes

        @Nullable
public List<String> getResponseTypes()
        Get responseTypes
        Returns:
        responseTypes

      • setResponseTypes

        public void setResponseTypes​(List<String> responseTypes)

      • getScope

        @Nullable
public String getScope()
        Scope is a string containing a space-separated list of scope values (as described in Section 3.3 of OAuth 2.0 [RFC6749]) that the client can use when requesting access tokens.
        Returns:
        scope

      • setScope

        public void setScope​(String scope)

      • sectorIdentifierUri

        public OAuth2Client sectorIdentifierUri​(String sectorIdentifierUri)

      • getSectorIdentifierUri

        @Nullable
public String getSectorIdentifierUri()
        URL using the https scheme to be used in calculating Pseudonymous Identifiers by the OP. The URL references a file with a single JSON array of redirect_uri values.
        Returns:
        sectorIdentifierUri

      • setSectorIdentifierUri

        public void setSectorIdentifierUri​(String sectorIdentifierUri)

      • getSubjectType

        @Nullable
public String getSubjectType()
        SubjectType requested for responses to this Client. The subject_types_supported Discovery parameter contains a list of the supported subject_type values for this server. Valid types include `pairwise` and `public`.
        Returns:
        subjectType

      • setSubjectType

        public void setSubjectType​(String subjectType)

      • tokenEndpointAuthMethod

        public OAuth2Client tokenEndpointAuthMethod​(String tokenEndpointAuthMethod)

      • getTokenEndpointAuthMethod

        @Nullable
public String getTokenEndpointAuthMethod()
        Requested Client Authentication method for the Token Endpoint. The options are client_secret_post, client_secret_basic, private_key_jwt, and none.
        Returns:
        tokenEndpointAuthMethod

      • setTokenEndpointAuthMethod

        public void setTokenEndpointAuthMethod​(String tokenEndpointAuthMethod)

      • tokenEndpointAuthSigningAlg

        public OAuth2Client tokenEndpointAuthSigningAlg​(String tokenEndpointAuthSigningAlg)

      • getTokenEndpointAuthSigningAlg

        @Nullable
public String getTokenEndpointAuthSigningAlg()
        Requested Client Authentication signing algorithm for the Token Endpoint.
        Returns:
        tokenEndpointAuthSigningAlg

      • setTokenEndpointAuthSigningAlg

        public void setTokenEndpointAuthSigningAlg​(String tokenEndpointAuthSigningAlg)

      • getTosUri

        @Nullable
public String getTosUri()
        TermsOfServiceURI is a URL string that points to a human-readable terms of service document for the client that describes a contractual relationship between the end-user and the client that the end-user accepts when authorizing the client.
        Returns:
        tosUri

      • setTosUri

        public void setTosUri​(String tosUri)

      • updatedAt

        public OAuth2Client updatedAt​(org.threeten.bp.OffsetDateTime updatedAt)

      • getUpdatedAt

        @Nullable
public org.threeten.bp.OffsetDateTime getUpdatedAt()
        UpdatedAt returns the timestamp of the last update.
        Returns:
        updatedAt

      • setUpdatedAt

        public void setUpdatedAt​(org.threeten.bp.OffsetDateTime updatedAt)

      • userinfoSignedResponseAlg

        public OAuth2Client userinfoSignedResponseAlg​(String userinfoSignedResponseAlg)

      • getUserinfoSignedResponseAlg

        @Nullable
public String getUserinfoSignedResponseAlg()
        JWS alg algorithm [JWA] REQUIRED for signing UserInfo Responses. If this is specified, the response will be JWT [JWT] serialized, and signed using JWS. The default, if omitted, is for the UserInfo Response to return the Claims as a UTF-8 encoded JSON object using the application/json content-type.
        Returns:
        userinfoSignedResponseAlg

      • setUserinfoSignedResponseAlg

        public void setUserinfoSignedResponseAlg​(String userinfoSignedResponseAlg)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object