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



# LogClient

When an event is triggered by an HTTP request, the `client` object describes the [client](https://datatracker.ietf.org/doc/html/rfc2616) that issues the HTTP request. For instance, the web browser is the client when a user accesses Okta. When this request is received and processed, a sign-in event is fired. When the event isn't sourced to an HTTP request, such as an automatic update, the `client` object field is blank.

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**device** | **String** | Type of device that the client operates from (for example, computer) |  [optional] [readonly] |
|**geographicalContext** | [**LogGeographicalContext**](LogGeographicalContext.md) |  |  [optional] |
|**id** | **String** | For OAuth requests, this is the ID of the OAuth [client](https://datatracker.ietf.org/doc/html/rfc6749#section-1.1) making the request. For SSWS token requests, this is the ID of the agent making the request. |  [optional] [readonly] |
|**ipAddress** | **String** | IP address that the client is making its request from |  [optional] [readonly] |
|**userAgent** | [**LogUserAgent**](LogUserAgent.md) |  |  [optional] |
|**zone** | **String** | The `name` of the [Zone](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/NetworkZone/#tag/NetworkZone/operation/getNetworkZone) that the client's location is mapped to |  [optional] [readonly] |


## Implemented Interfaces

* Serializable