POST /api/v1/users/{userId}/authenticator-enrollments/phone

Creates a Phone authenticator enrollment that's automatically activated

Servers

Path parameters

Name Type Required Description
userId String Yes

ID of an existing Okta user

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
profile Object Yes

Defines the authenticator specific parameters

profile.phoneNumber String Yes

The phone number for a call or sms authenticator enrollment.

authenticatorId String Yes

Unique identifier of the phone authenticator

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.