EndpointApiKey class Endpoint

API key management for machine access.

Inheritance

• Object
• EndpointRef
• EndpointApiKey

Constructors

EndpointApiKey(EndpointCaller caller)

Properties

caller → EndpointCaller

Holds a reference to the caller class.

final, inherited

client ↔ ServerpodClientShared

Reference to the client.

late, final, inherited

hashCode → int

The hash code for this object.

no setter, inherited

name → String

The name of the endpoint this reference is connected to.

no setter, override

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

create({UuidValue? workspaceId, required String label, required List<ApiScope> scopes, required int rateLimitPerMinute}) → Future<ApiKeySecret>

Creates a key. The secret is returned exactly once.

list({UuidValue? workspaceId}) → Future<List<ApiKey>>

Lists keys without their hashes.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

revoke({UuidValue? workspaceId, required UuidValue apiKeyId}) → Future<ApiKey>

Revokes a key immediately.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited