identity/aziot-identityd/openapi/2020-09-01-preview.yaml [3:215]:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
openapi: 3.0.1

info:
  title: Identity Service API

  version: '2020-09-01'

  description: |
    This is the specification of the HTTP API of the aziot-identityd service.

  license:
    name: 'MIT'

servers:
- url: 'http://identityd.sock/'
  description: |
    The server listens on a unix socket `/run/aziot/identityd.sock`


paths:
  /identities/identity?api-version=2020-09-01:
    get:
      tags:
      - Identity operations
      summary: Get primary cloud identity for authenticated workload (caller)
      operationId: getIdentity
      responses:
        200:
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AziotIdentityResponse'
              examples:
                'Response for principals associated to device identities (SAS case)':
                  value:
                    type: 'aziot'
                    spec:
                      hubName: 'myhub.net'
                      gatewayHost: 'parentdevice'
                      deviceId: 'device01'
                      auth:
                        type: 'sas'
                        keyHandle: 'string'
                'Response for principals associated to device identities (X.509 case)':
                  value:
                    type: 'aziot'
                    spec:
                      hubName: 'myhub.net'
                      gatewayHost: 'parentdevice'
                      deviceId: 'device01'
                      auth:
                        type: 'x509'
                        keyHandle: 'string'
                        certId: 'string'
                'Response for principals associated to module identities (SAS case)':
                  value:
                    type: 'aziot'
                    spec:
                      hubName: 'myhub.net'
                      gatewayHost: 'parentdevice'
                      deviceId: 'device01'
                      moduleId: 'module01'
                      genId: '12345'
                      auth:
                        type: 'sas'
                        keyHandle: 'string'
                'Response for principals associated to module identities (X.509 case)':
                  value:
                    type: 'aziot'
                    spec:
                      hubName: 'myhub.net'
                      gatewayHost: 'parentdevice'
                      deviceId: 'device01'
                      moduleId: 'module01'
                      genId: '12345'
                      auth:
                        type: 'x509'
                        keyHandle: 'string'
                        certId: 'string'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'

  /identities/device?api-version=2020-09-01:
    post:
      tags:
      - Identity operations
      summary: Get the IoT device provisioning result
      operationId: getDeviceIdentity
      x-codegen-request-body-name: GetDeviceIdentityRequest
      requestBody:
        description: The type of provisioned identity
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProvisioningResultRequest'
            example:
              value:
                type: 'aziot'
      responses:
        200:
          description: Ok
          content:
            application/json:
              schema:
                required: ['spec', 'type']
                type: object
                properties:
                  'type':
                    $ref: '#/components/schemas/AziotIdentityType'
                  'spec':
                    $ref: '#/components/schemas/AziotIdentitySpec'
              examples:
                'SAS case':
                  value:
                    type: 'aziot'
                    spec:
                      hubName: 'myhub.net'
                      gatewayHost: 'parentdevice'
                      deviceId: 'device01'
                      auth:
                        type: 'sas'
                        keyHandle: 'string'
                'X.509 case':
                  value:
                    type: 'aziot'
                    spec:
                      hubName: 'myhub.net'
                      gatewayHost: 'parentdevice'
                      deviceId: 'device01'
                      auth:
                        type: 'x509'
                        keyHandle: 'string'
                        certId: 'string'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'

  /identities/modules?api-version=2020-09-01&type={type}:
    parameters:
    - $ref: '#/components/parameters/AziotIdentityTypeParameter'
    get:
      tags:
      - Identity operations
      summary: List IoT module identities
      operationId: getModuleIdentities
      responses:
        200:
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AziotModuleIdentitiesResponse'
              examples:
                'SAS case':
                  value:
                    type: 'aziot'
                    spec:
                      hubName: 'myhub.net'
                      gatewayHost: 'parentdevice'
                      deviceId: 'device01'
                      moduleId: 'module01'
                      genId: '12345'
                      auth:
                        type: 'sas'
                        keyHandle: 'string'
                'X.509 case':
                  value:
                    type: 'aziot'
                    spec:
                      hubName: 'myhub.net'
                      gatewayHost: 'parentdevice'
                      deviceId: 'device01'
                      moduleId: 'module01'
                      genId: '12345'
                      auth:
                        type: 'x509'
                        keyHandle: 'string'
                        certId: 'string'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'

  /identities/modules?api-version=2020-09-01:
    post:
      tags:
      - Identity operations
      summary: Create IoT module identity
      operationId: createModuleIdentity
      x-codegen-request-body-name: CreateModuleIdentityRequest
      requestBody:
        description: The type of module identity to create
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateModuleRequest'
            examples:
              'Module identity':
                value:
                  type: 'aziot'
                  moduleId: 'module01'
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -



