CIMD Registration Failed Event

Edit on GitHubView Markdown
On this page

CIMD Registration Failed

Enterprise plan required

This feature requires an Enterprise plan.

Available since 1.70.0

This event is generated when FusionAuth can't register a CIMD client or update its registration. FusionAuth also writes an Error entry to the Event Log for each failure.

Event type

cimd.registration.failed

Event Scope

This is a tenant-scoped event.

It can be sent to all tenants or to one or more specified tenants. However, those tenants will not be sent events for other tenants, but only events related to themselves.

Transaction Compatibility

This event is non-transactional. The operation will succeed regardless of the webhook response status code.

See OAuth Client Registration for how FusionAuth registers CIMD clients.

A failed fetch doesn't always fail the login. During the CIMD domain's grace period, FusionAuth keeps using the expired registration, but still sends this event with the reason metadataRetrievalFailed.

Event Body

event.cimdDomainId
  • Type: UUID

The unique Id of the CIMD domain that matched the client's client_id URL. Absent when no CIMD domain matched.

event.clientId
  • Type: String

The client's client_id URL.

event.createInstant
  • Type: Long

The instant that the event was generated.

event.id
  • Type: UUID

The unique Id of the event. You may receive an event more than once based upon your transaction settings. This Id may be used to identify a duplicate event.

event.info.data
  • Type: Object

An object that can hold any information about the event that should be persisted.

event.info.deviceDescription
  • Type: String

The description of the device associated with the event.

event.info.deviceName
  • Type: String

The device name associated with the event.

event.info.deviceType
  • Type: String

The type of device associated with the event.

event.info.ipAddress
  • Type: String

The source IP address of the event.

event.info.location.city
  • Type: String

The city where the event originated.

Enterprise plan To use event location data, you'll need an Enterprise plan.

event.info.location.country
  • Type: String

The country where the event originated.

Enterprise plan To use event location data, you'll need an Enterprise plan.

event.info.location.latitude
  • Type: Double

The latitude where the event originated.

Enterprise plan To use event location data, you'll need an Enterprise plan.

event.info.location.longitude
  • Type: Double

The longitude where the event originated.

Enterprise plan To use event location data, you'll need an Enterprise plan.

event.info.location.region
  • Type: String

The geographic location where the event originated.

Enterprise plan To use event location data, you'll need an Enterprise plan.

event.info.location.zipcode
  • Type: String

The zip code where the event originated.

Enterprise plan To use event location data, you'll need an Enterprise plan.

event.info.os
  • Type: String

The operating system associated with the event.

event.info.userAgent
  • Type: String

The user agent associated with the event.

event.reason.code
  • Type: String

Why the registration failed. The possible values are:

  • lambdaRejected - The CIMD client registration lambda returned a DENY or REVOKE decision, or failed.
  • metadataRetrievalFailed - FusionAuth couldn't fetch or validate the client's metadata document.
  • rateLimited - The user exceeded the Tenant's rate limit for registering new CIMD clients.
event.resource
  • Type: String

The resource the client requested.

event.tenantId
  • Type: UUID

The unique Id of the Tenant.

event.type
  • Type: String

The event type. This value is always cimd.registration.failed.

Example Event JSON
{
  "event": {
    "cimdDomainId": "3c1f9a2b-7d4e-4b6a-9c8d-1e2f3a4b5c6d",
    "clientId": "https://app.example.com/oauth/client.json",
    "createInstant": 1792680000123,
    "id": "9b1e3d5f-7a2c-4e6b-8d0f-1a3c5e7b9d2f",
    "info": {
      "ipAddress": "203.0.113.42",
      "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.0 Safari/605.1.15"
    },
    "reason": {
      "code": "lambdaRejected"
    },
    "resource": "https://mcp.example.com/mcp",
    "tenantId": "30663132-6464-6665-3032-326466613934",
    "type": "cimd.registration.failed"
  }
}

Related

Extend

CIMD Registration Success Event

Learn about the CIMD Registration Success event.

cimd eventcimd webhookclient id metadata document
Extend

CIMD Client Registration Lambda

An overview of the CIMD client registration lambda.

client id metadata document
Extend

Audit Log Create Event

Learn about the Audit Log Create event.

webhook event
Extend

Entity Create Event

Learn about the Entity Create event.

webhook event