Microsoft Azure .Well Known API

openapi: 3.2.0
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector .Well Known .Well Known API
tags:
- name: .Well Known
paths:
  /.well-known/did.json:
    get:
      operationId: microsoftAzureGetdidconfig
      description: Get the DID configuration file.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DidDocument'
        default:
          description: An unexpected error response.
          headers:
            x-ms-error-code:
              description: String error code indicating what went wrong.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse'
      x-ms-examples:
        GetDidConfig:
          $ref: ./examples/GetDidConfig.json
      summary: Microsoft Azure Get  Well Known Did Json
      tags:
      - .Well Known
components:
  schemas:
    DidDocument:
      type: object
      description: A DID document
      properties:
        id:
          type: string
          description: String representing a DID issuer.
        assertionMethod:
          type: array
          description: List of public keys used for receipt endorsement verification.
          items:
            $ref: '#/components/schemas/DidDocumentKey'
      required:
      - id
      - assertionMethod
    Azure.Core.Foundations.Error:
      type: object
      description: The error object.
      properties:
        code:
          type: string
          description: One of a server-defined set of error codes.
        message:
          type: string
          description: A human-readable representation of the error.
        target:
          type: string
          description: The target of the error.
        details:
          type: array
          description: An array of details about specific errors that led to this reported error.
          items:
            $ref: '#/components/schemas/Azure.Core.Foundations.Error'
          x-ms-identifiers: []
        innererror:
          $ref: '#/components/schemas/Azure.Core.Foundations.InnerError'
          description: An object containing more specific information than the current object about the error.
      required:
      - code
      - message
    Azure.Core.Foundations.InnerError:
      type: object
      description: An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
      properties:
        code:
          type: string
          description: One of a server-defined set of error codes.
        innererror:
          $ref: '#/components/schemas/Azure.Core.Foundations.InnerError'
          description: Inner error.
    Azure.Core.Foundations.ErrorResponse:
      type: object
      description: A response containing error details.
      properties:
        error:
          $ref: '#/components/schemas/Azure.Core.Foundations.Error'
          description: The error object.
      required:
      - error
    DidDocumentKey:
      type: object
      description: A DID document key
      properties:
        id:
          type: string
          description: Key identifier.
        controller:
          type: string
          description: Key controller - similar to DID issuer.
        type:
          type: string
          description: Key type.
          enum:
          - JsonWebKey2020
          x-ms-enum:
            modelAsString: false
        publicKeyJwk:
          $ref: '#/components/schemas/JsonWebKey'
          description: Serialized public key in JWK format.
      required:
      - id
      - controller
      - type
      - publicKeyJwk
    JsonWebKey:
      type: object
      description: rfc7517 JSON Web Key representation adapted from a shared swagger definition in the common types
      properties:
        alg:
          type: string
          description: 'The "alg" (algorithm) parameter identifies the algorithm intended for

            use with the key.  The values used should either be registered in the

            IANA "JSON Web Signature and Encryption Algorithms" registry

            established by [JWA] or be a value that contains a Collision-

            Resistant Name.'
        crv:
          type: string
          description: The "crv" (curve) parameter identifies the curve type
        d:
          type: string
          description: RSA private exponent or ECC private key
        dp:
          type: string
          description: RSA Private Key Parameter
        dq:
          type: string
          description: RSA Private Key Parameter
        e:
          type: string
          description: RSA public exponent, in Base64
        k:
          type: string
          description: Symmetric key
        kid:
          type: string
          description: 'The "kid" (key ID) parameter is used to match a specific key.  This

            is used, for instance, to choose among a set of keys within a JWK Set

            during key rollover.  The structure of the "kid" value is

            unspecified.  When "kid" values are used within a JWK Set, different

            keys within the JWK Set SHOULD use distinct "kid" values.  (One

            example in which different keys might use the same "kid" value is if

            they have different "kty" (key type) values but are considered to be

            equivalent alternatives by the application using them.)  The "kid"

            value is a case-sensitive string.'
        kty:
          type: string
          description: 'The "kty" (key type) parameter identifies the cryptographic algorithm

            family used with the key, such as "RSA" or "EC". "kty" values should

            either be registered in the IANA "JSON Web Key Types" registry

            established by [JWA] or be a value that contains a Collision-

            Resistant Name.  The "kty" value is a case-sensitive string.'
        n:
          type: string
          description: RSA modulus, in Base64
        p:
          type: string
          description: RSA secret prime
        q:
          type: string
          description: RSA secret prime, with p < q
        qi:
          type: string
          description: RSA Private Key Parameter
        use:
          type: string
          description: 'Use ("public key use") identifies the intended use of

            the public key. The "use" parameter is employed to indicate whether

            a public key is used for encrypting data or verifying the signature

            on data. Values are commonly "sig" (signature) or "enc" (encryption).'
        x:
          type: string
          description: X coordinate for the Elliptic Curve point
        x5c:
          type: array
          description: 'The "x5c" (X.509 certificate chain) parameter contains a chain of one

            or more PKIX certificates [RFC5280].  The certificate chain is

            represented as a JSON array of certificate value strings.  Each

            string in the array is a base64-encoded (Section 4 of [RFC4648] --

            not base64url-encoded) DER [ITU.X690.1994] PKIX certificate value.

            The PKIX certificate containing the key value MUST be the first

            certificate.'
          items:
            type: string
        y:
          type: string
          description: Y coordinate for the Elliptic Curve point
      required:
      - kty
  parameters:
    Azure.Core.Foundations.ApiVersionParameter:
      name: api-version
      in: query
      description: The API version to use for this operation.
      required: true
      x-ms-parameter-location: method
      x-ms-client-name: apiVersion
      schema:
        type: string
        minLength: 1
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'