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

The newest version!



# UserBlock

Describes how the account is blocked from access. If `appliesTo` is `ANY_DEVICES`, then the account is blocked for all devices. If `appliesTo` is `UNKNOWN_DEVICES`, then the account is only blocked for unknown devices.

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**appliesTo** | [**AppliesToEnum**](#AppliesToEnum) | The devices that the block applies to |  [optional] [readonly] |
|**type** | [**TypeEnum**](#TypeEnum) | Type of access block |  [optional] [readonly] |



## Enum: AppliesToEnum

| Name | Value |
|---- | -----|
| ANY_DEVICES | "ANY_DEVICES" |
| UNKNOWN_DEVICES | "UNKNOWN_DEVICES" |
| UNKNOWN_DEFAULT_OPEN_API | "unknown_default_open_api" |



## Enum: TypeEnum

| Name | Value |
|---- | -----|
| DEVICE_BASED | "DEVICE_BASED" |
| UNKNOWN_DEFAULT_OPEN_API | "unknown_default_open_api" |


## Implemented Interfaces

* Serializable