Okta

Manage users and groups in Okta

Okta is an identity and access management platform that provides secure authentication, authorization, and user management for organizations.

With the Okta integration in Sim, you can:

  • List and search users: Retrieve users from your Okta org with SCIM search expressions and filters
  • Manage user lifecycle: Create, activate, deactivate, suspend, unsuspend, and delete users
  • Update user profiles: Modify user attributes like name, email, phone, title, and department
  • Reset passwords: Trigger password reset flows with optional email notification
  • Manage groups: Create, update, delete, and list groups in your organization
  • Manage group membership: Add or remove users from groups, and list group members

In Sim, the Okta integration enables your agents to automate identity management tasks as part of their workflows. This allows for scenarios such as onboarding new employees, offboarding departing users, managing group-based access, auditing user status, and responding to security events by suspending or deactivating accounts.

Need Help?

If you encounter issues with the Okta integration, contact us at help@sim.ai

Usage Instructions

Integrate Okta identity management into your workflow. List, create, update, activate, suspend, and delete users. Reset passwords. Manage groups and group membership.

Tools

okta_list_users

List all users in your Okta organization with optional search and filtering

Input

ParameterTypeRequiredDescription
apiKeystringYesOkta API token for authentication
domainstringYesOkta domain (e.g., dev-123456.okta.com)
searchstringNoOkta search expression (e.g., profile.firstName eq "John" or profile.email co "example.com")
filterstringNoOkta filter expression (e.g., status eq "ACTIVE")
limitnumberNoMaximum number of users to return (default: 200, max: 200)

Output

ParameterTypeDescription
usersarrayArray of Okta user objects
idstringUser ID
statusstringUser status (ACTIVE, STAGED, PROVISIONED, etc.)
firstNamestringFirst name
lastNamestringLast name
emailstringEmail address
loginstringLogin (usually email)
mobilePhonestringMobile phone
titlestringJob title
departmentstringDepartment
createdstringCreation timestamp
lastLoginstringLast login timestamp
lastUpdatedstringLast update timestamp
activatedstringActivation timestamp
statusChangedstringStatus change timestamp
countnumberNumber of users returned
successbooleanOperation success status

okta_get_user

Get a specific user by ID or login from your Okta organization

Input

ParameterTypeRequiredDescription
apiKeystringYesOkta API token for authentication
domainstringYesOkta domain (e.g., dev-123456.okta.com)
userIdstringYesUser ID or login (email) to look up

Output

ParameterTypeDescription
idstringUser ID
statusstringUser status
firstNamestringFirst name
lastNamestringLast name
emailstringEmail address
loginstringLogin (usually email)
mobilePhonestringMobile phone
secondEmailstringSecondary email
displayNamestringDisplay name
titlestringJob title
departmentstringDepartment
organizationstringOrganization
managerstringManager name
managerIdstringManager ID
divisionstringDivision
employeeNumberstringEmployee number
userTypestringUser type
createdstringCreation timestamp
activatedstringActivation timestamp
lastLoginstringLast login timestamp
lastUpdatedstringLast update timestamp
statusChangedstringStatus change timestamp
passwordChangedstringPassword change timestamp
successbooleanOperation success status

okta_create_user

Create a new user in your Okta organization

Input

ParameterTypeRequiredDescription
apiKeystringYesOkta API token for authentication
domainstringYesOkta domain (e.g., dev-123456.okta.com)
firstNamestringYesFirst name of the user
lastNamestringYesLast name of the user
emailstringYesEmail address of the user
loginstringNoLogin for the user (defaults to email if not provided)
passwordstringNoPassword for the user (if not set, user will be emailed to set password)
mobilePhonestringNoMobile phone number
titlestringNoJob title
departmentstringNoDepartment
activatebooleanNoWhether to activate the user immediately (default: true)

Output

ParameterTypeDescription
idstringCreated user ID
statusstringUser status
firstNamestringFirst name
lastNamestringLast name
emailstringEmail address
loginstringLogin
createdstringCreation timestamp
lastUpdatedstringLast update timestamp
successbooleanOperation success status

okta_update_user

Update a user profile in your Okta organization

Input

ParameterTypeRequiredDescription
apiKeystringYesOkta API token for authentication
domainstringYesOkta domain (e.g., dev-123456.okta.com)
userIdstringYesUser ID or login to update
firstNamestringNoUpdated first name
lastNamestringNoUpdated last name
emailstringNoUpdated email address
loginstringNoUpdated login
mobilePhonestringNoUpdated mobile phone number
titlestringNoUpdated job title
departmentstringNoUpdated department

