PUT /api/businesses/{BusinessID}/twofasettings

Updates information about the two-factor authentication (2FA) settings for the business.

Note: When you change a setting, it might take up to five minutes for the change to take effect.

Authorization Roles/Permissions: Site Admin.

This topic includes the following sections:

HTTP Method

PUT

URL

https://{hostname}/api/businesses/{BusinessID}/twofasettings

Sample Request

The example below shows a request to modify the 2FA settings for the business. The cookie name is set, and MaxAttempts is increased to 4.

Sample Request URL

https://{hostname}/api/businesses/businesses/tenantbusiness.acmepaymentscorp/twofasettings

Sample request headers

Accept: application/vnd.soa.v81+json
Content-Type: application/vnd.soa.v81+json
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

{
  "TwoFAEnabled":"false",
  "CodeValidSeconds":"300",
  "MaxAttempts":"4",
  "RecurrenceMode":"twofa.login.new.device",
  "DeviceCookieName":"2fa_cookie"
}

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header	Description
Accept	application/json, application/xml application/vnd.soa.v72+json, application/vnd.soa.v72+xml application/vnd.soa.v80+json, application/vnd.soa.v80+xml application/vnd.soa.v81+json, application/vnd.soa.v81+xml
Content-Type	Any one of the following media types is valid for the request Content-Type: application/json or application/xml application/vnd.soa.v72+json or application/vnd.soa.v72+xml application/vnd.soa.v80+json or application/vnd.soa.v80+xml application/vnd.soa.v81+json or application/vnd.soa.v81+xml
Cookie	AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies.
X-Csrf-Token_{fedmemberID}	The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Request Parameters

Parameter	Parm Type	Data Type	Required	Description
BusinessID	Path	string	Required	The unique ID for a specific business organization on the platform.
TwoFASettings	Body	TwoFASettings	Required	Contains information about the two-factor authentication settings for the business.

Response

If successful, this operation returns HTTP status code 200, with the updated 2FA settings.

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/vnd.soa.v81+json

Status Code: 200 OK
Content-Type: application/vnd.soa.v81+json
Date: Fri, 29 Apr 2016 14:43:12 GMT

Sample response body: application/vnd.soa.v81+json

{
  "TwoFAEnabled":"false",
  "CodeValidSeconds":"300",
  "MaxAttempts":"4",
  "RecurrenceMode":"twofa.login.new.device",
  "DeviceCookieName":"2fa_cookie"
}

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header	Description
Content-Type	application/json, application/xml application/vnd.soa.v72+json, application/vnd.soa.v72+xml application/vnd.soa.v80+json, application/vnd.soa.v80+xml application/vnd.soa.v81+json, application/vnd.soa.v81+xml

Response Body

Name	Type	Description
TwoFASettings	TwoFASettings	Contains information about the two-factor authentication settings for the business.

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item	Value
401	Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
500	An error occurred processing the call.

More information about Akana API Platform API error messages.

Related Topics