Skip to main content

autessa.keys

API keys and poweruser key management.

autessa.keys.createMUTATE

autessa.keys.create({ apiKey })

Create a new API key and return its one-time secret value.

Mints a secret and returns it once as keyValue (formatted keyId:secret) — it is never retrievable again, so capture it immediately. The apiKey field carries the desired configuration (name, rate limits, allowed origins, allResources or scoped permissions); isSystemKey is always forced false and cannot be set. Origins must be well-formed and rate limits positive, or the call returns errors. A key acting as another user requires Admin.

Request fields

  • Name
    apiKey
    Type
    ApiKeyDto
    Description

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    keyValue
    Type
    string
    Description
  • Name
    apiKey
    Type
    ApiKeyDto
    Description

autessa.keys.deleteMUTATE

autessa.keys.delete({ apiKeyId })

Permanently delete a (disabled) API key.

Irreversible. The key must already be disabled — deleting an enabled key returns an error, so call keys.disable first. Scoped to your company; an id outside it reports as not found.

Request fields

  • Name
    apiKeyId
    Type
    string
    Description

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    deleted
    Type
    boolean
    Description

autessa.keys.disableMUTATE

autessa.keys.disable({ apiKeyId })

Disable (deactivate) an API key so it authenticates to nothing.

Flips isEnabled to false; the key stops working immediately but is not deleted. A key must be disabled before it can be deleted with keys.delete.

Request fields

  • Name
    apiKeyId
    Type
    string
    Description

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    apiKey
    Type
    ApiKeyDto
    Description

autessa.keys.enableMUTATE

autessa.keys.enable({ apiKeyId })

Enable (activate) an API key so it can authenticate again.

Flips isEnabled to true. A newly enabled key authenticates with whatever secret it already has — enabling does not mint a new secret.

Request fields

  • Name
    apiKeyId
    Type
    string
    Description

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    apiKey
    Type
    ApiKeyDto
    Description

autessa.keys.getREAD

autessa.keys.get({ apiKeyId })

Fetch a single API key's configuration by id.

Returns the key's configuration (never the secret). Scoped to your company: a key id outside your company, or the backend system key when you are not an Admin, reports as not found.

Request fields

  • Name
    apiKeyId
    Type
    string
    Description

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    apiKey
    Type
    ApiKeyDto
    Description

autessa.keys.getAllREAD

autessa.keys.getAll()

List every API key in the current company.

Returns all keys in your company (secrets never included). The backend system key is omitted unless you are an Admin. Not paginated.

Request fields

No fields.

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    apiKeys
    Type
    ApiKeyDto[]
    Description

autessa.keys.permissions.addGroupMUTATE

autessa.keys.permissions.addGroup({ apiKeyId, permissions })

Grant a whole permission group (a resource type plus a set of resource ids) to a key in one call.

Adds the given ApiPermissionsDto (resourceType + resourceIds) to the key's scoped permissions. No-op if the key has allResources = true (it already sees everything). Widens the key's reach, so treat with care.

Request fields

  • Name
    apiKeyId
    Type
    string
    Description
  • Name
    permissions
    Type
    ApiPermissionsDto
    Description

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    apiKey
    Type
    ApiKeyDto
    Description

autessa.keys.permissions.addResourceMUTATE

autessa.keys.permissions.addResource({ apiKeyId, resourceType, resourceId })

Grant a key access to one specific resource (a single resourceType + resourceId).

Adds a single resource grant, skipping it if the key already has it. No-op if the key has allResources = true. Widens the key's reach — use setAllForType to grant the whole type instead of enumerating ids.

Request fields

  • Name
    apiKeyId
    Type
    string
    Description
  • Name
    resourceType
    Type
    "TOOL" | "AGENT" | "MANAGER" | "AUTESSADB" | "CUSTOM_WEBHOOK" | "ESIGNATURE_ENVELOPE"
    Description
  • Name
    resourceId
    Type
    string
    Description

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    apiKey
    Type
    ApiKeyDto
    Description

autessa.keys.permissions.deleteSpecificMUTATE

autessa.keys.permissions.deleteSpecific({ apiKeyId, resourceType, resourceId })

Revoke a key's grant to one specific resource (a single resourceType + resourceId).

Removes exactly one per-resource grant, narrowing the key's access. Returns deleted = false if no such grant existed.

Request fields

  • Name
    apiKeyId
    Type
    string
    Description
  • Name
    resourceType
    Type
    "TOOL" | "AGENT" | "MANAGER" | "AUTESSADB" | "CUSTOM_WEBHOOK" | "ESIGNATURE_ENVELOPE"
    Description
  • Name
    resourceId
    Type
    string
    Description

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    deleted
    Type
    boolean
    Description

autessa.keys.permissions.esignature.grantMUTATE

autessa.keys.permissions.esignature.grant({ apiKeyId, envelopeId, level })

Grant or overwrite a key's access level on one e-signature envelope.

Sets the key's access level for the given envelope in its e-signature metadata (envelopes use UUID ids and a four-level ladder, so they live outside the resource-id permission table). envelopeId must be a valid UUID and level is required, or the call returns errors. Widens the key's reach over signed documents.

Request fields

  • Name
    apiKeyId
    Type
    string
    Description
  • Name
    envelopeId
    Type
    string
    Description
  • Name
    level
    Type
    "READ" | "WRITE" | "PUBLISH" | "ADMIN"
    Description

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    apiKey
    Type
    ApiKeyDto
    Description

