Rename Public-Key Credential | AgentMail

from agentmail import AgentMail
import uuid
client = AgentMail(
    api_key="YOUR_TOKEN_HERE",
)
client.api_keys.update_public_key_name(
    api_key_id=uuid.UUID("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
    name="x",
)

{
  "api_key_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
  "type": "public_key",
  "name": "name",
  "public_key": {
    "jwk": {
      "kty": "EC",
      "crv": "P-256",
      "x": "blackcurrant...............................",
      "y": "blackcurrant..............................."
    },
    "fingerprint": "blackcurrant..............................."
  },
  "scope": {
    "type": "organization"
  },
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z",
  "expires_at": "2024-01-15T09:30:00Z",
  "revoked_at": "2024-01-15T09:30:00Z"
}

Rename the credential. All security-relevant fields are immutable. Requires api_key_update.

Authentication

AuthorizationBearer

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

Path parameters

api_key_idUUIDRequired

Public-key credential ID returned by registration.

Request

This endpoint expects an object.

namestringRequired1-256 characters

Response

This endpoint returns an object.

api_key_idUUID

Server-generated credential ID. Store this value as the signing key’s kid.

type"public_key"

Server-owned credential discriminator. Callers cannot select or update it.

namestring

Human-readable credential name.

public_keyobject

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

scopeobject

The immutable scope in which a public-key credential can approve AgentID sign-in.

created_atdatetime

updated_atdatetime

expires_atdatetimeOptional

Immutable absolute expiry. Omitted when the credential does not expire.

revoked_atdatetimeOptional

Present when organization-wide revoke-all invalidated this credential generation.

Errors

400

Validation Error

404

Not Found Error