Skip to content

Latest commit

 

History

History
973 lines (755 loc) · 35.2 KB

AuthenticatorApi.md

File metadata and controls

973 lines (755 loc) · 35.2 KB

Okta.Sdk.Api.AuthenticatorApi

All URIs are relative to https://subdomain.okta.com

Method HTTP request Description
ActivateAuthenticator POST /api/v1/authenticators/{authenticatorId}/lifecycle/activate Activate an Authenticator
ActivateAuthenticatorMethod POST /api/v1/authenticators/{authenticatorId}/methods/{methodType}/lifecycle/activate Activate an Authenticator Method
CreateAuthenticator POST /api/v1/authenticators Create an Authenticator
DeactivateAuthenticator POST /api/v1/authenticators/{authenticatorId}/lifecycle/deactivate Deactivate an Authenticator
DeactivateAuthenticatorMethod POST /api/v1/authenticators/{authenticatorId}/methods/{methodType}/lifecycle/deactivate Deactivate an Authenticator Method
GetAuthenticator GET /api/v1/authenticators/{authenticatorId} Retrieve an Authenticator
GetAuthenticatorMethod GET /api/v1/authenticators/{authenticatorId}/methods/{methodType} Retrieve an Authenticator Method
GetWellKnownAppAuthenticatorConfiguration GET /.well-known/app-authenticator-configuration Retrieve the Well-Known App Authenticator Configuration
ListAuthenticatorMethods GET /api/v1/authenticators/{authenticatorId}/methods List all Methods of an Authenticator
ListAuthenticators GET /api/v1/authenticators List all Authenticators
ReplaceAuthenticator PUT /api/v1/authenticators/{authenticatorId} Replace an Authenticator
ReplaceAuthenticatorMethod PUT /api/v1/authenticators/{authenticatorId}/methods/{methodType} Replace an Authenticator Method

ActivateAuthenticator

AuthenticatorBase ActivateAuthenticator (string authenticatorId)

Activate an Authenticator