identity/aziot-identityd/openapi/2020-09-01.yaml [3:215]:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
openapi: 3.0.1

info:
  title: Identity Service API

  version: '2020-09-01'

  description: |
    This is the specification of the HTTP API of the aziot-identityd service.

  license:
    name: 'MIT'

servers:
- url: 'http://identityd.sock/'
  description: |
    The server listens on a unix socket `/run/aziot/identityd.sock`


paths:
  /identities/identity?api-version=2020-09-01:
    get:
      tags:
      - Identity operations
      summary: Get primary cloud identity for authenticated workload (caller)
      operationId: getIdentity
      responses:
        200:
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AziotIdentityResponse'
              examples:
                'Response for principals associated to device identities (SAS case)':
                  value:
                    type: 'aziot'
                    spec:
                      hubName: 'myhub.net'
                      gatewayHost: 'parentdevice'
                      deviceId: 'device01'
                      auth:
                        type: 'sas'
                        keyHandle: 'string'
                'Response for principals associated to device identities (X.509 case)':
                  value:
                    type: 'aziot'
                    spec:
                      hubName: 'myhub.net'
                      gatewayHost: 'parentdevice'
                      deviceId: 'device01'
                      auth:
                        type: 'x509'
                        keyHandle: 'string'
                        certId: 'string'
                'Response for principals associated to module identities (SAS case)':
                  value:
                    type: 'aziot'
                    spec:
                      hubName: 'myhub.net'
                      gatewayHost: 'parentdevice'
                      deviceId: 'device01'
                      moduleId: 'module01'
                      genId: '12345'
                      auth:
                        type: 'sas'
                        keyHandle: 'string'
                'Response for principals associated to module identities (X.509 case)':
                  value:
                    type: 'aziot'
                    spec:
                      hubName: 'myhub.net'
                      gatewayHost: 'parentdevice'
                      deviceId: 'device01'
                      moduleId: 'module01'
                      genId: '12345'
                      auth:
                        type: 'x509'
                        keyHandle: 'string'
                        certId: 'string'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'

  /identities/device?api-version=2020-09-01:
    post:
      tags:
      - Identity operations
      summary: Get the IoT device provisioning result
      operationId: getDeviceIdentity
      x-codegen-request-body-name: GetDeviceIdentityRequest
      requestBody:
        description: The type of provisioned identity
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProvisioningResultRequest'
            example:
              value:
                type: 'aziot'
      responses:
        200:
          description: Ok
          content:
            application/json:
              schema:
                required: ['spec', 'type']
                type: object
                properties:
                  'type':
                    $ref: '#/components/schemas/AziotIdentityType'
                  'spec':
                    $ref: '#/components/schemas/AziotIdentitySpec'
              examples:
                'SAS case':
                  value:
                    type: 'aziot'
                    spec:
                      hubName: 'myhub.net'
                      gatewayHost: 'parentdevice'
                      deviceId: 'device01'
                      auth:
                        type: 'sas'
                        keyHandle: 'string'
                'X.509 case':
                  value:
                    type: 'aziot'
                    spec:
                      hubName: 'myhub.net'
                      gatewayHost: 'parentdevice'
                      deviceId: 'device01'
                      auth:
                        type: 'x509'
                        keyHandle: 'string'
                        certId: 'string'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'

  /identities/modules?api-version=2020-09-01&type={type}:
    parameters:
    - $ref: '#/components/parameters/AziotIdentityTypeParameter'
    get:
      tags:
      - Identity operations
      summary: List IoT module identities
      operationId: getModuleIdentities
      responses:
        200:
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AziotModuleIdentitiesResponse'
              examples:
                'SAS case':
                  value:
                    type: 'aziot'
                    spec:
                      hubName: 'myhub.net'
                      gatewayHost: 'parentdevice'
                      deviceId: 'device01'
                      moduleId: 'module01'
                      genId: '12345'
                      auth:
                        type: 'sas'
                        keyHandle: 'string'
                'X.509 case':
                  value:
                    type: 'aziot'
                    spec:
                      hubName: 'myhub.net'
                      gatewayHost: 'parentdevice'
                      deviceId: 'device01'
                      moduleId: 'module01'
                      genId: '12345'
                      auth:
                        type: 'x509'
                        keyHandle: 'string'
                        certId: 'string'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'

  /identities/modules?api-version=2020-09-01:
    post:
      tags:
      - Identity operations
      summary: Create IoT module identity
      operationId: createModuleIdentity
      x-codegen-request-body-name: CreateModuleIdentityRequest
      requestBody:
        description: The type of module identity to create
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateModuleRequest'
            examples:
              'Module identity':
                value:
                  type: 'aziot'
                  moduleId: 'module01'
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -



