@reactor/auth — apikeysclient
@reactor/auth / ApiKeysClient
Class: ApiKeysClient
Section titled “Class: ApiKeysClient”Defined in: api-keys.ts:16
API keys client for managing user API keys.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ApiKeysClient(
ctx):ApiKeysClient
Defined in: api-keys.ts:17
Parameters
Section titled “Parameters”RequestContext
Returns
Section titled “Returns”ApiKeysClient
Methods
Section titled “Methods”create()
Section titled “create()”create(
params):Promise<Result<any>>
Defined in: api-keys.ts:37
Create a new API key. Returns the full key value only once - store it securely.
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<Result<any>>
list()
Section titled “list()”list(
params?):Promise<Result<ApiKey[]>>
Defined in: api-keys.ts:22
List API keys for the current user.
Parameters
Section titled “Parameters”params?
Section titled “params?”any
Returns
Section titled “Returns”Promise<Result<ApiKey[]>>
revoke()
Section titled “revoke()”revoke(
keyId):Promise<Result<void>>
Defined in: api-keys.ts:44
Revoke an API key.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Result<void>>