PUT /api/v1/authenticators/{authenticatorId}

Replaces the properties for an Authenticator identified by authenticatorId

Servers

Path parameters

Name Type Required Description
authenticatorId String Yes

id of the Authenticator

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
id String No

A unique identifier for the Authenticator

created String No

Timestamp when the Authenticator was created

name String No

Display name of the Authenticator

key String No

A human-readable string that identifies the Authenticator

Possible values:

  • "security_question"
  • "onprem_mfa"
  • "okta_email"
  • "smart_card_idp"
  • "symantec_vip"
  • "duo"
  • "external_idp"
  • "okta_verify"
  • "custom_app"
  • "okta_password"
  • "security_key"
  • "yubikey_token"
  • "google_otp"
  • "webauthn"
  • "phone_number"
type String No

The type of Authenticator

Possible values:

  • "security_question"
  • "email"
  • "federated"
  • "phone"
  • "security_key"
  • "password"
  • "app"
status String No

Possible values:

  • "ACTIVE"
  • "INACTIVE"
lastUpdated String No

Timestamp when the Authenticator was last modified

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.