Class AuthorizationServerContractProperties

    • Constructor Detail

      • AuthorizationServerContractProperties

        public AuthorizationServerContractProperties()
    • Method Detail

      • displayName

        public String displayName()
        Get the displayName property: User-friendly authorization server name.
        Returns:
        the displayName value.
      • withDisplayName

        public AuthorizationServerContractProperties withDisplayName​(String displayName)
        Set the displayName property: User-friendly authorization server name.
        Parameters:
        displayName - the displayName value to set.
        Returns:
        the AuthorizationServerContractProperties object itself.
      • clientRegistrationEndpoint

        public String clientRegistrationEndpoint()
        Get the clientRegistrationEndpoint property: Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced.
        Returns:
        the clientRegistrationEndpoint value.
      • withClientRegistrationEndpoint

        public AuthorizationServerContractProperties withClientRegistrationEndpoint​(String clientRegistrationEndpoint)
        Set the clientRegistrationEndpoint property: Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced.
        Parameters:
        clientRegistrationEndpoint - the clientRegistrationEndpoint value to set.
        Returns:
        the AuthorizationServerContractProperties object itself.
      • authorizationEndpoint

        public String authorizationEndpoint()
        Get the authorizationEndpoint property: OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.
        Returns:
        the authorizationEndpoint value.
      • withAuthorizationEndpoint

        public AuthorizationServerContractProperties withAuthorizationEndpoint​(String authorizationEndpoint)
        Set the authorizationEndpoint property: OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.
        Parameters:
        authorizationEndpoint - the authorizationEndpoint value to set.
        Returns:
        the AuthorizationServerContractProperties object itself.
      • grantTypes

        public List<GrantType> grantTypes()
        Get the grantTypes property: Form of an authorization grant, which the client uses to request the access token.
        Returns:
        the grantTypes value.
      • withGrantTypes

        public AuthorizationServerContractProperties withGrantTypes​(List<GrantType> grantTypes)
        Set the grantTypes property: Form of an authorization grant, which the client uses to request the access token.
        Parameters:
        grantTypes - the grantTypes value to set.
        Returns:
        the AuthorizationServerContractProperties object itself.
      • clientId

        public String clientId()
        Get the clientId property: Client or app id registered with this authorization server.
        Returns:
        the clientId value.
      • withClientId

        public AuthorizationServerContractProperties withClientId​(String clientId)
        Set the clientId property: Client or app id registered with this authorization server.
        Parameters:
        clientId - the clientId value to set.
        Returns:
        the AuthorizationServerContractProperties object itself.
      • clientSecret

        public String clientSecret()
        Get the clientSecret property: Client or app secret registered with this authorization server. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
        Returns:
        the clientSecret value.
      • withClientSecret

        public AuthorizationServerContractProperties withClientSecret​(String clientSecret)
        Set the clientSecret property: Client or app secret registered with this authorization server. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
        Parameters:
        clientSecret - the clientSecret value to set.
        Returns:
        the AuthorizationServerContractProperties object itself.
      • withClientAuthenticationMethod

        public AuthorizationServerContractProperties withClientAuthenticationMethod​(List<ClientAuthenticationMethod> clientAuthenticationMethod)
        Set the clientAuthenticationMethod property: Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format.
        Overrides:
        withClientAuthenticationMethod in class AuthorizationServerContractBaseProperties
        Parameters:
        clientAuthenticationMethod - the clientAuthenticationMethod value to set.
        Returns:
        the AuthorizationServerContractBaseProperties object itself.
      • withSupportState

        public AuthorizationServerContractProperties withSupportState​(Boolean supportState)
        Set the supportState property: If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security.
        Overrides:
        withSupportState in class AuthorizationServerContractBaseProperties
        Parameters:
        supportState - the supportState value to set.
        Returns:
        the AuthorizationServerContractBaseProperties object itself.
      • withDefaultScope

        public AuthorizationServerContractProperties withDefaultScope​(String defaultScope)
        Set the defaultScope property: Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values.
        Overrides:
        withDefaultScope in class AuthorizationServerContractBaseProperties
        Parameters:
        defaultScope - the defaultScope value to set.
        Returns:
        the AuthorizationServerContractBaseProperties object itself.
      • withResourceOwnerUsername

        public AuthorizationServerContractProperties withResourceOwnerUsername​(String resourceOwnerUsername)
        Set the resourceOwnerUsername property: Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.
        Overrides:
        withResourceOwnerUsername in class AuthorizationServerContractBaseProperties
        Parameters:
        resourceOwnerUsername - the resourceOwnerUsername value to set.
        Returns:
        the AuthorizationServerContractBaseProperties object itself.
      • withResourceOwnerPassword

        public AuthorizationServerContractProperties withResourceOwnerPassword​(String resourceOwnerPassword)
        Set the resourceOwnerPassword property: Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.
        Overrides:
        withResourceOwnerPassword in class AuthorizationServerContractBaseProperties
        Parameters:
        resourceOwnerPassword - the resourceOwnerPassword value to set.
        Returns:
        the AuthorizationServerContractBaseProperties object itself.