docs.OAuthCredentialsClient.md Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of okta-sdk-api Show documentation

The Okta Java SDK API .jar provides a Java API that your code can use to make calls to the Okta API. This .jar is the only compile-time dependency within the Okta SDK project that your code should depend on. Implementations of this API (implementation .jars) should be runtime dependencies only.

There is a newer version: 21.0.0

Show newest version



# OAuthCredentialsClient

OAuth 2.0 and OpenID Connect Client object > **Note:** You must complete client registration with the IdP Authorization Server for your Okta IdP instance to obtain client credentials.

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**clientId** | **String** | The [Unique identifier](https://tools.ietf.org/html/rfc6749#section-2.2) issued by the AS for the Okta IdP instance |  [optional] |
|**clientSecret** | **String** | The [Client secret](https://tools.ietf.org/html/rfc6749#section-2.3.1) issued by the AS for the Okta IdP instance |  [optional] |
|**pkceRequired** | **Boolean** | Require Proof Key for Code Exchange (PKCE) for additional verification |  [optional] |
|**tokenEndpointAuthMethod** | [**TokenEndpointAuthMethodEnum**](#TokenEndpointAuthMethodEnum) | Client authentication methods supported by the token endpoint |  [optional] |



## Enum: TokenEndpointAuthMethodEnum

| Name | Value |
|---- | -----|
| PRIVATE_KEY_JWT | "private_key_jwt" |
| UNKNOWN_DEFAULT_OPEN_API | "unknown_default_open_api" |


## Implemented Interfaces

* Serializable