Output

ParameterTypeDescription
idstringUser ID
statusstringUser status
firstNamestringFirst name
lastNamestringLast name
emailstringEmail address
loginstringLogin
createdstringCreation timestamp
lastUpdatedstringLast update timestamp
successbooleanOperation success status

okta_activate_user

Activate a user in your Okta organization. Can only be performed on users with STAGED or DEPROVISIONED status. Optionally sends an activation email.

Input

ParameterTypeRequiredDescription
apiKeystringYesOkta API token for authentication
domainstringYesOkta domain (e.g., dev-123456.okta.com)
userIdstringYesUser ID or login to activate
sendEmailbooleanNoSend activation email to the user (default: true)

Output

ParameterTypeDescription
userIdstringActivated user ID
activatedbooleanWhether the user was activated
activationUrlstringActivation URL (only returned when sendEmail is false)
activationTokenstringActivation token (only returned when sendEmail is false)
successbooleanOperation success status

okta_deactivate_user

Deactivate a user in your Okta organization. This transitions the user to DEPROVISIONED status.

Input

ParameterTypeRequiredDescription
apiKeystringYesOkta API token for authentication
domainstringYesOkta domain (e.g., dev-123456.okta.com)
userIdstringYesUser ID or login to deactivate
sendEmailbooleanNoSend deactivation email to admin (default: false)

Output

ParameterTypeDescription
userIdstringDeactivated user ID
deactivatedbooleanWhether the user was deactivated
successbooleanOperation success status

okta_suspend_user

Suspend a user in your Okta organization. Only users with ACTIVE status can be suspended. Suspended users cannot log in but retain group and app assignments.

Input

ParameterTypeRequiredDescription
apiKeystringYesOkta API token for authentication
domainstringYesOkta domain (e.g., dev-123456.okta.com)
userIdstringYesUser ID or login to suspend

Output

ParameterTypeDescription
userIdstringSuspended user ID
suspendedbooleanWhether the user was suspended
successbooleanOperation success status

okta_unsuspend_user

Unsuspend a previously suspended user in your Okta organization. Returns the user to ACTIVE status.

Input

ParameterTypeRequiredDescription
apiKeystringYesOkta API token for authentication
domainstringYesOkta domain (e.g., dev-123456.okta.com)
userIdstringYesUser ID or login to unsuspend

Output

ParameterTypeDescription
userIdstringUnsuspended user ID
unsuspendedbooleanWhether the user was unsuspended
successbooleanOperation success status

okta_reset_password

Generate a one-time token to reset a user password. Can email the reset link to the user or return it directly. Transitions the user to RECOVERY status.

Input

ParameterTypeRequiredDescription
apiKeystringYesOkta API token for authentication
domainstringYesOkta domain (e.g., dev-123456.okta.com)
userIdstringYesUser ID or login to reset password for
sendEmailbooleanNoSend password reset email to the user (default: true)

Output

ParameterTypeDescription
userIdstringUser ID
resetPasswordUrlstringPassword reset URL (only returned when sendEmail is false)
successbooleanOperation success status

okta_delete_user

Permanently delete a user from your Okta organization. Can only be performed on DEPROVISIONED users. If the user is active, this will first deactivate them and a second call is needed to delete.

Input

ParameterTypeRequiredDescription
apiKeystringYesOkta API token for authentication
domainstringYesOkta domain (e.g., dev-123456.okta.com)
userIdstringYesUser ID to delete
sendEmailbooleanNoSend deactivation email to admin (default: false)

Output

ParameterTypeDescription
userIdstringDeleted user ID
deletedbooleanWhether the user was deleted
successbooleanOperation success status

okta_list_groups

List all groups in your Okta organization with optional search and filtering

Input

ParameterTypeRequiredDescription
apiKeystringYesOkta API token for authentication
domainstringYesOkta domain (e.g., dev-123456.okta.com)
searchstringNoOkta search expression for groups (e.g., profile.name sw "Engineering" or type eq "OKTA_GROUP")
filterstringNoOkta filter expression (e.g., type eq "OKTA_GROUP")
limitnumberNoMaximum number of groups to return (default: 10000, max: 10000)

Output

