MultiFactorAuthenticationApi

All URIs are relative to https://your-api-subdomain.onelogin.com

Method	HTTP request	Description
createDeviceVerification	POST /api/2/mfa/users/{user_id}/verifications	Create Device Verification
createFactorRegistration	POST /api/2/mfa/users/{user_id}/registrations	Create Factor Registration
deleteEnrolledFactor	DELETE /api/2/mfa/users/{user_id}/devices/{device_id}	Delete Enrolled Factor
generateOTP	POST /api/2/mfa/users/{user_id}/mfa_token	Generate MFA token
getAuthFactors	GET /api/2/mfa/users/{user_id}/factors	Get User Factors
getAuthenticationDevices	GET /api/2/mfa/users/{user_id}/devices	Get User Devices
getUserRegistration	GET /api/2/mfa/users/{user_id}/registrations/{registration_id}	Get User Registration
getUserVerification	GET /api/2/mfa/users/{user_id}/verifications/{verification_id}	Get User Verification
verifyUserRegistration	PUT /api/2/mfa/users/{user_id}/registrations/{registration_id}	Verify User Registration
verifyUserVerification	PUT /api/2/mfa/users/{user_id}/verifications/{verification_id}	Verify User Verification

createDeviceVerification

CreateDeviceVerification201Response createDeviceVerification(userId, contentType, createDeviceVerificationRequest)

Create Device Verification

Create a new verification process

Example

