Microsoft Windows 10

Microsoft Windows 10 Credentials API

The Credentials API from Microsoft Windows 10 — 2 operation(s) for credentials.

Documentation GitHub OpenAPI

Documentation

https://learn.microsoft.com/en-us/uwp/api/

https://learn.microsoft.com/en-us/windows/uwp/get-started/

https://learn.microsoft.com/en-us/windows/win32/apiindex/windows-api-list

https://learn.microsoft.com/en-us/windows/win32/desktop-programming

https://learn.microsoft.com/en-us/windows/uwp/design/shell/tiles-and-notifications/adaptive-interactive-toasts

https://learn.microsoft.com/en-us/windows/ai/windows-ml/api-reference

https://learn.microsoft.com/en-us/windows/ai/windows-ml/get-started

https://learn.microsoft.com/en-us/uwp/api/windows.storage

https://learn.microsoft.com/en-us/windows/uwp/files/

https://learn.microsoft.com/en-us/cortana/voice-commands/vcd

https://learn.microsoft.com/en-us/uwp/api/windows.ui.input.inking

https://learn.microsoft.com/en-us/windows/uwp/design/input/pen-and-stylus-interactions

https://learn.microsoft.com/en-us/windows/uwp/composition/visual-layer

https://learn.microsoft.com/en-us/windows/uwp/composition/using-the-visual-layer-with-xaml

https://learn.microsoft.com/en-us/windows/win32/directx

https://learn.microsoft.com/en-us/windows/win32/getting-started-with-directx-graphics

https://learn.microsoft.com/en-us/windows/apps/develop/audio-video-camera

https://learn.microsoft.com/en-us/windows/win32/medfound/audio-video-capture-in-media-foundation

https://learn.microsoft.com/en-us/windows/uwp/networking/which-networking-technology

https://learn.microsoft.com/en-us/windows/uwp/devices-sensors/bluetooth-dev-faq

https://learn.microsoft.com/en-us/windows/win32/bluetooth/bluetooth-programming-with-windows-sockets

https://learn.microsoft.com/en-us/uwp/api/windows.devices.geolocation

https://learn.microsoft.com/en-us/windows/win32/sensorsapi/introduction-to-the-sensor-and-location-platform-in-windows

https://learn.microsoft.com/en-us/windows/apps/develop/security/windows-hello

https://learn.microsoft.com/en-us/windows/apps/develop/security/windows-hello-auth-service

https://learn.microsoft.com/en-us/windows/apps/winui/winui2/

https://learn.microsoft.com/en-us/windows/apps/winui/winui2/getting-started

https://learn.microsoft.com/en-us/windows/apps/windows-app-sdk/applifecycle/background-tasks

Specifications

https://raw.githubusercontent.com/api-evangelist/microsoft-windows-10/refs/heads/main/openapi/microsoft-windows-10-credentials-api-openapi.yml

Other Resources

https://github.com/Microsoft/Windows-universal-samples

https://learn.microsoft.com/en-us/uwp/api/

https://developer.microsoft.com/en-us/windows/downloads/windows-10-sdk/

https://learn.microsoft.com/en-us/windows/win32/api/

https://github.com/microsoft/Windows-classic-samples

https://github.com/WindowsNotifications/quickstart-sending-local-toast-win10

https://learn.microsoft.com/en-us/uwp/api/windows.ui.notifications

https://learn.microsoft.com/en-us/windows/ai/windows-ml/tutorials

https://github.com/Microsoft/Windows-Machine-Learning

https://learn.microsoft.com/en-us/windows/uwp/files/best-practices-for-writing-to-files

https://learn.microsoft.com/en-us/cortana/voice-commands/voicecommand-design-guidelines

https://github.com/Microsoft/Windows-universal-samples/tree/master/Samples/SimpleInk

https://learn.microsoft.com/en-us/uwp/api/windows.ui.composition

https://github.com/microsoft/Windows.UI.Composition-Win32-Samples

https://github.com/microsoft/DirectX-Graphics-Samples

https://microsoft.github.io/DirectX-Specs/

https://learn.microsoft.com/en-us/uwp/api/windows.media.capture

https://learn.microsoft.com/en-us/uwp/api/windows.networking.sockets

