Skip to content

Latest commit

 

History

History
51 lines (42 loc) · 3.68 KB

APIKeyCreateResponse.md

File metadata and controls

51 lines (42 loc) · 3.68 KB

APIKeyCreateResponse

API key response including the plaintext secret.

Properties

Name Type Description Notes
key_id str Public identifier for the API key. [optional]
key_hash str SHA-256 hash of the plaintext key.
key_prefix str Visible prefix of the API key for user identification (e.g., 'sk_abc123...'). Shows the first 10 characters of the plaintext key to help users identify which key is which in lists, without exposing the full secret. This follows industry best practices from GitHub, Stripe, and AWS. Generated automatically for new keys. Older keys may not have this field. [optional]
key_type APIKeyType Type of API key. STANDARD for regular organization keys, MARKETPLACE_SUBSCRIPTION for marketplace subscription access tokens. [optional]
subscription_id str Marketplace subscription ID if this is a marketplace subscription key. Only set when key_type is MARKETPLACE_SUBSCRIPTION. [optional]
internal_id str Organization internal identifier.
organization_id str Organization public identifier (denormalized). [optional]
user_id str Identifier of the user who owns the key.
name str Human-friendly key label.
description str Optional description explaining the key usage. [optional] [default to '']
permissions List[Permission] Permissions granted to the key (least privilege recommended). [optional]
scopes List[ResourceScopeOutput] Resource-level scopes restricting the key. [optional]
rate_limit_override int Optional per-key rate limit override in requests per minute. [optional]
status KeyStatus Lifecycle status of the key (active, revoked, expired). [optional]
expires_at datetime UTC timestamp when the key automatically expires. [optional]
last_used_at datetime UTC timestamp of the last successful request using the key. [optional]
created_at datetime UTC timestamp when the key was created. [optional]
created_by str User identifier that created the key. [optional]
revoked_at datetime UTC timestamp when the key was revoked (if applicable). [optional]
revoked_by str User identifier that revoked the key (if applicable). [optional]
allowed_origins List[str] Optional list of allowed HTTP origins for this API key. When set, requests must include an Origin header matching one of these values. Supports exact matches (e.g., 'https://docs.example.com') and wildcard subdomains (e.g., 'https://*.example.com'). Only enforced for browser requests (defense-in-depth, not a security boundary). Null means no origin restriction. [optional]
key str

Example

from mixpeek.models.api_key_create_response import APIKeyCreateResponse

# TODO update the JSON string below
json = "{}"
# create an instance of APIKeyCreateResponse from a JSON string
api_key_create_response_instance = APIKeyCreateResponse.from_json(json)
# print the JSON string representation of the object
print(APIKeyCreateResponse.to_json())

# convert the object into a dict
api_key_create_response_dict = api_key_create_response_instance.to_dict()
# create an instance of APIKeyCreateResponse from a dict
api_key_create_response_from_dict = APIKeyCreateResponse.from_dict(api_key_create_response_dict)

[Back to Model list] [Back to API list] [Back to README]