ENGAGE Cloud Credentialing API — Mobile Credentials

naftiko: 1.0.0-alpha2
info:
  label: ENGAGE Cloud Credentialing API — Mobile Credentials
  description: 'ENGAGE Cloud Credentialing API — Mobile Credentials. 4 operations for
    uploading, listing, fetching, and revoking BLE Mobile Credentials in the Allegion
    Device Management and Mobile Access Cloud (Engage Cloud). Authentication is
    alle-subscription-key header + Basic Auth derived from ENGAGE credentials.
    Integrator must have signed the Allegion Security Token Agreement. Self-contained
    Naftiko capability covering one Allegion business surface.'
  tags:
    - Allegion
    - ENGAGE
    - Mobile Credentials
    - BLE
    - Access Control
    - Commercial
  created: '2026-05-23'
  modified: '2026-05-23'
binds:
  - namespace: env
    keys:
      ALLEGION_SUBSCRIPTION_KEY: ALLEGION_SUBSCRIPTION_KEY
      ENGAGE_USERNAME: ENGAGE_USERNAME
      ENGAGE_PASSWORD: ENGAGE_PASSWORD
capability:
  consumes:
    - type: http
      namespace: engage-credentials
      baseUri: https://api.allegion.com/engage
      description: ENGAGE Cloud Credentialing API — Mobile Credentials business capability. Self-contained, no shared references.
      resources:
        - name: credentials
          path: /credentials
          operations:
            - name: listCredentials
              method: GET
              description: List active BLE Mobile Credentials.
              inputParameters:
                - name: userId
                  in: query
                  type: string
                - name: status
                  in: query
                  type: string
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
            - name: uploadCredential
              method: POST
              description: Upload a BLE Mobile Credential for an ACS user.
              inputParameters:
                - name: body
                  in: body
                  type: object
                  required: true
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
        - name: credential
          path: /credentials/{credentialId}
          operations:
            - name: getCredential
              method: GET
              description: Get a single mobile credential.
              inputParameters:
                - name: credentialId
                  in: path
                  type: string
                  required: true
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
            - name: deleteCredential
              method: DELETE
              description: Revoke (delete) a mobile credential. Subsequent unlock attempts using the credential will be denied.
              inputParameters:
                - name: credentialId
                  in: path
                  type: string
                  required: true
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
      authentication:
        type: composite
        headers:
          alle-subscription-key: '{{env.ALLEGION_SUBSCRIPTION_KEY}}'
        basic:
          username: '{{env.ENGAGE_USERNAME}}'
          password: '{{env.ENGAGE_PASSWORD}}'
  exposes:
    - type: rest
      namespace: engage-credentials-rest
      port: 8080
      description: REST adapter for ENGAGE Credentialing.
      resources:
        - path: /v1/credentials
          name: credentials
          description: REST surface for listCredentials and uploadCredential.
          operations:
            - method: GET
              name: listCredentials
              description: List Credentials
              call: engage-credentials.listCredentials
              with:
                userId: rest.userId
                status: rest.status
              outputParameters:
                - type: object
                  mapping: $.
            - method: POST
              name: uploadCredential
              description: Upload Credential
              call: engage-credentials.uploadCredential
              with:
                body: rest.body
              outputParameters:
                - type: object
                  mapping: $.
        - path: /v1/credentials/{credentialId}
          name: credential
          description: REST surface for getCredential and deleteCredential.
          operations:
            - method: GET
              name: getCredential
              description: Get Credential
              call: engage-credentials.getCredential
              with:
                credentialId: rest.credentialId
              outputParameters:
                - type: object
                  mapping: $.
            - method: DELETE
              name: deleteCredential
              description: Delete Credential
              call: engage-credentials.deleteCredential
              with:
                credentialId: rest.credentialId
              outputParameters:
                - type: object
                  mapping: $.