Agent Maturity Compass API - v1.2.0
Guides
HTTP API
GitHub
Preparing search index...
index
ApiKeyManager
Class ApiKeyManager
Index
Constructors
constructor
Methods
authenticate
create
Key
get
Key
get
Usage
Summary
list
Keys
record
Usage
record
Usage
For
Api
Key
revoke
Key
rotate
Key
to
Snapshot
from
Snapshot
Constructors
constructor
new
ApiKeyManager
()
:
ApiKeyManager
Returns
ApiKeyManager
Methods
authenticate
authenticate
(
params
:
{
apiKey
:
string
;
nowTs
?:
number
;
requiredScope
?:
"write"
|
"admin"
|
"read-only"
;
}
,
)
:
ApiKeyAuthResult
Parameters
params
:
{
apiKey
:
string
;
nowTs
?:
number
;
requiredScope
?:
"write"
|
"admin"
|
"read-only"
;
}
Returns
ApiKeyAuthResult
create
Key
createKey
(
params
:
{
expiresInMs
?:
number
;
label
?:
string
;
nowTs
?:
number
;
scope
:
"write"
|
"admin"
|
"read-only"
;
}
,
)
:
ApiKeyIssueResult
Parameters
params
:
{
expiresInMs
?:
number
;
label
?:
string
;
nowTs
?:
number
;
scope
:
"write"
|
"admin"
|
"read-only"
;
}
Returns
ApiKeyIssueResult
get
Key
getKey
(
keyId
:
string
)
:
ApiKeyRecord
|
null
Parameters
keyId
:
string
Returns
ApiKeyRecord
|
null
get
Usage
Summary
getUsageSummary
(
keyId
:
string
)
:
ApiKeyUsageSummary
Parameters
keyId
:
string
Returns
ApiKeyUsageSummary
list
Keys
listKeys
()
:
ApiKeyRecord
[]
Returns
ApiKeyRecord
[]
record
Usage
recordUsage
(
params
:
{
endpoint
:
string
;
keyId
:
string
;
latencyMs
?:
number
;
method
:
string
;
statusCode
:
number
;
ts
?:
number
;
}
,
)
:
ApiKeyUsageEvent
Parameters
params
:
{
endpoint
:
string
;
keyId
:
string
;
latencyMs
?:
number
;
method
:
string
;
statusCode
:
number
;
ts
?:
number
;
}
Returns
ApiKeyUsageEvent
record
Usage
For
Api
Key
recordUsageForApiKey
(
params
:
{
apiKey
:
string
;
endpoint
:
string
;
latencyMs
?:
number
;
method
:
string
;
statusCode
:
number
;
ts
?:
number
;
}
,
)
:
ApiKeyUsageEvent
Parameters
params
:
{
apiKey
:
string
;
endpoint
:
string
;
latencyMs
?:
number
;
method
:
string
;
statusCode
:
number
;
ts
?:
number
;
}
Returns
ApiKeyUsageEvent
revoke
Key
revokeKey
(
params
:
{
keyId
:
string
;
nowTs
?:
number
}
)
:
ApiKeyRecord
Parameters
params
:
{
keyId
:
string
;
nowTs
?:
number
}
Returns
ApiKeyRecord
rotate
Key
rotateKey
(
params
:
{
expiresInMs
?:
number
;
gracePeriodMs
:
number
;
keyId
:
string
;
nowTs
?:
number
;
}
,
)
:
ApiKeyRotateResult
Parameters
params
:
{
expiresInMs
?:
number
;
gracePeriodMs
:
number
;
keyId
:
string
;
nowTs
?:
number
}
Returns
ApiKeyRotateResult
to
Snapshot
toSnapshot
()
:
ApiKeyStoreSnapshot
Returns
ApiKeyStoreSnapshot
Static
from
Snapshot
fromSnapshot
(
snapshot
:
ApiKeyStoreSnapshot
)
:
ApiKeyManager
Parameters
snapshot
:
ApiKeyStoreSnapshot
Returns
ApiKeyManager
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
authenticate
create
Key
get
Key
get
Usage
Summary
list
Keys
record
Usage
record
Usage
For
Api
Key
revoke
Key
rotate
Key
to
Snapshot
from
Snapshot
Guides
HTTP API
GitHub
Agent Maturity Compass API - v1.2.0
Loading...