docs.Client.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



# Client


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**applicationType** | **ApplicationType** |  |  [optional] |
|**clientId** | **String** | Unique key for the client application. The `client_id` is immutable. When you create a client Application, you can't specify the `client_id` because Okta uses the application ID for the `client_id`. |  [optional] [readonly] |
|**clientIdIssuedAt** | **Integer** | Time at which the `client_id` was issued (measured in unix seconds) |  [optional] [readonly] |
|**clientName** | **String** | Human-readable string name of the client application |  [optional] |
|**clientSecret** | **String** | OAuth 2.0 client secret string (used for confidential clients). The `client_secret` is shown only on the response of the creation or update of a client Application (and only if the `token_endpoint_auth_method` is one that requires a client secret). You can't specify the `client_secret`. If the `token_endpoint_auth_method` requires one, Okta generates a random `client_secret` for the client Application. |  [optional] [readonly] |
|**clientSecretExpiresAt** | **Integer** | Time at which the `client_secret` expires or 0 if it doesn't expire (measured in unix seconds) |  [optional] [readonly] |
|**frontchannelLogoutSessionRequired** | **Boolean** | Include user session details |  [optional] |
|**frontchannelLogoutUri** | **String** | URL where Okta sends the logout request |  [optional] |
|**grantTypes** | **List<GrantType>** | Array of OAuth 2.0 grant type strings. Default value: `[authorization_code]` |  [optional] |
|**initiateLoginUri** | **String** | URL that a third party can use to initiate a login by the client |  [optional] |
|**jwksUri** | **String** | URL string that references a [JSON Web Key Set](https://tools.ietf.org/html/rfc7517#section-5) for validating JWTs presented to Okta |  [optional] |
|**logoUri** | **String** | URL string that references a logo for the client consent dialog (not the sign-in dialog) |  [optional] |
|**policyUri** | **String** | URL string of a web page providing the client's policy document |  [optional] |
|**postLogoutRedirectUris** | **List<String>** | Array of redirection URI strings for use for relying party initiated logouts |  [optional] |
|**redirectUris** | **List<String>** | Array of redirection URI strings for use in redirect-based flows. All redirect URIs must be absolute URIs and must not include a fragment component. At least one redirect URI and response type is required for all client types, with the following exceptions: If the client uses the Resource Owner Password flow (if `grant_type` contains the value password) or the Client Credentials flow (if `grant_type` contains the value `client_credentials`), then no redirect URI or response type is necessary. In these cases, you can pass either null or an empty array for these attributes. |  [optional] |
|**requestObjectSigningAlg** | **List<SigningAlgorithm>** | The type of [JSON Web Key Set](https://tools.ietf.org/html/rfc7517#section-5) algorithm that must be used for signing request objects |  [optional] |
|**responseTypes** | **List<ResponseType>** | Array of OAuth 2.0 response type strings. Default value: `[code]` |  [optional] |
|**tokenEndpointAuthMethod** | **EndpointAuthMethod** |  |  [optional] |
|**tosUri** | **String** | URL string of a web page providing the client's terms of service document |  [optional] |


## Implemented Interfaces

* Serializable