autessa.keys.permissions.esignature.revokeMUTATE

autessa.keys.permissions.esignature.revoke({ apiKeyId, envelopeId })

Revoke a key's access to one e-signature envelope.

Removes the key's per-envelope grant from its e-signature metadata, narrowing its access. envelopeId must be a valid UUID, or the call returns errors.

Request fields

  • Name
    apiKeyId
    Type
    string
    Description
  • Name
    envelopeId
    Type
    string
    Description

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    apiKey
    Type
    ApiKeyDto
    Description

autessa.keys.permissions.removeAllForTypeMUTATE

autessa.keys.permissions.removeAllForType({ apiKeyId, resourceType })

Revoke all of a key's grants for one resource type (both per-id and wildcard).

Deletes every permission the key holds for resourceType, narrowing its access. Scoped to your company; an id outside it reports removed = false.

Request fields

  • Name
    apiKeyId
    Type
    string
    Description
  • Name
    resourceType
    Type
    "TOOL" | "AGENT" | "MANAGER" | "AUTESSADB" | "CUSTOM_WEBHOOK" | "ESIGNATURE_ENVELOPE"
    Description

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    removed
    Type
    boolean
    Description

autessa.keys.permissions.setAllForTypeMUTATE

autessa.keys.permissions.setAllForType({ apiKeyId, resourceType })

Grant a key access to ALL current and future resources of one type, replacing any per-id grants for that type.

Deletes the key's existing per-id grants for resourceType and installs a single wildcard grant covering every resource of that type — including ones created later. This meaningfully widens the key's blast radius; prefer addResource when only specific resources are intended.

Request fields

  • Name
    apiKeyId
    Type
    string
    Description
  • Name
    resourceType
    Type
    "TOOL" | "AGENT" | "MANAGER" | "AUTESSADB" | "CUSTOM_WEBHOOK" | "ESIGNATURE_ENVELOPE"
    Description

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    apiKey
    Type
    ApiKeyDto
    Description

autessa.keys.refreshMUTATE

autessa.keys.refresh({ apiKeyId })

Rotate an API key's secret, returning the new one-time value and invalidating the old one.

Mints a fresh secret for the same key id and returns it once as keyValue (keyId:secret) — capture it immediately, it cannot be retrieved again. The previous secret stops working the moment this succeeds, so update every caller.

Request fields

  • Name
    apiKeyId
    Type
    string
    Description

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    keyValue
    Type
    string
    Description
  • Name
    apiKey
    Type
    ApiKeyDto
    Description

autessa.keys.transactions.historyREAD

autessa.keys.transactions.history({ apiKeyId, startDate, endDate, page })

List a key's request history, newest first, one fixed-size page at a time (page is 0-based).

Returns the key's logged requests, optionally bounded by startDate/endDate. Page through with hasNext/totalPages. Each entry includes the endpoint, status code, latency, and a 500-character request preview.

Request fields

  • Name
    apiKeyId
    Type
    string
    Description
  • Name
    startDate
    Type
    string (ISO 8601)
    Description
  • Name
    endDate
    Type
    string (ISO 8601)
    Description
  • Name
    page
    Type
    number
    Description

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    transactions
    Type
    TransactionHistoryDto[]
    Description
  • Name
    totalElements
    Type
    number
    Description
  • Name
    totalPages
    Type
    number
    Description
  • Name
    currentPage
    Type
    number
    Description
  • Name
    pageSize
    Type
    number
    Description
  • Name
    hasNext
    Type
    boolean
    Description
  • Name
    hasPrevious
    Type
    boolean
    Description

autessa.keys.transactions.monthlyStatsREAD

autessa.keys.transactions.monthlyStats({ apiKeyId, year, month })

Read a key's aggregated request usage for a given month, broken down by servlet path, agent, and tool.

Returns success/error/total request counts for the key in the given year and month, plus per-servlet-path, per-agent, and per-tool breakdowns. Read-only aggregation over the transaction log.

Request fields

  • Name
    apiKeyId
    Type
    string
    Description
  • Name
    year
    Type
    number
    Description
  • Name
    month
    Type
    number
    Description

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    apiKeyId
    Type
    string
    Description
  • Name
    year
    Type
    number
    Description
  • Name
    month
    Type
    number
    Description
  • Name
    totalRequests
    Type
    number
    Description
  • Name
    totalSuccessRequests
    Type
    number
    Description
  • Name
    totalErrorRequests
    Type
    number
    Description
  • Name
    servletPathStats
    Type
    ServletPathStatsDto[]
    Description
  • Name
    agentStats
    Type
    AgentStatsDto[]
    Description
  • Name
    toolStats
    Type
    ToolStatsDto[]
    Description

autessa.keys.updateMUTATE

autessa.keys.update({ apiKeyId, updatedApiKey })

Update an API key by submitting its modified configuration in updatedApiKey (read with keys.get, modify, submit).

The submitted updatedApiKey replaces the stored configuration wholesale — start from the entity returned by keys.get so unmentioned fields survive. Origins must be well-formed and rate limits positive; isSystemKey cannot be set. Does not rotate the secret (use keys.refresh) and does not itself grant per-resource permissions (use keys.permissions.*).

Request fields

  • Name
    apiKeyId
    Type
    string
    Description
  • Name
    updatedApiKey
    Type
    ApiKeyDto
    Description

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    apiKey
    Type
    ApiKeyDto
    Description