Authorize Inbox | AgentMail

{
  "type": "public_key",
  "api_key_id": "api_key_id",
  "name": "name",
  "permissions": {
    "inbox_read": true,
    "inbox_create": true,
    "inbox_update": true,
    "inbox_delete": true,
    "message_read": true,
    "message_send": true,
    "message_update": true,
    "message_delete": true,
    "label_spam_read": true,
    "label_blocked_read": true,
    "label_unauthenticated_read": true,
    "label_trash_read": true,
    "draft_read": true,
    "draft_create": true,
    "draft_update": true,
    "draft_delete": true,
    "draft_send": true,
    "webhook_read": true,
    "webhook_create": true,
    "webhook_update": true,
    "webhook_delete": true,
    "domain_read": true,
    "domain_create": true,
    "domain_update": true,
    "domain_delete": true,
    "list_entry_read": true,
    "list_entry_create": true,
    "list_entry_delete": true,
    "metrics_read": true,
    "api_key_read": true,
    "api_key_create": true,
    "api_key_update": true,
    "api_key_delete": true,
    "provider_connect": true,
    "provider_share_owner": true,
    "pod_read": true,
    "pod_create": true,
    "pod_delete": true
  },
  "created_by": {
    "api_key_id": "api_key_id"
  },
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z",
  "client_id": "client_id",
  "public_key": {
    "jwk": {
      "kty": "EC",
      "crv": "P-256",
      "x": "blackcurrant...............................",
      "y": "blackcurrant..............................."
    },
    "fingerprint": "blackcurrant..............................."
  },
  "pod_id": "pod_id",
  "inbox_id": "inbox_id",
  "status": "pending",
  "used_at": "2024-01-15T09:30:00Z",
  "expires_at": "2024-01-15T09:30:00Z"
}

Authorizes the AgentID sign-in a client is already waiting in, for the inbox in the path, and returns the pending public key it will activate. A repeat for the same token, inbox, and bearer returns the same key.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

inbox_idstringRequired

The ID of the inbox.

Request

This endpoint expects an object.

auth_tokenstringRequiredformat: "^[A-Za-z0-9_-]{22}$"=22 characters

Token identifying one pending AgentID sign-in, read from the sign-in action on exactly https://auth.agentid.com.

accept_disclosurebooleanOptional

Accept the provider’s disclosure on the agent’s behalf, skipping the first-use disclosure page. Requires provider_share_owner when owner scopes are involved.

Response

This endpoint returns an object.

type"public_key"

api_key_idstring

ID of api key.

namestring

Name of api key.

permissionsobject

Granular permissions for the API key. When ommitted all permissions are granted. Otherwise, only permissions set to true are granted.

created_byobject

The bearer API key that created the credential. Provenance only; the credential outlives it.

created_atdatetime

Time at which api key was created.

updated_atdatetime

Time at which api key was last updated.

client_idstringOptional

Caller-chosen alias for a public key, unique within the organization and reusable after deletion. Accepted in place of api_key_id on get, update, and delete. Registration is idempotent on it: the same alias returns the existing key, a conflicting one returns 409. URL-safe; no slash or @.

public_keyobjectOptional

Registered public key material and its server-computed RFC 7638 thumbprint.

pod_idstringOptional

Pod ID the api key is scoped to. If set, the key can only access resources within this pod.

inbox_idstringOptional

Inbox ID the api key is scoped to. If set, the key can only access resources within this inbox.

statusenumOptional

Lifecycle of a sign-in key: pending until the client finishes creating it on the AgentID page, active once it can sign in as the inbox. Absent on a registered key.

used_atdatetimeOptional

Time at which api key was last used.

expires_atdatetimeOptional

Time at which api key expires. Omitted when it does not expire.

Errors

400

Validation Error

404

Not Found Error