CreateApiKeyRequest.md

Zernio::CreateApiKeyRequest

Properties

Name	Type	Description	Notes
name	String
expires_in	Integer	Days until expiry	[optional]
scope	String	'full' grants access to all profiles (default), 'profiles' restricts to specific profiles	[optional][default to 'full']
profile_ids	Array<String>	Profile IDs this key can access. Required when scope is 'profiles'.	[optional]
permission	String	'read-write' allows all operations (default), 'read' restricts to GET requests only	[optional][default to 'read-write']
disabled_resource_groups	Array<String>	Resource groups to DISABLE on this key (opt-out denylist). Omit for a legacy full-access key. A key with any group disabled mints with the zrk_ prefix, gets 403 with code=insufficient_permissions and required_group on operations in disabled groups (each operation's group is published as x-resource-group), and can never manage API keys, invites, or member identity. With 'messages' disabled, the key cannot read or send private messages through any API surface and cannot create or edit a webhook subscription broader than itself. Subscriptions that already exist are governed by their own `disabledResourceGroups`, not by this key's. OAuth connector tokens resolve against the same registry, but their groups are not settable yet.	[optional]

Example

require 'zernio-sdk'

instance = Zernio::CreateApiKeyRequest.new(
  name: null,
  expires_in: null,
  scope: null,
  profile_ids: null,
  permission: null,
  disabled_resource_groups: null
)