Skip to content

Latest commit

 

History

History
178 lines (140 loc) · 3.32 KB

authentication.md

File metadata and controls

178 lines (140 loc) · 3.32 KB
Raw

Authentication in generated SDKs

Autorest only supports 2 types of authentication, any other will need to be handled manually:

  • oauth2: Represent an OAuth2 authentication
  • apiKey with in: header: Represent an api key authentication sent via header

This can be either configured in OpenAPI spec or using flags/config

Configure in OpenAPI

This uses OpenAPI security model

AAD Token authentication

  • OpenAPI 3
{
  "components": {
    "securitySchemes": {
      "AADToken": {
        "type": "oauth2",
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "https://login.microsoftonline.com/common/v2.0/oauth2/authorize",
            "tokenUrl": "https://login.microsoftonline.com/common/v2.0/oauth2/token"
          }
        }
      }
    }
  },
  "security": [
    {
      "AADToken": ["https://myservice.azure.com/.default"]
    }
  ]
}
  • Swagger 2.0
{
  "securityDefinitions": {
    "AADToken": {
      "type": "oauth2",
      "flow": "accessCode",
      "authorizationUrl": "https://login.microsoftonline.com/common/v2.0/oauth2/authorize",
      "tokenUrl": "https://login.microsoftonline.com/common/v2.0/oauth2/token"
    }
  },
  "security": [
    {
      "AADToken": ["https://myservice.azure.com/.default"]
    }
  ]
}

Alternatively instead of using a $ref you can

Key authentication

  • OpenAPI 3
{
  "components": {
    "securitySchemes": {
      "AzureKey": {
        "type": "apiKey",
        "in": "header",
        "name": "my-header-name"
      }
    }
  },
  "security": [
    {
      "AzureKey": []
    }
  ]
}
  • Swagger 2.0
{
  "securityDefinitions": {
    "AzureKey": {
      "type": "apiKey",
      "in": "header",
      "name": "my-header-name"
    }
  },
  "security": [
    {
      "AzureKey": []
    }
  ]
}

Configure using flags/config

There is a few config options that will result in the same generation:

--security

This is a list of the supported security schemes(AADToken | AzureKey).

Example

# For AAD Token  only
security: AADToken

# For Azure key  only
security: AzureKey

# For both
security: [AADToken, AzureKey]

By default:

  • AADToken scope is https://management.azure.com/.default
  • AzureKey header name is Authorization

--security-scopes

To be used with security: AADToken will override the list of scopes.

Example:

security: AADToken
security-scopes:
  - "https://fakeendpoint.azure.com/.default"
  - "https://dummyendpoint.azure.com/.default"

--security-header-name

To be used with security: AzureKey will override the header name.

Example:

security: AzureKey
security-header-name: CustomAuth

--azure-arm

This will automatically configure AADToken credentials with https://management.azure.com/.default scope.

Equivalent to passing

{
  "components": {
    "securitySchemes": {
      "AADToken": {
        "type": "oauth2",
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "https://login.microsoftonline.com/common/v2.0/oauth2/authorize",
            "tokenUrl": "https://login.microsoftonline.com/common/v2.0/oauth2/token"
          }
        }
      }
    }
  },
  "security": [{ "AADToken": ["https://management.azure.com/.default"] }]
}