canonical: https://jentic.com/apis/allegion.com/allegion

# Allegion Credentialing API

Jentic publishes the only available OpenAPI specification for Allegion Credentialing API, keeping it validated and agent-ready. The Allegion Schlage Mobile Credentials API issues, lists, and revokes mobile credentials that unlock Schlage access control devices, and lets callers enumerate the devices in their fleet. Authentication combines a subscription key in the alle-subscription-key header with HTTP basic auth, reflecting Allegion's enterprise integration model. The API is small and focused on the credential lifecycle rather than user management or door-event reporting.

## For AI agents

Issue, list, and revoke Schlage mobile credentials and read connected access control devices for an Allegion-managed property.

## Scope

Does not handle door-event telemetry, user identity management, or video surveillance - use for Schlage mobile credential lifecycle and device inventory only.

## Capabilities

- Issue a mobile credential bound to a recipient and access scope
- List active credentials currently in circulation
- Look up a single credential by its credentialId
- Revoke a mobile credential immediately via DELETE
- Enumerate Schlage devices registered to the customer account
- Pull metadata for a specific device by deviceId

## Use cases

### Tenant move-in credential issuance

Property managers issue a mobile credential the moment a tenant signs a lease, replacing physical key handover. The agent calls POST /credentials with the recipient and the scoped device IDs, and the credential is provisioned for the tenant's phone. Revocation at move-out is a single DELETE call against the credentialId.

Example prompt: Call POST /credentials with the new tenant's email and the device IDs for unit 4B and the lobby, then store the returned credentialId in the property management record.

### Contractor access lifecycle

Service contractors get short-lived mobile credentials that are revoked as soon as the work order closes. The Credentialing API supports immediate revocation via DELETE /credentials/{credentialId}, so the agent loop is tightly bound to the work-order completion event. This avoids stale access that lingers after the job ends.

Example prompt: When the work-order webhook fires for completion, call DELETE /credentials/{credentialId} for the contractor's credential to revoke access immediately.

### Device fleet inventory

Operations teams audit their Schlage device fleet by listing devices and pulling per-device metadata. GET /devices returns the registered fleet and GET /devices/{deviceId} returns details for a chosen lock. This data feeds asset management systems and helps reconcile physical installs with the cloud-registered inventory.

Example prompt: Call GET /devices to list every Schlage lock on the account and write the deviceId, name, and location into a CMMS asset record.

### AI agent property access management

An AI agent embedded in a property management workflow can issue credentials, look them up, and revoke them on schedule, all through Jentic. The agent searches by intent, loads the schema, and executes - credentials and the alle-subscription-key are kept in your Jentic One instance and never enter the prompt.

Example prompt: Use Jentic to search 'issue a Schlage mobile credential', execute POST /credentials with the lease record, and store the result.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | /credentials | Issue a new mobile credential |
| GET | /credentials | List active credentials |
| GET | /credentials/{credentialId} | Retrieve a credential by ID |
| DELETE | /credentials/{credentialId} | Revoke a credential |
| GET | /devices | List registered Schlage devices |
| GET | /devices/{deviceId} | Get device details |

## Key resources

- **Credentials** — Issue, list, retrieve, and revoke mobile credentials for Schlage devices
- **Devices** — List registered Schlage devices and pull per-device metadata

## Why Jentic

- **Setup:** Wiring the Allegion Credentialing API by hand means sending both its alle-subscription-key header and HTTP basic credentials to api.allegion.com and managing the Schlage credential and device calls yourself. Through Jentic you install once, import the Allegion Credentialing API from the API Directory, store those credentials once, and your agent calls it.
- **Permission scoping:** The Allegion Credentialing API puts the credential and device ids in the URL path (/credentials/{credentialId}, /devices/{deviceId}), so a rule can pin your agent to reading one credential or device. You choose the operations it may call, so issuing new credentials or deleting a credential is not included unless you add it.
- **Credential handling:** Your Allegion subscription key and basic credential are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'issue a mobile credential' or 'look up a device', and Jentic returns the matching Allegion operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Samsara** — Samsara handles fleet and facility telemetry alongside physical access
- **BambooHR** — Tie credential issuance and revocation to HR onboarding and offboarding events
- **HubSpot Tickets** — Track contractor access requests and revocations as support tickets

## FAQ

### Why is there no official OpenAPI spec for Allegion Credentialing API?

Allegion does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Allegion Credentialing API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the Allegion Credentialing API use?

Calls require both an alle-subscription-key header (an apiKey scheme) and HTTP basic auth credentials. Through Jentic, both values are stored in the encrypted vault and injected at execution time so they never enter agent prompts.

### Can I revoke a Schlage mobile credential immediately via the API?

Yes. DELETE /credentials/{credentialId} revokes a mobile credential. Pair this with a webhook from the calling system (e.g. lease termination or work-order closure) to make revocation event-driven.

### How do I issue a Schlage credential via the Allegion API through Jentic?

Run pip install jentic, search for 'issue a Schlage mobile credential', load the input schema for POST /credentials, and execute with the recipient and scoped device IDs. Jentic returns the credentialId in the response.

### Can I list every Schlage device on my account via this API?

Yes. GET /devices returns the registered device list, and GET /devices/{deviceId} returns details for a single lock. Use these to build or sync an asset inventory.

### Does the Allegion Credentialing API report door-open events?

No. This API is scoped to credential lifecycle and device metadata. Door-event telemetry is published through other Allegion product surfaces and is not part of this spec.

### Can I limit what my agent is allowed to do with the Allegion Credentialing API?

Yes. Jentic One is self-hosted, so your own rules decide which of the six Allegion operations your agent may call and which stored credentials it may use. Because the credential and device ids live in the URL path (/credentials/{credentialId}, /devices/{deviceId}), you can pin the agent to reading a single credential or device with GET, while withholding POST /credentials to issue a new credential or DELETE /credentials/{credentialId} to revoke one unless you explicitly allow them. The alle-subscription-key and basic auth values stay in your instance and are injected only for the operations you permit.