Sha256: 5051ccdef1b74c1b1f174a546bbced10176435addb2be2cb56fba78036e39b1b

Contents?: true

Size: 1.65 KB

Versions: 3

Compression:

Stored size: 1.65 KB

Contents

# TalonOne::CreateApplicationAPIKey

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**title** | **String** | Title of the API key. | 
**expires** | **DateTime** | The date the API key expires. | 
**platform** | **String** | The third-party platform the API key is valid for. Use `none` for a generic API key to be used from your own integration layer.  | [optional] 
**type** | **String** | The API key type. Can be empty or `staging`.  Staging API keys can only be used for dry requests with the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint, [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint, and [Track event](https://docs.talon.one/integration-api#tag/Events/operation/trackEventV2) endpoint.  When using the _Update customer profile_ endpoint with a staging API key, the query parameter `runRuleEngine` must be `true`.  | [optional] 
**time_offset** | **Integer** | A time offset in nanoseconds associated with the API key. When making a request using the API key, rule evaluation is based on a date that is calculated by adding the offset to the current date.  | [optional] 

## Code Sample

```ruby
require 'TalonOne'

instance = TalonOne::CreateApplicationAPIKey.new(title: My generated key,
                                 expires: 2023-08-24T14:00Z,
                                 platform: none,
                                 type: staging,
                                 time_offset: 100000)
```


Version data entries

3 entries across 3 versions & 1 rubygems

Version Path
talon_one-7.0.0 docs/CreateApplicationAPIKey.md
talon_one-6.0.0 docs/CreateApplicationAPIKey.md
talon_one-5.0.0 docs/CreateApplicationAPIKey.md