EnableRadius - AWS Directory Service


Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.

Request Syntax

{ "DirectoryId": "string", "RadiusSettings": { "AuthenticationProtocol": "string", "DisplayLabel": "string", "RadiusPort": number, "RadiusRetries": number, "RadiusServers": [ "string" ], "RadiusTimeout": number, "SharedSecret": "string", "UseSameUsername": boolean } }

Request Parameters

The request accepts the following data in JSON format.


The identifier of the directory for which to enable MFA.

Type: String

Pattern: ^d-[0-9a-f]{10}$

Required: Yes


A RadiusSettings object that contains information about the RADIUS server.

Type: RadiusSettings object

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.


For information about the errors that are common to all actions, see Common Errors.


A client exception has occurred.

HTTP Status Code: 400


The specified entity already exists.

HTTP Status Code: 400


The specified entity could not be found.

HTTP Status Code: 400


One or more parameters are not valid.

HTTP Status Code: 400


An exception has occurred in AWS Directory Service.

HTTP Status Code: 500


The following examples are formatted for legibility.

Example Request

This example illustrates one usage of EnableRadius.

POST / HTTP/1.1 Host: ds.us-west-2.amazonaws.com Accept-Encoding: identity Content-Length: 259 X-Amz-Target: DirectoryService_20150416.EnableRadius X-Amz-Date: 20161214T214103Z User-Agent: aws-cli/1.11.24 Python/2.7.9 Windows/7 botocore/1.4.81 Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAI7E3BYXS3example/20161214/us-west-2/ds/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=4ba918cf440a45fddd5fcd1bd65207f94e760cebbd7de404d0096c6b1e652d4e { "DirectoryId":"d-926example", "RadiusSettings":{ "DisplayLabel":"MyRadius", "UseSameUsername":true, "RadiusTimeout":1, "AuthenticationProtocol":"PAP", "RadiusPort":1200, "RadiusRetries":2, "SharedSecret":"12345678", "RadiusServers":[ "" ] } }

Example Response

This example illustrates one usage of EnableRadius.

HTTP/1.1 200 OK x-amzn-RequestId: 045cabd8-c246-11e6-ad7a-a9557d30f017 Content-Type: application/x-amz-json-1.1 Content-Length: 2 Date: Wed, 14 Dec 2016 21:41:05 GMT { }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: