docs.ProtocolOAuth.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: 23.0.1

Show newest version



# ProtocolOAuth

Protocol settings for authentication using the [OAuth 2.0 Authorization Code flow](https://tools.ietf.org/html/rfc6749#section-4.1)

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**credentials** | [**OAuthCredentials**](OAuthCredentials.md) |  |  [optional] |
|**endpoints** | [**OAuthEndpoints**](OAuthEndpoints.md) |  |  [optional] |
|**scopes** | **List<String>** | IdP-defined permission bundles to request delegated access from the User > **Note:** The [Identity Provider type](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/IdentityProvider/#tag/IdentityProvider/operation/createIdentityProvider!path=type&t=request) table lists the scopes that are supported for each Identity Provider. |  [optional] |
|**type** | [**TypeEnum**](#TypeEnum) | OAuth 2.0 Authorization Code flow |  [optional] |



## Enum: TypeEnum

| Name | Value |
|---- | -----|
| OAUTH2 | "OAUTH2" |
| UNKNOWN_DEFAULT_OPEN_API | "unknown_default_open_api" |


## Implemented Interfaces

* Serializable