Package org.apereo.cas.configuration.model.support.okta

Class BaseOktaApiProperties

java.lang.Object
org.apereo.cas.configuration.model.support.okta.BaseOktaProperties
org.apereo.cas.configuration.model.support.okta.BaseOktaApiProperties
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
OktaPrincipalAttributesProperties, OktaPrincipalProvisioningProperties
@RequiresModule(name="cas-server-support-okta-authentication") public abstract class BaseOktaApiProperties extends BaseOktaProperties
This is BaseOktaApiProperties.
Since:
7.0.0
See Also:

  • Constructor Details

    • BaseOktaApiProperties

      public BaseOktaApiProperties()

  • Method Details

    • getProxyHost

      public String getProxyHost()
      Send requests via a proxy; define the hostname.
      Overrides:
      getProxyHost in class BaseOktaProperties

    • getProxyPort

      public int getProxyPort()
      Send requests via a proxy; define the proxy port. Negative/zero values should deactivate the proxy configuration for the http client.
      Overrides:
      getProxyPort in class BaseOktaProperties

    • getProxyUsername

      public String getProxyUsername()
      Send requests via a proxy; define the proxy username.
      Overrides:
      getProxyUsername in class BaseOktaProperties

    • getProxyPassword

      public String getProxyPassword()
      Send requests via a proxy; define the proxy password.
      Overrides:
      getProxyPassword in class BaseOktaProperties

    • getPrivateKey

      public SpringResourceProperties getPrivateKey()
      Private key resource used for oauth20 api calls with a client id. When using this approach, you won't need an API Token because the Okta SDK will request an access token for you.

    • getApiToken

      public String getApiToken()
      Okta API token.

    • getClientId

      public String getClientId()
      Okta client id used in combination with the private key.

    • getScopes

      public List<String> getScopes()
      Okta allows you to interact with Okta APIs using scoped OAuth 2.0 access tokens. Each access token enables the bearer to perform specific actions on specific Okta endpoints, with that ability controlled by which scopes the access token contains. Scopes are only used when using client id and private-key.

    • setProxyHost

      public BaseOktaApiProperties setProxyHost(String proxyHost)
      Send requests via a proxy; define the hostname.
      Overrides:
      setProxyHost in class BaseOktaProperties
      Returns:
      this.

    • setProxyPort

      public BaseOktaApiProperties setProxyPort(int proxyPort)
      Send requests via a proxy; define the proxy port. Negative/zero values should deactivate the proxy configuration for the http client.
      Overrides:
      setProxyPort in class BaseOktaProperties
      Returns:
      this.

    • setProxyUsername

      public BaseOktaApiProperties setProxyUsername(String proxyUsername)
      Send requests via a proxy; define the proxy username.
      Overrides:
      setProxyUsername in class BaseOktaProperties
      Returns:
      this.

    • setProxyPassword

      public BaseOktaApiProperties setProxyPassword(String proxyPassword)
      Send requests via a proxy; define the proxy password.
      Overrides:
      setProxyPassword in class BaseOktaProperties
      Returns:
      this.

    • setPrivateKey

      public BaseOktaApiProperties setPrivateKey(SpringResourceProperties privateKey)
      Private key resource used for oauth20 api calls with a client id. When using this approach, you won't need an API Token because the Okta SDK will request an access token for you.
      Returns:
      this.

    • setApiToken

      public BaseOktaApiProperties setApiToken(String apiToken)
      Okta API token.
      Returns:
      this.

    • setClientId

      public BaseOktaApiProperties setClientId(String clientId)
      Okta client id used in combination with the private key.
      Returns:
      this.

    • setScopes

      public BaseOktaApiProperties setScopes(List<String> scopes)
      Okta allows you to interact with Okta APIs using scoped OAuth 2.0 access tokens. Each access token enables the bearer to perform specific actions on specific Okta endpoints, with that ability controlled by which scopes the access token contains. Scopes are only used when using client id and private-key.
      Returns:
      this.