Reference · built on requestConnectorAccess control & video

HID Origo

Users, invitations, credential containers, Mobile IDs, passes, and lifecycle events from HID Origo, HID Global's mobile credential cloud.

About

HID Origo is HID Global's cloud platform for physical access control credentials on phones, watches, wearables, and cards. It does not control doors itself. The Mobile Identities API v2.2 manages users, invitation codes, credential containers, and Seos Mobile IDs; the Credential Management API v3 manages passes and pass templates for Apple Wallet, Google Wallet, and Identity Positioning. Events and Callbacks deliver lifecycle events as CloudEvents batches.

Through Fibric, an operator reconciles credential holders against your directory and proposes an invitation, a credential issue, or a revoke. You approve, the call runs once, and the record keeps the part number and container involved.

This is a reference listing. It documents what Fibric would read from HID Origo and what it could propose, based on the vendor's published interfaces. Fibric builds it under a managed deployment when you request it; selecting it here installs nothing.

Inputs

  • Users, with invitation codes in PENDING, ACKNOWLEDGED, NOT_SUPPORTED, or FAILED state
  • Credential containers, meaning enrolled devices, with hceCapability and an ACTIVE state once registered
  • Mobile IDs on a container with status ISSUE_INITIATED, ISSUED, REVOKE_INITIATED, or REVOKED, and the part numbers available to the organization
  • Passes and pass templates from the Credential Management API, with per-platform settings
  • Callback registrations with status ACTIVE, INACTIVE, SUSPENDED, or EXPIRED
  • Events for users created or deleted and credential and pass lifecycle changes, delivered as application/cloudevents-batch+json and retrievable per user through getEvents

Proposed actions

  • Target capability: propose creating a user and an invitation code for their device
  • Target capability: propose issuing a Mobile ID of a chosen part number to an active credential container
  • Target capability: propose revoking a Mobile ID with DELETE, or deleting a user or device, which revokes its credentials
  • Target capability: propose revoking a pass through DELETE ../passes/{passId} or a post-provisioning pass update
  • Target capability: propose a callback registration with a URL, filterId, authentication, and durationInDays

Proposed actions are target capabilities. Every action runs propose-first and needs a validated deployment and the appropriate permissions.

What you can build

  • Issue a phone credential on the first day

    When your directory adds a person, the operator proposes the user, the invitation code, and the Mobile ID issue for the right part number, then watches the invitation move to ACKNOWLEDGED.

    With Onboarding Checklist, Contractor Credentials

  • Revoke on departure

    An offboarding signal lists the person's containers and Mobile IDs. The operator proposes the revokes and the user delete, and confirms the REVOKED events that come back.

    With Access Offboarding, Offboarding Sweep

  • Keep callbacks alive

    A registration moves to SUSPENDED after three failed deliveries. The operator notices the state change, checks your endpoint, and proposes reactivation or a replacement registration.

    With Integration Health, Webhook Replay

Requirements

  • Enrollment as an HID Origo integration developer; the Application-ID and Application-Version values are issued by HID after its review of the application
  • An HID Origo organization with a subscription; requests without a valid subscription return HTTP 402
  • A System Account created under Organization Administration in the HID Origo Management Portal by an Organization Administrator
  • Content-Type headers that carry the API version, such as application/vnd.assaabloy.ma.credential-management-2.2+json
  • A callback endpoint that accepts POST bodies of application/cloudevents-batch+json and answers HTTP 200
Authentication
OAuth 2.0 client_credentials at https://api.origo.hidglobal.com/authentication/customer/{organization_id}/token using a System Account's client ID and secret or a private-key JWT, sent as a Bearer token with Application-ID and Application-Version headers.

Limits

  • Per-organization limits per 5 minutes: 300 for Mobile Identities and Callbacks, 50 for Authentication, 5,000 for User and Credential Management; excess returns HTTP 403
  • Access tokens last 3,600 seconds and expire if unused within 5 minutes of issue
  • Mobile Identities search returns 25 records per request; Credential Management list pages run from 1 to 1,000 with a default of 20
  • User objects created through the User Management API v3 work only with Credential Management, not with Mobile Identities

Access and pricing

Reference listing. Fibric builds the connector under a managed deployment when you request it. Your quote covers the build, capabilities, usage, and support.

Request HID Origo ↗

Questions and answers

How do I authenticate?
POST grant_type=client_credentials to https://api.origo.hidglobal.com/authentication/customer/{organization_id}/token with a System Account's client ID and secret, or a signed JWT with sub, iss, aud, exp, and jti claims. The response's expires_in is 3600. Send the token as Authorization: Bearer with Application-ID and Application-Version.
How are callbacks secured and retried?
A registration can carry an httpHeader and secret pair, for Basic or API-key style headers, or OAuth 2.0 with client_secret_basic, client_secret_post, client_secret_jwt, or private_key_jwt. After three consecutive failed deliveries the registration is SUSPENDED and HID periodically re-checks the endpoint.
Does HID Origo open doors?
No. Origo issues and manages credentials. The physical access control system that reads them, and the door hardware, are separate. The Transaction Management API concerns declining balances shown on wallet credentials and keeps no transaction history.
Ask about HID Origo

Ask about the capabilities and requirements in this listing.

For project-specific requirements, contact Fibric.