Package | Description |
---|---|
com.okta.sdk.client | |
com.okta.sdk.impl.client |
Modifier and Type | Method and Description |
---|---|
static ClientBuilder |
Clients.builder()
Returns a new
ClientBuilder instance, used to construct ApiClient instances. |
ClientBuilder |
ClientBuilder.setAuthorizationMode(AuthorizationMode authorizationMode)
Overrides the default (very secure)
Okta SSWS Digest
Authentication Scheme used to authenticate every request sent to the Okta API server.
|
ClientBuilder |
ClientBuilder.setCacheManager(CacheManager cacheManager)
Sets the
CacheManager that should be used to cache Okta REST resources, reducing round-trips to the
Okta API server and enhancing application performance. |
ClientBuilder |
ClientBuilder.setClientCredentials(ClientCredentials clientCredentials)
Allows specifying an
ApiKey instance directly instead of relying on the
default location + override/fallback behavior defined in the documentation above . |
ClientBuilder |
ClientBuilder.setClientId(String clientId)
Allows specifying the client ID instead of relying on the default location + override/fallback behavior defined
in the
documentation above . |
ClientBuilder |
ClientBuilder.setConnectionTimeout(int timeout)
Sets both the timeout until a connection is established and the socket timeout (i.e.
|
ClientBuilder |
ClientBuilder.setKid(String kid)
Allows specifying the Key ID (kid) instead of relying on the YAML config.
|
ClientBuilder |
ClientBuilder.setOAuth2AccessToken(String oAuth2AccessToken)
Allows specifying the user obtained OAuth2 access token to be used by the SDK.
|
ClientBuilder |
ClientBuilder.setOrgUrl(String baseUrl)
Sets the base URL of the Okta REST API to use.
|
ClientBuilder |
ClientBuilder.setPrivateKey(InputStream privateKeyInputStream)
Allows specifying the private key (PEM file) path (for private key jwt authentication) directly instead
of relying on the default location + override/fallback behavior defined
in the
documentation above . |
ClientBuilder |
ClientBuilder.setPrivateKey(Path privateKeyPath)
Allows specifying the private key (PEM file) path (for private key jwt authentication) directly instead
of relying on the default location + override/fallback behavior defined
in the
documentation above . |
ClientBuilder |
ClientBuilder.setPrivateKey(PrivateKey privateKey)
Allows specifying the private key (PEM file) path (for private key jwt authentication) directly instead
of relying on the default location + override/fallback behavior defined
in the
documentation above . |
ClientBuilder |
ClientBuilder.setPrivateKey(String privateKey)
Allows specifying the private key (PEM file) path (for private key jwt authentication) directly instead
of relying on the default location + override/fallback behavior defined
in the
documentation above . |
ClientBuilder |
ClientBuilder.setProxy(com.okta.commons.http.config.Proxy proxy)
Sets the HTTP proxy to be used when communicating with the Okta API server.
|
ClientBuilder |
ClientBuilder.setRetryMaxAttempts(int maxAttempts)
Sets the maximum number of attempts to retrying before giving up.
|
ClientBuilder |
ClientBuilder.setRetryMaxElapsed(int maxElapsed)
Sets the maximum number of seconds to wait when retrying before giving up.
|
ClientBuilder |
ClientBuilder.setScopes(Set<String> scopes)
Allows specifying a list of scopes directly instead of relying on the
default location + override/fallback behavior defined in the
documentation above . |
Modifier and Type | Class and Description |
---|---|
class |
DefaultClientBuilder
The default
ClientBuilder implementation. |
Modifier and Type | Method and Description |
---|---|
ClientBuilder |
DefaultClientBuilder.setAuthorizationMode(AuthorizationMode authorizationMode) |
ClientBuilder |
DefaultClientBuilder.setCacheManager(CacheManager cacheManager) |
ClientBuilder |
DefaultClientBuilder.setClientCredentials(ClientCredentials clientCredentials) |
ClientBuilder |
DefaultClientBuilder.setClientId(String clientId) |
ClientBuilder |
DefaultClientBuilder.setConnectionTimeout(int timeout) |
ClientBuilder |
DefaultClientBuilder.setKid(String kid) |
ClientBuilder |
DefaultClientBuilder.setOAuth2AccessToken(String oAuth2AccessToken) |
ClientBuilder |
DefaultClientBuilder.setOrgUrl(String baseUrl) |
ClientBuilder |
DefaultClientBuilder.setPrivateKey(InputStream privateKeyStream) |
ClientBuilder |
DefaultClientBuilder.setPrivateKey(Path privateKeyPath) |
ClientBuilder |
DefaultClientBuilder.setPrivateKey(PrivateKey privateKey) |
ClientBuilder |
DefaultClientBuilder.setPrivateKey(String privateKey) |
ClientBuilder |
DefaultClientBuilder.setProxy(com.okta.commons.http.config.Proxy proxy) |
ClientBuilder |
DefaultClientBuilder.setRetryMaxAttempts(int maxAttempts) |
ClientBuilder |
DefaultClientBuilder.setRetryMaxElapsed(int maxElapsed) |
ClientBuilder |
DefaultClientBuilder.setScopes(Set<String> scopes) |
Copyright © 2017–2023 Okta. All rights reserved.