// Import classes:
import com.onelogin.client.ApiClient;
import com.onelogin.client.ApiException;
import com.onelogin.client.Configuration;
import com.onelogin.client.auth.*;
import com.onelogin.client.models.*;
import com.onelogin.client.api.MultiFactorAuthenticationApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://your-api-subdomain.onelogin.com");
    
    // Configure OAuth2 access token for authorization: OAuth2
    OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
    OAuth2.setAccessToken("YOUR ACCESS TOKEN");

    MultiFactorAuthenticationApi apiInstance = new MultiFactorAuthenticationApi(defaultClient);
    Integer userId = 56; // Integer | Set to the id of the user that you want to return.
    String contentType = "application/json"; // String | 
    CreateDeviceVerificationRequest createDeviceVerificationRequest = new CreateDeviceVerificationRequest(); // CreateDeviceVerificationRequest | 
    try {
      CreateDeviceVerification201Response result = apiInstance.createDeviceVerification(userId, contentType, createDeviceVerificationRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MultiFactorAuthenticationApi#createDeviceVerification");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
userId	Integer	Set to the id of the user that you want to return.
contentType	String		[optional] [default to application/json]
createDeviceVerificationRequest	CreateDeviceVerificationRequest		[optional]

Return type

CreateDeviceVerification201Response

Authorization

OAuth2

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Created	* Content-Type -
401	Unauthorized	-

createFactorRegistration

CreateFactorRegistration201Response createFactorRegistration(userId, contentType, createFactorRegistrationRequest)

Create Factor Registration

Create a new registration process

Example

// Import classes:
import com.onelogin.client.ApiClient;
import com.onelogin.client.ApiException;
import com.onelogin.client.Configuration;
import com.onelogin.client.auth.*;
import com.onelogin.client.models.*;
import com.onelogin.client.api.MultiFactorAuthenticationApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://your-api-subdomain.onelogin.com");
    
    // Configure OAuth2 access token for authorization: OAuth2
    OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
    OAuth2.setAccessToken("YOUR ACCESS TOKEN");

    MultiFactorAuthenticationApi apiInstance = new MultiFactorAuthenticationApi(defaultClient);
    Integer userId = 56; // Integer | Set to the id of the user that you want to return.
    String contentType = "application/json"; // String | 
    CreateFactorRegistrationRequest createFactorRegistrationRequest = new CreateFactorRegistrationRequest(); // CreateFactorRegistrationRequest | 
    try {
      CreateFactorRegistration201Response result = apiInstance.createFactorRegistration(userId, contentType, createFactorRegistrationRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MultiFactorAuthenticationApi#createFactorRegistration");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
userId	Integer	Set to the id of the user that you want to return.
contentType	String		[optional] [default to application/json]
createFactorRegistrationRequest	CreateFactorRegistrationRequest		[optional]

Return type

CreateFactorRegistration201Response

Authorization

OAuth2

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Created	* Accept-Language - * Cache-Control - * Content-Length - * Content-Type - * X-Content-Type-Options - * X-Request-Id - * Date -
401	Unauthorized	-

deleteEnrolledFactor

deleteEnrolledFactor(userId, deviceId)

Delete Enrolled Factor

Delete a user\'s authentication device

Example

// Import classes:
import com.onelogin.client.ApiClient;
import com.onelogin.client.ApiException;
import com.onelogin.client.Configuration;
import com.onelogin.client.auth.*;
import com.onelogin.client.models.*;
import com.onelogin.client.api.MultiFactorAuthenticationApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://your-api-subdomain.onelogin.com");
    
    // Configure OAuth2 access token for authorization: OAuth2
    OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
    OAuth2.setAccessToken("YOUR ACCESS TOKEN");

    MultiFactorAuthenticationApi apiInstance = new MultiFactorAuthenticationApi(defaultClient);
    Integer userId = 56; // Integer | Set to the id of the user that you want to return.
    String deviceId = "deviceId_example"; // String | 
    try {
      apiInstance.deleteEnrolledFactor(userId, deviceId);
    } catch (ApiException e) {
      System.err.println("Exception when calling MultiFactorAuthenticationApi#deleteEnrolledFactor");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
userId	Integer	Set to the id of the user that you want to return.
deviceId	String

Return type

null (empty response body)

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	No Content	-

generateOTP

GenerateOTP201Response generateOTP(userId, contentType, generateOTPRequest)

Generate MFA token

Create new MFA token on the user's account

Example

// Import classes:
import com.onelogin.client.ApiClient;
import com.onelogin.client.ApiException;
import com.onelogin.client.Configuration;
import com.onelogin.client.auth.*;
import com.onelogin.client.models.*;
import com.onelogin.client.api.MultiFactorAuthenticationApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://your-api-subdomain.onelogin.com");
    
    // Configure OAuth2 access token for authorization: OAuth2
    OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
    OAuth2.setAccessToken("YOUR ACCESS TOKEN");

    MultiFactorAuthenticationApi apiInstance = new MultiFactorAuthenticationApi(defaultClient);
    Integer userId = 56; // Integer | Set to the id of the user that you want to return.
    String contentType = "application/json"; // String | 
    GenerateOTPRequest generateOTPRequest = new GenerateOTPRequest(); // GenerateOTPRequest | 
    try {
      GenerateOTP201Response result = apiInstance.generateOTP(userId, contentType, generateOTPRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MultiFactorAuthenticationApi#generateOTP");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
userId	Integer	Set to the id of the user that you want to return.
contentType	String		[optional] [default to application/json]
generateOTPRequest	GenerateOTPRequest		[optional]

Return type

GenerateOTP201Response

Authorization

OAuth2

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Created	* Content-Type -
401	Unauthorized	-
422	Unprocessable Entity	-

getAuthFactors

GetAuthFactors200Response getAuthFactors(userId)

Get User Factors

Get a user\'s available authentication factors

Example

// Import classes:
import com.onelogin.client.ApiClient;
import com.onelogin.client.ApiException;
import com.onelogin.client.Configuration;
import com.onelogin.client.auth.*;
import com.onelogin.client.models.*;
import com.onelogin.client.api.MultiFactorAuthenticationApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://your-api-subdomain.onelogin.com");
    
    // Configure OAuth2 access token for authorization: OAuth2
    OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
    OAuth2.setAccessToken("YOUR ACCESS TOKEN");

    MultiFactorAuthenticationApi apiInstance = new MultiFactorAuthenticationApi(defaultClient);
    Integer userId = 56; // Integer | Set to the id of the user that you want to return.
    try {
      GetAuthFactors200Response result = apiInstance.getAuthFactors(userId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MultiFactorAuthenticationApi#getAuthFactors");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
userId	Integer	Set to the id of the user that you want to return.

Return type

GetAuthFactors200Response

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	* Content-Type -
401	Unauthorized	-

getAuthenticationDevices

List<GetAuthenticationDevices200ResponseInner> getAuthenticationDevices(userId)

Get User Devices

Get a user authentication devices

Example

// Import classes:
import com.onelogin.client.ApiClient;
import com.onelogin.client.ApiException;
import com.onelogin.client.Configuration;
import com.onelogin.client.auth.*;
import com.onelogin.client.models.*;
import com.onelogin.client.api.MultiFactorAuthenticationApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://your-api-subdomain.onelogin.com");
    
    // Configure OAuth2 access token for authorization: OAuth2
    OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
    OAuth2.setAccessToken("YOUR ACCESS TOKEN");

    MultiFactorAuthenticationApi apiInstance = new MultiFactorAuthenticationApi(defaultClient);
    Integer userId = 56; // Integer | Set to the id of the user that you want to return.
    try {
      List<GetAuthenticationDevices200ResponseInner> result = apiInstance.getAuthenticationDevices(userId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MultiFactorAuthenticationApi#getAuthenticationDevices");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
userId	Integer	Set to the id of the user that you want to return.

Return type

List<GetAuthenticationDevices200ResponseInner>

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized	-

getUserRegistration

Object getUserRegistration(userId, registrationId)

Get User Registration

Get registration state by id

Example

// Import classes:
import com.onelogin.client.ApiClient;
import com.onelogin.client.ApiException;
import com.onelogin.client.Configuration;
import com.onelogin.client.auth.*;
import com.onelogin.client.models.*;
import com.onelogin.client.api.MultiFactorAuthenticationApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://your-api-subdomain.onelogin.com");
    
    // Configure OAuth2 access token for authorization: OAuth2
    OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
    OAuth2.setAccessToken("YOUR ACCESS TOKEN");

    MultiFactorAuthenticationApi apiInstance = new MultiFactorAuthenticationApi(defaultClient);
    Integer userId = 56; // Integer | Set to the id of the user that you want to return.
    String registrationId = "<UUID>"; // String | The id of a registration
    try {
      Object result = apiInstance.getUserRegistration(userId, registrationId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MultiFactorAuthenticationApi#getUserRegistration");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
userId	Integer	Set to the id of the user that you want to return.
registrationId	String	The id of a registration

Return type

Object

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	* Accept-Language - * Cache-Control - * Content-Length - * Content-Type - * X-Content-Type-Options - * X-Request-Id - * Date -
401	Unauthorized	-

getUserVerification

GetUserVerification200Response getUserVerification(userId, verificationId)

Get User Verification

Get verification state by id

Example

// Import classes:
import com.onelogin.client.ApiClient;
import com.onelogin.client.ApiException;
import com.onelogin.client.Configuration;
import com.onelogin.client.auth.*;
import com.onelogin.client.models.*;
import com.onelogin.client.api.MultiFactorAuthenticationApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://your-api-subdomain.onelogin.com");
    
    // Configure OAuth2 access token for authorization: OAuth2
    OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
    OAuth2.setAccessToken("YOUR ACCESS TOKEN");

    MultiFactorAuthenticationApi apiInstance = new MultiFactorAuthenticationApi(defaultClient);
    Integer userId = 56; // Integer | Set to the id of the user that you want to return.
    String verificationId = "<UUID>"; // String | The verification_id is returned on activation of the factor or you can get the device_id using the Activate Factor API call.
    try {
      GetUserVerification200Response result = apiInstance.getUserVerification(userId, verificationId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MultiFactorAuthenticationApi#getUserVerification");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
userId	Integer	Set to the id of the user that you want to return.
verificationId	String	The verification_id is returned on activation of the factor or you can get the device_id using the Activate Factor API call.

Return type

GetUserVerification200Response

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized	-
404	Not Found	-

verifyUserRegistration

VerifyUserRegistration200Response verifyUserRegistration(userId, registrationId, contentType, verifyUserRegistrationRequest)

Verify User Registration

Submit an otp for verification.

Example

// Import classes:
import com.onelogin.client.ApiClient;
import com.onelogin.client.ApiException;
import com.onelogin.client.Configuration;
import com.onelogin.client.auth.*;
import com.onelogin.client.models.*;
import com.onelogin.client.api.MultiFactorAuthenticationApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://your-api-subdomain.onelogin.com");
    
    // Configure OAuth2 access token for authorization: OAuth2
    OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
    OAuth2.setAccessToken("YOUR ACCESS TOKEN");

    MultiFactorAuthenticationApi apiInstance = new MultiFactorAuthenticationApi(defaultClient);
    Integer userId = 56; // Integer | Set to the id of the user that you want to return.
    String registrationId = "<UUID>"; // String | The id of a registration
    String contentType = "application/json"; // String | 
    VerifyUserRegistrationRequest verifyUserRegistrationRequest = new VerifyUserRegistrationRequest(); // VerifyUserRegistrationRequest | 
    try {
      VerifyUserRegistration200Response result = apiInstance.verifyUserRegistration(userId, registrationId, contentType, verifyUserRegistrationRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MultiFactorAuthenticationApi#verifyUserRegistration");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
userId	Integer	Set to the id of the user that you want to return.
registrationId	String	The id of a registration
contentType	String		[optional] [default to application/json]
verifyUserRegistrationRequest	VerifyUserRegistrationRequest		[optional]

Return type

VerifyUserRegistration200Response

Authorization

OAuth2

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	* Accept-Language - * Cache-Control - * Content-Length - * Content-Type - * X-Content-Type-Options - * X-Request-Id - * Date -
401	Unauthorized	-

verifyUserVerification

Error verifyUserVerification(userId, verificationId, contentType, verifyUserVerificationRequest)

Verify User Verification

Submit an otp for verification.

Example

// Import classes:
import com.onelogin.client.ApiClient;
import com.onelogin.client.ApiException;
import com.onelogin.client.Configuration;
import com.onelogin.client.auth.*;
import com.onelogin.client.models.*;
import com.onelogin.client.api.MultiFactorAuthenticationApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://your-api-subdomain.onelogin.com");
    
    // Configure OAuth2 access token for authorization: OAuth2
    OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
    OAuth2.setAccessToken("YOUR ACCESS TOKEN");

    MultiFactorAuthenticationApi apiInstance = new MultiFactorAuthenticationApi(defaultClient);
    Integer userId = 56; // Integer | Set to the id of the user that you want to return.
    String verificationId = "<UUID>"; // String | The verification_id is returned on activation of the factor or you can get the device_id using the Activate Factor API call.
    String contentType = "application/json"; // String | 
    VerifyUserVerificationRequest verifyUserVerificationRequest = new VerifyUserVerificationRequest(); // VerifyUserVerificationRequest | 
    try {
      Error result = apiInstance.verifyUserVerification(userId, verificationId, contentType, verifyUserVerificationRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MultiFactorAuthenticationApi#verifyUserVerification");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
userId	Integer	Set to the id of the user that you want to return.
verificationId	String	The verification_id is returned on activation of the factor or you can get the device_id using the Activate Factor API call.
contentType	String		[optional] [default to application/json]
verifyUserVerificationRequest	VerifyUserVerificationRequest		[optional]

Return type

Error

Authorization

OAuth2

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	* Content-Type -
401	Unauthorized	-
403	Forbidden	-

Files

MultiFactorAuthenticationApi.md

Latest commit

History

MultiFactorAuthenticationApi.md

File metadata and controls

MultiFactorAuthenticationApi

createDeviceVerification

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

createFactorRegistration

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteEnrolledFactor

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

generateOTP

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getAuthFactors

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getAuthenticationDevices

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getUserRegistration

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getUserVerification

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

verifyUserRegistration

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

verifyUserVerification

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details