Activates an authenticator by authenticatorId

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class ActivateAuthenticatorExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AuthenticatorApi(config);
            var authenticatorId = aut1nd8PQhGcQtSxB0g4;  // string | `id` of the Authenticator

            try
            {
                // Activate an Authenticator
                AuthenticatorBase result = apiInstance.ActivateAuthenticator(authenticatorId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AuthenticatorApi.ActivateAuthenticator: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
authenticatorId string `id` of the Authenticator

Return type

AuthenticatorBase

Authorization

apiToken, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
403 Forbidden -
404 Not Found -
429 Too Many Requests -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ActivateAuthenticatorMethod

AuthenticatorMethodBase ActivateAuthenticatorMethod (string authenticatorId, AuthenticatorMethodType methodType)

Activate an Authenticator Method

Activates a Method for an Authenticator identified by authenticatorId and methodType > Note: <x-lifecycle class="ea"> > The AAGUID Group object supports the Early Access (Self-Service) Allow List for FIDO2 (WebAuthn) Authenticators feature. Enable the feature for your org from the Settings > Features page in the Admin Console. > This feature has several limitations when enrolling a security key: > - Enrollment is currently unsupported on Firefox. > - Enrollment is currently unsupported on Chrome if User Verification is set to DISCOURAGED and a PIN is set on the security key. > - If prompted during enrollment, users must allow Okta to see the make and model of the security key.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class ActivateAuthenticatorMethodExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AuthenticatorApi(config);
            var authenticatorId = aut1nd8PQhGcQtSxB0g4;  // string | `id` of the Authenticator
            var methodType = (AuthenticatorMethodType) "cert";  // AuthenticatorMethodType | Type of authenticator method

            try
            {
                // Activate an Authenticator Method
                AuthenticatorMethodBase result = apiInstance.ActivateAuthenticatorMethod(authenticatorId, methodType);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AuthenticatorApi.ActivateAuthenticatorMethod: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
authenticatorId string `id` of the Authenticator
methodType AuthenticatorMethodType Type of authenticator method

Return type

AuthenticatorMethodBase

Authorization

apiToken, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
403 Forbidden -
404 Not Found -
429 Too Many Requests -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateAuthenticator

AuthenticatorBase CreateAuthenticator (AuthenticatorBase authenticator, bool? activate = null)

Create an Authenticator

Creates an authenticator

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class CreateAuthenticatorExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AuthenticatorApi(config);
            var authenticator = new AuthenticatorBase(); // AuthenticatorBase | 
            var activate = true;  // bool? | Whether to execute the activation lifecycle operation when Okta creates the authenticator (optional)  (default to true)

            try
            {
                // Create an Authenticator
                AuthenticatorBase result = apiInstance.CreateAuthenticator(authenticator, activate);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AuthenticatorApi.CreateAuthenticator: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
authenticator AuthenticatorBase
activate bool? Whether to execute the activation lifecycle operation when Okta creates the authenticator [optional] [default to true]

Return type

AuthenticatorBase

Authorization

apiToken, oauth2

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Forbidden -
429 Too Many Requests -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeactivateAuthenticator

AuthenticatorBase DeactivateAuthenticator (string authenticatorId)

Deactivate an Authenticator

Deactivates an authenticator by authenticatorId

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class DeactivateAuthenticatorExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AuthenticatorApi(config);
            var authenticatorId = aut1nd8PQhGcQtSxB0g4;  // string | `id` of the Authenticator

            try
            {
                // Deactivate an Authenticator
                AuthenticatorBase result = apiInstance.DeactivateAuthenticator(authenticatorId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AuthenticatorApi.DeactivateAuthenticator: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
authenticatorId string `id` of the Authenticator

Return type

AuthenticatorBase

Authorization

apiToken, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
403 Forbidden -
404 Not Found -
429 Too Many Requests -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeactivateAuthenticatorMethod

AuthenticatorMethodBase DeactivateAuthenticatorMethod (string authenticatorId, AuthenticatorMethodType methodType)

Deactivate an Authenticator Method

Deactivates a Method for an Authenticator identified by authenticatorId and methodType > Note: <x-lifecycle class="ea"> > The AAGUID Group object supports the Early Access (Self-Service) Allow List for FIDO2 (WebAuthn) Authenticators feature. Enable the feature for your org from the Settings > Features page in the Admin Console. > This feature has several limitations when enrolling a security key: > - Enrollment is currently unsupported on Firefox. > - Enrollment is currently unsupported on Chrome if User Verification is set to DISCOURAGED and a PIN is set on the security key. > - If prompted during enrollment, users must allow Okta to see the make and model of the security key.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class DeactivateAuthenticatorMethodExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AuthenticatorApi(config);
            var authenticatorId = aut1nd8PQhGcQtSxB0g4;  // string | `id` of the Authenticator
            var methodType = (AuthenticatorMethodType) "cert";  // AuthenticatorMethodType | Type of authenticator method

            try
            {
                // Deactivate an Authenticator Method
                AuthenticatorMethodBase result = apiInstance.DeactivateAuthenticatorMethod(authenticatorId, methodType);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AuthenticatorApi.DeactivateAuthenticatorMethod: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
authenticatorId string `id` of the Authenticator
methodType AuthenticatorMethodType Type of authenticator method

Return type

AuthenticatorMethodBase

Authorization

apiToken, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
403 Forbidden -
404 Not Found -
429 Too Many Requests -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAuthenticator

AuthenticatorBase GetAuthenticator (string authenticatorId)

Retrieve an Authenticator

Retrieves an authenticator from your Okta organization by authenticatorId

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class GetAuthenticatorExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AuthenticatorApi(config);
            var authenticatorId = aut1nd8PQhGcQtSxB0g4;  // string | `id` of the Authenticator

            try
            {
                // Retrieve an Authenticator
                AuthenticatorBase result = apiInstance.GetAuthenticator(authenticatorId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AuthenticatorApi.GetAuthenticator: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
authenticatorId string `id` of the Authenticator

Return type

AuthenticatorBase

Authorization

apiToken, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
403 Forbidden -
404 Not Found -
429 Too Many Requests -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAuthenticatorMethod

AuthenticatorMethodBase GetAuthenticatorMethod (string authenticatorId, AuthenticatorMethodType methodType)

Retrieve an Authenticator Method

Retrieves a Method identified by methodType of an Authenticator identified by authenticatorId > Note: <x-lifecycle class="ea"> > The AAGUID Group object supports the Early Access (Self-Service) Allow List for FIDO2 (WebAuthn) Authenticators feature. Enable the feature for your org from the Settings > Features page in the Admin Console. > This feature has several limitations when enrolling a security key: > - Enrollment is currently unsupported on Firefox. > - Enrollment is currently unsupported on Chrome if User Verification is set to DISCOURAGED and a PIN is set on the security key. > - If prompted during enrollment, users must allow Okta to see the make and model of the security key.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class GetAuthenticatorMethodExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AuthenticatorApi(config);
            var authenticatorId = aut1nd8PQhGcQtSxB0g4;  // string | `id` of the Authenticator
            var methodType = (AuthenticatorMethodType) "cert";  // AuthenticatorMethodType | Type of authenticator method

            try
            {
                // Retrieve an Authenticator Method
                AuthenticatorMethodBase result = apiInstance.GetAuthenticatorMethod(authenticatorId, methodType);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AuthenticatorApi.GetAuthenticatorMethod: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
authenticatorId string `id` of the Authenticator
methodType AuthenticatorMethodType Type of authenticator method

Return type

AuthenticatorMethodBase

Authorization

apiToken, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
403 Forbidden -
404 Not Found -
429 Too Many Requests -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetWellKnownAppAuthenticatorConfiguration

List<WellKnownAppAuthenticatorConfiguration> GetWellKnownAppAuthenticatorConfiguration (string oauthClientId)

Retrieve the Well-Known App Authenticator Configuration

Retrieves the well-known app authenticator configuration. Includes an app authenticator's settings, supported methods, and other details.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class GetWellKnownAppAuthenticatorConfigurationExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            var apiInstance = new AuthenticatorApi(config);
            var oauthClientId = "oauthClientId_example";  // string | Filters app authenticator configurations by `oauthClientId`

            try
            {
                // Retrieve the Well-Known App Authenticator Configuration
                List<WellKnownAppAuthenticatorConfiguration> result = apiInstance.GetWellKnownAppAuthenticatorConfiguration(oauthClientId).ToListAsync();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AuthenticatorApi.GetWellKnownAppAuthenticatorConfiguration: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
oauthClientId string Filters app authenticator configurations by `oauthClientId`

Return type

List<WellKnownAppAuthenticatorConfiguration>

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
429 Too Many Requests -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListAuthenticatorMethods

List<AuthenticatorMethodBase> ListAuthenticatorMethods (string authenticatorId)

List all Methods of an Authenticator

Lists all Methods of an Authenticator identified by authenticatorId > Note: <x-lifecycle class="ea"> > The AAGUID Group object supports the Early Access (Self-Service) Allow List for FIDO2 (WebAuthn) Authenticators feature. Enable the feature for your org from the Settings > Features page in the Admin Console. > This feature has several limitations when enrolling a security key: > - Enrollment is currently unsupported on Firefox. > - Enrollment is currently unsupported on Chrome if User Verification is set to DISCOURAGED and a PIN is set on the security key. > - If prompted during enrollment, users must allow Okta to see the make and model of the security key.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class ListAuthenticatorMethodsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AuthenticatorApi(config);
            var authenticatorId = aut1nd8PQhGcQtSxB0g4;  // string | `id` of the Authenticator

            try
            {
                // List all Methods of an Authenticator
                List<AuthenticatorMethodBase> result = apiInstance.ListAuthenticatorMethods(authenticatorId).ToListAsync();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AuthenticatorApi.ListAuthenticatorMethods: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
authenticatorId string `id` of the Authenticator

Return type

List<AuthenticatorMethodBase>

Authorization

apiToken, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
403 Forbidden -
404 Not Found -
429 Too Many Requests -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListAuthenticators

List<AuthenticatorBase> ListAuthenticators ()

List all Authenticators

Lists all authenticators

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class ListAuthenticatorsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AuthenticatorApi(config);

            try
            {
                // List all Authenticators
                List<AuthenticatorBase> result = apiInstance.ListAuthenticators().ToListAsync();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AuthenticatorApi.ListAuthenticators: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

List<AuthenticatorBase>

Authorization

apiToken, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
403 Forbidden -
429 Too Many Requests -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ReplaceAuthenticator

AuthenticatorBase ReplaceAuthenticator (string authenticatorId, AuthenticatorBase authenticator)

Replace an Authenticator

Replaces the properties for an Authenticator identified by authenticatorId

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class ReplaceAuthenticatorExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AuthenticatorApi(config);
            var authenticatorId = aut1nd8PQhGcQtSxB0g4;  // string | `id` of the Authenticator
            var authenticator = new AuthenticatorBase(); // AuthenticatorBase | 

            try
            {
                // Replace an Authenticator
                AuthenticatorBase result = apiInstance.ReplaceAuthenticator(authenticatorId, authenticator);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AuthenticatorApi.ReplaceAuthenticator: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
authenticatorId string `id` of the Authenticator
authenticator AuthenticatorBase

Return type

AuthenticatorBase

Authorization

apiToken, oauth2

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Forbidden -
404 Not Found -
429 Too Many Requests -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ReplaceAuthenticatorMethod

AuthenticatorMethodBase ReplaceAuthenticatorMethod (string authenticatorId, AuthenticatorMethodType methodType, AuthenticatorMethodBase authenticatorMethodBase = null)

Replace an Authenticator Method

Replaces a Method of methodType for an Authenticator identified by authenticatorId > Note: <x-lifecycle class="ea"> > The AAGUID Group object supports the Early Access (Self-Service) Allow List for FIDO2 (WebAuthn) Authenticators feature. Enable the feature for your org from the Settings > Features page in the Admin Console. > This feature has several limitations when enrolling a security key: > - Enrollment is currently unsupported on Firefox. > - Enrollment is currently unsupported on Chrome if User Verification is set to DISCOURAGED and a PIN is set on the security key. > - If prompted during enrollment, users must allow Okta to see the make and model of the security key.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class ReplaceAuthenticatorMethodExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AuthenticatorApi(config);
            var authenticatorId = aut1nd8PQhGcQtSxB0g4;  // string | `id` of the Authenticator
            var methodType = (AuthenticatorMethodType) "cert";  // AuthenticatorMethodType | Type of authenticator method
            var authenticatorMethodBase = new AuthenticatorMethodBase(); // AuthenticatorMethodBase |  (optional) 

            try
            {
                // Replace an Authenticator Method
                AuthenticatorMethodBase result = apiInstance.ReplaceAuthenticatorMethod(authenticatorId, methodType, authenticatorMethodBase);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AuthenticatorApi.ReplaceAuthenticatorMethod: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
authenticatorId string `id` of the Authenticator
methodType AuthenticatorMethodType Type of authenticator method
authenticatorMethodBase AuthenticatorMethodBase [optional]

Return type

AuthenticatorMethodBase

Authorization

apiToken, oauth2

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
403 Forbidden -
404 Not Found -
429 Too Many Requests -

[Back to top] [Back to API list] [Back to Model list] [Back to README]