AGNTCY Device Service API

openapi: 3.2.0
info:
  title: AGNTCY Identity Service Device Service API
  description: AGNTCY Identity Service API provides a set of endpoints for managing identity and access control within the Agntcy ecosystem.
  contact:
    name: Agntcy Team
    url: https://github.com/agntcy/identity-service
    email: identity@agntcy.org
  version: v1alpha1
  x-provenance:
    method: harvested
    authored_by: AGNTCY (Outshift by Cisco)
    harvested_by: API Evangelist
    harvested_on: '2026-08-19'
    first_party: true
    provider_published: true
    source_host: agntcy.org / outshift.com
    note: 'Four first-party machine-readable contracts: the Agent Connect Protocol OpenAPI 3.1.1, the OASF Schema API, and two AGNTCY Identity OpenAPI 3.0.3 documents. schema.oasf.outshift.com is the one genuinely callable AGNTCY-hosted API (unauthenticated, 200).'
  x-evidence:
  - type: source
    url: https://spec.acp.agntcy.org/
  - type: source
    url: https://schema.oasf.outshift.com/doc
  - type: source
    url: https://identity-docs.outshift.com/api/openapi/service/v1alpha1/openapi.yaml
servers:
- url: http://localhost:4000
  description: Local environment
security:
- AccessToken: []
  ApiKey: []
tags:
- name: DeviceService
  description: DeviceService manages device.
paths:
  /v1alpha1/device:
    get:
      tags:
      - DeviceService
      description: List all registered devices
      operationId: DeviceService_ListDevices
      parameters:
      - name: page
        in: query
        description: The current page of the pagination
        schema:
          type: integer
          format: int32
      - name: size
        in: query
        description: The page size of the pagination
        schema:
          type: integer
          format: int32
      - name: query
        in: query
        description: The search query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDevicesResponse'
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
    post:
      tags:
      - DeviceService
      description: Add new device for approval flow
      operationId: DeviceService_AddDevice
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Device'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Device'
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
  /v1alpha1/device/{deviceId}:
    post:
      tags:
      - DeviceService
      description: Add new device for approval flow
      operationId: DeviceService_RegisterDevice
      parameters:
      - name: deviceId
        in: path
        description: The unique identifier for the device to register.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Device'
        required: true
      responses:
        '200':
          description: OK
          content: {}
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
    delete:
      tags:
      - DeviceService
      description: Delete a registered Device.
      operationId: DeviceService_DeleteDevice
      parameters:
      - name: deviceId
        in: path
        description: The device id.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content: {}
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
  /v1alpha1/device/{deviceId}/test:
    post:
      tags:
      - DeviceService
      description: Send a test notification to a registered device to see if it's well configured.
      operationId: DeviceService_TestDevice
      parameters:
      - name: deviceId
        in: path
        description: The device id.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content: {}
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
components:
  schemas:
    Device:
      type: object
      properties:
        id:
          readOnly: true
          type: string
          description: A unique identifier for the Device.
        userId:
          type: string
          description: User ID associated with the Device.
        subscriptionToken:
          type: string
          description: Subscription Token for the Device.
        name:
          type: string
          description: The device human-readable name.
        createdAt:
          readOnly: true
          type: string
          description: The creation time of the Device.
          format: date-time
      description: Devices used for user approval
    GoogleProtobufAny:
      type: object
      properties:
        '@type':
          type: string
          description: The type of the serialized message.
      additionalProperties: true
      description: Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
    ListDevicesResponse:
      type: object
      properties:
        devices:
          type: array
          items:
            $ref: '#/components/schemas/Device'
          description: A list of Apps.
        pagination:
          allOf:
          - $ref: '#/components/schemas/PagedResponse'
          description: Pagination response.
    PagedResponse:
      type: object
      properties:
        nextPage:
          type: integer
          description: Next page
          format: int32
        hasNextPage:
          type: boolean
          description: Has next page
        total:
          type: string
          description: The total size of items
        size:
          type: integer
          description: The size of the current page
          format: int32
      description: Pagination response
    Status:
      type: object
      properties:
        code:
          type: integer
          description: The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
          format: int32
        message:
          type: string
          description: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
        details:
          type: array
          items:
            $ref: '#/components/schemas/GoogleProtobufAny'
          description: A list of messages that carry the error details.  There is a common set of message types for APIs to use.
      description: 'The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).'
  securitySchemes:
    AccessToken:
      type: http
      description: An IAM JWT token issued to a user during an OIDC flow.
      scheme: bearer
      bearerFormat: JWT
    ApiKey:
      type: apiKey
      description: An IAM Api key.
      name: x-id-api-key
      in: header