Amazon Directory Service #X Amz Target=DirectoryService 20150416.EnableRadius API

openapi: 3.2.0
info:
  version: 1.0.0
  x-release: v4
  title: 'AWS Directory Service #X Amz Target=DirectoryService 20150416.AcceptSharedDirectory #X Amz Target=DirectoryService 20150416.AcceptSharedDirectory #X Amz Target=DirectoryService 20150416.EnableRadius #X Amz Target=DirectoryService 20150416.EnableRadius #X Amz Target=DirectoryService 20150416.EnableRadius API'
  description: <fullname>Directory Service</fullname> <p>Directory Service is a web service that makes it easy for you to setup and run directories in the Amazon Web Services cloud, or connect your Amazon Web Services resources with an existing self-managed Microsoft Active Directory. This guide provides detailed information about Directory Service operations, data types, parameters, and errors. For information about Directory Services features, see <a href="https://aws.amazon.com/directoryservice/">Directory Service</a> and the <a href="http://docs.aws.amazon.com/directoryservice/latest/admin-guide/what_is.html">Directory Service Administration Guide</a>.</p> <note> <p>Amazon Web Services provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to Directory Service and other Amazon Web Services services. For more information about the Amazon Web Services SDKs, including how to download and install them, see <a href="http://aws.amazon.com/tools/">Tools for Amazon Web Services</a>.</p> </note>
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: ds
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/ds-2015-04-16.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://ds.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Directory Service multi-region endpoint
- url: https://ds.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Directory Service multi-region endpoint
- url: http://ds.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Directory Service endpoint for China (Beijing) and China (Ningxia)
- url: https://ds.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Directory Service endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=DirectoryService 20150416.EnableRadius'
paths:
  /#X-Amz-Target=DirectoryService_20150416.EnableRadius:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: EnableRadius
      description: Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnableRadiusResult'
        '480':
          description: InvalidParameterException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '481':
          description: EntityAlreadyExistsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityAlreadyExistsException'
        '482':
          description: EntityDoesNotExistException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityDoesNotExistException'
        '483':
          description: ClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientException'
        '484':
          description: ServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceException'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnableRadiusRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - DirectoryService_20150416.EnableRadius
      tags:
      - '#X Amz Target=DirectoryService 20150416.EnableRadius'
components:
  schemas:
    EnableRadiusResult:
      type: object
      properties: {}
      description: Contains the results of the <a>EnableRadius</a> operation.
    ClientException: {}
    PortNumber:
      type: integer
      minimum: 1025
      maximum: 65535
    RadiusDisplayLabel:
      type: string
      minLength: 1
      maxLength: 64
    UseSameUsername:
      type: boolean
    InvalidParameterException: {}
    ServiceException: {}
    RadiusAuthenticationProtocol:
      type: string
      enum:
      - PAP
      - CHAP
      - MS-CHAPv1
      - MS-CHAPv2
    RadiusRetries:
      type: integer
      minimum: 0
      maximum: 10
    RadiusSettings:
      type: object
      properties:
        RadiusServers:
          allOf:
          - $ref: '#/components/schemas/Servers'
          - description: An array of strings that contains the fully qualified domain name (FQDN) or IP addresses of the RADIUS server endpoints, or the FQDN or IP addresses of your RADIUS server load balancer.
        RadiusPort:
          allOf:
          - $ref: '#/components/schemas/PortNumber'
          - description: The port that your RADIUS server is using for communications. Your self-managed network must allow inbound traffic over this port from the Directory Service servers.
        RadiusTimeout:
          allOf:
          - $ref: '#/components/schemas/RadiusTimeout'
          - description: The amount of time, in seconds, to wait for the RADIUS server to respond.
        RadiusRetries:
          allOf:
          - $ref: '#/components/schemas/RadiusRetries'
          - description: The maximum number of times that communication with the RADIUS server is attempted.
        SharedSecret:
          allOf:
          - $ref: '#/components/schemas/RadiusSharedSecret'
          - description: Required for enabling RADIUS on the directory.
        AuthenticationProtocol:
          allOf:
          - $ref: '#/components/schemas/RadiusAuthenticationProtocol'
          - description: The protocol specified for your RADIUS endpoints.
        DisplayLabel:
          allOf:
          - $ref: '#/components/schemas/RadiusDisplayLabel'
          - description: Not currently used.
        UseSameUsername:
          allOf:
          - $ref: '#/components/schemas/UseSameUsername'
          - description: Not currently used.
      description: Contains information about a Remote Authentication Dial In User Service (RADIUS) server.
    DirectoryId:
      type: string
      pattern: ^d-[0-9a-f]{10}$
    RadiusSharedSecret:
      type: string
      pattern: ^(\p{LD}|\p{Punct}| )+$
      minLength: 8
      maxLength: 512
      format: password
    EntityDoesNotExistException: {}
    EntityAlreadyExistsException: {}
    Servers:
      type: array
      items:
        $ref: '#/components/schemas/Server'
    RadiusTimeout:
      type: integer
      minimum: 1
      maximum: 20
    EnableRadiusRequest:
      type: object
      required:
      - DirectoryId
      - RadiusSettings
      title: EnableRadiusRequest
      properties:
        DirectoryId:
          allOf:
          - $ref: '#/components/schemas/DirectoryId'
          - description: The identifier of the directory for which to enable MFA.
        RadiusSettings:
          allOf:
          - $ref: '#/components/schemas/RadiusSettings'
          - description: A <a>RadiusSettings</a> object that contains information about the RADIUS server.
      description: Contains the inputs for the <a>EnableRadius</a> operation.
    Server:
      type: string
      minLength: 1
      maxLength: 256
  parameters:
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/ds/
x-hasEquivalentPaths: true