https://learn.microsoft.com/en-us/samples/microsoft/windows-universal-samples/websocket/

https://learn.microsoft.com/en-us/windows/win32/api/_bluetooth/

https://learn.microsoft.com/en-us/windows/win32/locationapi/windows-location-api-portal

https://learn.microsoft.com/en-us/samples/microsoft/windows-universal-samples/geolocation/

https://learn.microsoft.com/en-us/uwp/api/windows.devices.sensors

https://learn.microsoft.com/en-us/windows/security/identity-protection/hello-for-business/webauthn-apis

https://learn.microsoft.com/en-us/windows/winui/api/microsoft.ui.xaml.controls

https://github.com/microsoft/microsoft-ui-xaml

https://learn.microsoft.com/en-us/samples/microsoft/windows-universal-samples/backgroundtask/

OpenAPI Specification

openapi: 3.1.0
info:
  title: Microsoft Windows 10 Windows Background Tasks Accelerometer Credentials API
  description: API for running code in the background when an application is suspended or not running. Based on the Windows.ApplicationModel.Background namespace, it supports time-triggered, system-triggered, and maintenance-triggered background tasks. Key classes include BackgroundTaskBuilder, BackgroundTaskRegistration, SystemTrigger, TimeTrigger, and BackgroundTaskCompletedEventArgs.
  version: 1.0.0
  contact:
    name: Microsoft Developer Support
    url: https://learn.microsoft.com/en-us/windows/apps/windows-app-sdk/applifecycle/background-tasks
  license:
    name: Microsoft Software License
    url: https://www.microsoft.com/en-us/legal/terms-of-use
servers:
- url: https://api.windows.com
  description: Windows Platform API
tags:
- name: Credentials
paths:
  /hello/credentials:
    post:
      operationId: createKeyCredential
      summary: Microsoft Windows 10 Create a Windows Hello key credential
      description: Creates a new key credential for Windows Hello authentication using KeyCredentialManager.RequestCreateAsync. Generates a public/private key pair where the private key is stored securely on the device (in TPM if available) and the public key is returned for server registration.
      tags:
      - Credentials
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCredentialRequest'
      responses:
        '201':
          description: Key credential created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyCredential'
        '400':
          description: Invalid request
        '403':
          description: User cancelled the consent prompt
  /hello/credentials/{accountId}:
    get:
      operationId: openKeyCredential
      summary: Microsoft Windows 10 Open an existing key credential
      description: Opens an existing Windows Hello key credential using KeyCredentialManager.OpenAsync. Returns the credential if it exists, allowing the application to use it for signing operations.
      tags:
      - Credentials
      parameters:
      - name: accountId
        in: path
        required: true
        description: The account identifier for the credential
        schema:
          type: string
      responses:
        '200':
          description: Credential opened successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyCredential'
        '404':
          description: Credential not found
    delete:
      operationId: deleteKeyCredential
      summary: Microsoft Windows 10 Delete a key credential
      description: Deletes a Windows Hello key credential using KeyCredentialManager.DeleteAsync. Removes the key pair from the device.
      tags:
      - Credentials
      parameters:
      - name: accountId
        in: path
        required: true
        description: The account identifier for the credential
        schema:
          type: string
      responses:
        '204':
          description: Credential deleted
        '404':
          description: Credential not found
components:
  schemas:
    KeyCredential:
      type: object
      description: A Windows Hello key credential
      properties:
        accountId:
          type: string
          description: Account identifier
        publicKey:
          type: string
          format: byte
          description: Base64-encoded public key (COSE format)
        status:
          type: string
          enum:
          - Success
          - UserCanceled
          - NotFound
          - UserPrefersPassword
          - CredentialAlreadyExists
          description: Credential operation status
        keyName:
          type: string
          description: Key name
      required:
      - accountId
      - status
    CreateCredentialRequest:
      type: object
      properties:
        accountId:
          type: string
          description: Unique account identifier
        keyCreationOption:
          type: string
          enum:
          - ReplaceExisting
          - FailIfExists
          default: ReplaceExisting
      required:
      - accountId
externalDocs:
  description: Background Tasks Documentation
  url: https://learn.microsoft.com/en-us/windows/apps/windows-app-sdk/applifecycle/background-tasks