ParameterTypeDescription
groupsarrayArray of Okta group objects
idstringGroup ID
namestringGroup name
descriptionstringGroup description
typestringGroup type (OKTA_GROUP, APP_GROUP, BUILT_IN)
createdstringCreation timestamp
lastUpdatedstringLast update timestamp
lastMembershipUpdatedstringLast membership change timestamp
countnumberNumber of groups returned
successbooleanOperation success status

okta_get_group

Get a specific group by ID from your Okta organization

Input

ParameterTypeRequiredDescription
apiKeystringYesOkta API token for authentication
domainstringYesOkta domain (e.g., dev-123456.okta.com)
groupIdstringYesGroup ID to look up

Output

ParameterTypeDescription
idstringGroup ID
namestringGroup name
descriptionstringGroup description
typestringGroup type
createdstringCreation timestamp
lastUpdatedstringLast update timestamp
lastMembershipUpdatedstringLast membership change timestamp
successbooleanOperation success status

okta_create_group

Create a new group in your Okta organization

Input

ParameterTypeRequiredDescription
apiKeystringYesOkta API token for authentication
domainstringYesOkta domain (e.g., dev-123456.okta.com)
namestringYesName of the group
descriptionstringNoDescription of the group

Output

ParameterTypeDescription
idstringCreated group ID
namestringGroup name
descriptionstringGroup description
typestringGroup type
createdstringCreation timestamp
lastUpdatedstringLast update timestamp
lastMembershipUpdatedstringLast membership change timestamp
successbooleanOperation success status

okta_update_group

Update a group profile in your Okta organization. Only groups of OKTA_GROUP type can be updated. All profile properties must be specified (full replacement).

Input

ParameterTypeRequiredDescription
apiKeystringYesOkta API token for authentication
domainstringYesOkta domain (e.g., dev-123456.okta.com)
groupIdstringYesGroup ID to update
namestringYesUpdated group name
descriptionstringNoUpdated group description

Output

ParameterTypeDescription
idstringGroup ID
namestringGroup name
descriptionstringGroup description
typestringGroup type
createdstringCreation timestamp
lastUpdatedstringLast update timestamp
lastMembershipUpdatedstringLast membership change timestamp
successbooleanOperation success status

okta_delete_group

Delete a group from your Okta organization. Groups of OKTA_GROUP or APP_GROUP type can be removed.

Input

ParameterTypeRequiredDescription
apiKeystringYesOkta API token for authentication
domainstringYesOkta domain (e.g., dev-123456.okta.com)
groupIdstringYesGroup ID to delete

Output

ParameterTypeDescription
groupIdstringDeleted group ID
deletedbooleanWhether the group was deleted
successbooleanOperation success status

okta_add_user_to_group

Add a user to a group in your Okta organization

Input

ParameterTypeRequiredDescription
apiKeystringYesOkta API token for authentication
domainstringYesOkta domain (e.g., dev-123456.okta.com)
groupIdstringYesGroup ID to add the user to
userIdstringYesUser ID to add to the group

Output

ParameterTypeDescription
groupIdstringGroup ID
userIdstringUser ID added to the group
addedbooleanWhether the user was added
successbooleanOperation success status

okta_remove_user_from_group

Remove a user from a group in your Okta organization

Input

ParameterTypeRequiredDescription
apiKeystringYesOkta API token for authentication
domainstringYesOkta domain (e.g., dev-123456.okta.com)
groupIdstringYesGroup ID to remove the user from
userIdstringYesUser ID to remove from the group

Output

ParameterTypeDescription
groupIdstringGroup ID
userIdstringUser ID removed from the group
removedbooleanWhether the user was removed
successbooleanOperation success status

okta_list_group_members

List all members of a specific group in your Okta organization

Input

ParameterTypeRequiredDescription
apiKeystringYesOkta API token for authentication
domainstringYesOkta domain (e.g., dev-123456.okta.com)
groupIdstringYesGroup ID to list members for
limitnumberNoMaximum number of members to return (default: 1000, max: 1000)

Output

ParameterTypeDescription
membersarrayArray of group member user objects
idstringUser ID
statusstringUser status
firstNamestringFirst name
lastNamestringLast name
emailstringEmail address
loginstringLogin
mobilePhonestringMobile phone
titlestringJob title
departmentstringDepartment
createdstringCreation timestamp
lastLoginstringLast login timestamp
lastUpdatedstringLast update timestamp
activatedstringActivation timestamp
statusChangedstringStatus change timestamp
countnumberNumber of members returned
successbooleanOperation success status

On this page

Start building today
Trusted by over 100,000 builders.
The open-source platform to build AI agents and run your agentic workforce.
Get started