Go to app
Academy
What's new?
Tray UAC
Developer
Connectors
Templates
Help Center
Back
Okta
Overview
Operations (sample payloads)
Operations
Okta Operations
Latest version:
3.4
Changelog
Activate enrollment factor
Activates a specific enrollment factor with a passcode.
Activate user
Activates a user. This operation can only be performed on users with a STAGED status. Activation of a user is an asynchronous operation.
Add user to group
Adds a user to a group with OKTA_GROUP type.
Create group
Creates a new group with OKTA_GROUP type in your organisation.
Create user
Creates a new user in your Okta organisation with or without credentials.
Deactivate user
Deactivates a user. This operation can only be performed on users that do not have a DEPROVISIONED status. Deactivation of a user is an asynchronous operation.
Delete user
Deletes a user permanently. This operation can only be performed on users that have a DEPROVISIONED status. Using this operation on a user that hasn’t been deactivated causes that user to be deactivated. A second delete operation is required to delete the user.
Enroll Okta call factor
Enrolls a user with the Okta call factor and a call profile. A voice call with an OTP is made to the device during enrollment and must be activated.
Enroll Okta email factor
Enrolls a user with an email factor. An email with an OTP is sent to the primary or secondary (depending on which one is enrolled) email address of the user during enrollment.
Enroll Okta security question factor
Enrolls a user with the question factor and question profile.
Enroll Okta SMS factor
Enrolls a user with the Okta SMS factor and an SMS profile. A text message with an OTP is sent to the device during enrollment and must be activated by following the activate link relation to complete the enrollment process.
Enroll Okta verify TOTP factor
Enrolls a user with an Okta token:software:totp factor. The factor must be activated after enrollment by following the activate link to complete the enrollment process.
Get factor
Retrieves a factor for the specified user.
Get group
Retrieves a specific group from your organisation.
Get user
Retrieves a user by id, login, or login shortname (if the shortname is unambiguous).
Get user profile custom field
Retrieves a single user profile custom fields.
Get user schema
Retrieves the schema for a type of user schema.
Get user schema DDL
Get user schema property
Retrieves the schema property for the default type of user schema.
Get user type
Retrieves a user type by its ID.
List enrolled factors
Lists all the enrolled factors for the specified user.
List enrolled factors DDL
List factors to enroll
Lists all the supported factors that can be enrolled for the specified user.
List factors to enroll DDL
List group members
Lists users that are a member of a group.
List groups
Lists groups in your organisation.
List groups DDL
List security questions
Lists all available security questions for a user’s question factor.
List security questions DDL
List system logs
Lists your Okta system logs.
List totp providers to enroll DDL
List user profile custom fields
Lists your user profile custom fields.
List user profile custom fields DDL
List user types DDL
List users
Lists users in your organisation.
List users DDL
Raw HTTP request (advanced)
Perform a raw HTTP request with some pre-configuration and processing by the connector, such as authentication.
Reactivate user
Reactivates a user. This operation can only be performed on users with a PROVISIONED status.
Remove user from group
Removes a user from a group with OKTA_GROUP type.
Resends SMS as part of enrollment.
Use the resend link to send another OTP if user doesn’t receive the original activation SMS OTP.
Reset factor
Unenrolls an existing factor for the specified user, allowing the user to enroll a new factor.
Set user password (Admin)
Sets passwords without validating existing user credentials. This is an administrative operation.
Suspend user
Suspends a user. This operation can only be performed on users with an ACTIVE status.
Unlock user
Unlocks a user with a LOCKED_OUT status and returns them to ACTIVE status. Users will be able to login with their current password.
Unsuspend user
Unsuspends a user and returns them to the ACTIVE state. This operation can only be performed on users that have a SUSPENDED status.
Update group
Updates the profile for a group with OKTA_GROUP type from your organisation.
Update user
Updates a user‘s profile or credentials.
Previous
Operations (sample payloads)
