Loading ...

REST API: Check If Two-Factor Authentication Is Enabled | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Users » REST API: Check If Two-Factor Authentication Is Enabled
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 2

REST API: Check If Two-Factor Authentication Is Enabled

0 
 /5
0 (0votes)

Check If Two-Factor Authentication Is Enabled

GET /api/users/{UserID}/2fa/enabled

Check if two-factor authentication is enabled for a particular user. Valid for Communifire version 8.0 and above.

Method Details

HTTP Method
GET
Response Format
JSON
Requires Authentication?
YES
Product Version
8.0 and above
Required Parameters How to use Description
API Key Used in the request URL:
&token=x
OR
Set in header:
request.Headers.Add(Rest-Api-Key, x)

Communifire REST API key for the Communifire portal you are making the call for.
UserID Used in the request URL as a path parameter Unique ID of the user to check.

Example Request

GET https://myintranet.communifire.com/api/users/641/2fa/enabled

Example Response

True/false is returned.

true

 

Please Note The content type that you pass in the header of your request should be application/json.

 

Wiki Index

Pages

Intranet Software