ApiKey class

A resource that can be distributed to callers for executing Method resources that require an API key. API keys can be mapped to any Stage on any RestApi, which indicates that the callers with the API key can make requests to that stage.

Use API Keys

Constructors

ApiKey({DateTime? createdDate, String? customerId, String? description, bool? enabled, String? id, DateTime? lastUpdatedDate, String? name, List<String>? stageKeys, Map<String, String>? tags, String? value})
ApiKey.fromJson(Map<String, dynamic> json)
factory

Properties

createdDate → DateTime?
The timestamp when the API Key was created.
final
customerId → String?
An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
final
description → String?
The description of the API Key.
final
enabled → bool?
Specifies whether the API Key can be used by callers.
final
hashCode → int
The hash code for this object.
no setterinherited
id → String?
The identifier of the API Key.
final
lastUpdatedDate → DateTime?
The timestamp when the API Key was last updated.
final
name → String?
The name of the API Key.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
stageKeys → List<String>?
A list of Stage resources that are associated with the ApiKey resource.
final
tags → Map<String, String>?
The collection of tags. Each tag element is associated with a given resource.
final
value → String?
The value of the API Key.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited