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 Summary
-
Method Summary
Modifier and TypeMethodDescriptionOkta API token.Okta client id used in combination with the private key.Private key resource used for oauth20 api calls with a client id.Send requests via a proxy; define the hostname.Send requests via a proxy; define the proxy password.int
Send requests via a proxy; define the proxy port.Send requests via a proxy; define the proxy username.Okta allows you to interact with Okta APIs using scoped OAuth 2.0 access tokens.setApiToken
(String apiToken) Okta API token.setClientId
(String clientId) Okta client id used in combination with the private key.setPrivateKey
(SpringResourceProperties privateKey) Private key resource used for oauth20 api calls with a client id.setProxyHost
(String proxyHost) Send requests via a proxy; define the hostname.setProxyPassword
(String proxyPassword) Send requests via a proxy; define the proxy password.setProxyPort
(int proxyPort) Send requests via a proxy; define the proxy port.setProxyUsername
(String proxyUsername) Send requests via a proxy; define the proxy username.Okta allows you to interact with Okta APIs using scoped OAuth 2.0 access tokens.Methods inherited from class org.apereo.cas.configuration.model.support.okta.BaseOktaProperties
getConnectionTimeout, getOrder, getOrganizationUrl, setConnectionTimeout, setOrder, setOrganizationUrl
-
Constructor Details
-
BaseOktaApiProperties
public BaseOktaApiProperties()
-
-
Method Details
-
getProxyHost
Send requests via a proxy; define the hostname.- Overrides:
getProxyHost
in classBaseOktaProperties
-
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 classBaseOktaProperties
-
getProxyUsername
Send requests via a proxy; define the proxy username.- Overrides:
getProxyUsername
in classBaseOktaProperties
-
getProxyPassword
Send requests via a proxy; define the proxy password.- Overrides:
getProxyPassword
in classBaseOktaProperties
-
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
Okta API token. -
getClientId
Okta client id used in combination with the private key. -
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
Send requests via a proxy; define the hostname.- Overrides:
setProxyHost
in classBaseOktaProperties
- Returns:
this
.
-
setProxyPort
Send requests via a proxy; define the proxy port. Negative/zero values should deactivate the proxy configuration for the http client.- Overrides:
setProxyPort
in classBaseOktaProperties
- Returns:
this
.
-
setProxyUsername
Send requests via a proxy; define the proxy username.- Overrides:
setProxyUsername
in classBaseOktaProperties
- Returns:
this
.
-
setProxyPassword
Send requests via a proxy; define the proxy password.- Overrides:
setProxyPassword
in classBaseOktaProperties
- Returns:
this
.
-
setPrivateKey
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
Okta API token.- Returns:
this
.
-
setClientId
Okta client id used in combination with the private key.- Returns:
this
.
-
setScopes
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
.
-