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



# OAuth2Claim


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**alwaysIncludeInToken** | **Boolean** | Specifies whether to include Claims in the token. The value is always `TRUE` for access token Claims. If the value is set to `FALSE` for an ID token claim, the Claim isn't included in the ID token when the token is requested with the access token or with the `authorization_code`. The client instead uses the access token to get Claims from the `/userinfo` endpoint. |  [optional] |
|**claimType** | **OAuth2ClaimType** |  |  [optional] |
|**conditions** | [**OAuth2ClaimConditions**](OAuth2ClaimConditions.md) |  |  [optional] |
|**groupFilterType** | **OAuth2ClaimGroupFilterType** |  |  [optional] |
|**id** | **String** | ID of the Claim |  [optional] [readonly] |
|**name** | **String** | Name of the Claim |  [optional] |
|**status** | **LifecycleStatus** |  |  [optional] |
|**system** | **Boolean** | When `true`, indicates that Okta created the Claim |  [optional] |
|**value** | **String** | Specifies the value of the Claim. This value must be a string literal if `valueType` is `GROUPS`, and the string literal is matched with the selected `group_filter_type`. The value must be an Okta EL expression if `valueType` is `EXPRESSION`. |  [optional] |
|**valueType** | **OAuth2ClaimValueType** |  |  [optional] |
|**links** | [**LinksSelf**](LinksSelf.md) |  |  [optional] |


## Implemented Interfaces

* Serializable