Extension Field Registry

x-oai-deviceAuthorization - A device authorization OAuth2 flow, used when targeting OpenAPI versions prior to 3.2.

OpenAPI 3.2 introduced the deviceAuthorization field on OAuth Flows Objects to define a device authorization OAuth2 flow.

The x-oai-deviceAuthorization extension brings this same capability to OpenAPI versions prior to 3.2, allowing you to define a device authorization OAuth2 flow.

Use this extension only with OpenAPI versions before 3.2; OpenAPI 3.2 and later define deviceAuthorization directly.

It can appear as a property in the following objects: ["OAuth Flows Object"].

Used by: (informational)

• Microsoft.OpenApi (.NET OpenAPI library)

Schema

{"$ref"=>"#/$defs/oauthFlowObject"}

Example

openapi: 3.1.0
info:
  title: My API
  version: 1.0.0
paths: {}
components:
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        x-oai-deviceAuthorization:
          authorizationUrl: https://auth.example.com/authorize
          tokenUrl: https://auth.example.com/token
          x-oai-deviceAuthorizationUrl: https://auth.example.com/device
          scopes:
            read: Read access