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.

Usage Instructions

Integrate Okta identity management into your workflow. Manage users, groups, and group rules. Run service desk actions like resetting MFA factors and clearing sessions. Review and change application assignments and admin roles. Query the System Log to audit sign-ins and admin changes.

Actions

List Users from Okta

List users in your Okta organization with optional search and filtering. Users with a DEPROVISIONED status are omitted unless a search or filter expression selects them.

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")
afterstringNoOpaque pagination cursor returned as nextCursor by a previous call
limitnumberNoMaximum number of users to return per page (default: 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
nextCursorstringCursor for the next page, or null on the last page
hasMorebooleanWhether more users are available
successbooleanOperation success status

Get User from Okta

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

Create User in Okta

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

Update User in Okta

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

Activate User in Okta

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

Deactivate User in Okta

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

Suspend User in Okta

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

Unsuspend User in Okta

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

Reset Password in Okta

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. Okta requires this parameter and declares no default of its own; leaving it blank sends the email

Output

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

Delete User from Okta

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 or login (email) to delete
sendEmailbooleanNoSend deactivation email to admin (default: false)

Output

ParameterTypeDescription
userIdstringDeleted user ID
deletedbooleanWhether the delete request was accepted. An ACTIVE user is deactivated by the first call and needs a second call to actually be deleted.
successbooleanOperation success status

List Groups from Okta

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")
afterstringNoOpaque pagination cursor returned as nextCursor by a previous call
limitnumberNoMaximum number of groups to return per page (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
nextCursorstringCursor for the next page, or null on the last page
hasMorebooleanWhether more groups are available
successbooleanOperation success status

Get Group from Okta

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

Create Group in Okta

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

Update Group in Okta

Update a group profile in your Okta organization. Only groups of OKTA_GROUP type can be updated. Fields left blank keep their stored value.

Input

ParameterTypeRequiredDescription
apiKeystringYesOkta API token for authentication
domainstringYesOkta domain (e.g., dev-123456.okta.com)
groupIdstringYesGroup ID to update
namestringNoUpdated group name. Leave blank to keep the stored 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

Delete Group from Okta

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

Add User to Group in Okta

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

Remove User from Group in Okta

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

List Group Members from Okta

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
afterstringNoOpaque pagination cursor returned as nextCursor by a previous call
limitnumberNoMaximum number of members to return per page (default: 1000, but Okta recommends 200)

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
nextCursorstringCursor for the next page, or null on the last page
hasMorebooleanWhether more members are available
successbooleanOperation success status

List Group Rules from Okta

List the group rules in your Okta organization. Each rule assigns users to groups automatically based on an expression over their profile, so this shows how group membership is being driven.

Input

ParameterTypeRequiredDescription
apiKeystringYesOkta API token for authentication
domainstringYesOkta domain (e.g., dev-123456.okta.com)
searchstringNoKeyword to search group rules for
afterstringNoOpaque pagination cursor returned as nextCursor by a previous call
limitnumberNoMaximum number of rules to return (default: 50, max: 200)

Output

ParameterTypeDescription
rulesarrayArray of group rules
idstringGroup rule ID
namestringGroup rule name
typestringRule type, always group_rule
statusstringRule status (ACTIVE, INACTIVE, INVALID)
createdstringCreation timestamp
lastUpdatedstringLast update timestamp
expressionstringOkta expression that decides which users the rule matches
expressionTypestringExpression language, typically urn:okta:expression:1.0
assignUserToGroupIdsarrayGroups that matching users are assigned to
excludedUserIdsarrayUsers excluded from the rule
excludedGroupIdsarrayGroups excluded from the rule. Always empty — Okta does not currently support group exclusions.
countnumberNumber of rules returned
nextCursorstringCursor for the next page, or null on the last page
hasMorebooleanWhether more rules are available
successbooleanOperation success status

Get Group Rule from Okta

Retrieve a single Okta group rule by ID, including the expression that decides which users it matches and the groups those users are assigned to.

Input

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

Output

ParameterTypeDescription
idstringGroup rule ID
namestringGroup rule name
typestringRule type, always group_rule
statusstringRule status (ACTIVE, INACTIVE, INVALID)
createdstringCreation timestamp
lastUpdatedstringLast update timestamp
expressionstringOkta expression that decides which users the rule matches
expressionTypestringExpression language, typically urn:okta:expression:1.0
assignUserToGroupIdsarrayGroups that matching users are assigned to
excludedUserIdsarrayUsers excluded from the rule
excludedGroupIdsarrayGroups excluded from the rule. Always empty — Okta does not currently support group exclusions.
successbooleanOperation success status

Create Group Rule in Okta

Create a group rule that automatically assigns users matching an Okta expression to one or more groups. New rules are created INACTIVE, so run Activate Group Rule afterwards to start applying it.

Input

ParameterTypeRequiredDescription
apiKeystringYesOkta API token for authentication
domainstringYesOkta domain (e.g., dev-123456.okta.com)
ruleNamestringYesName for the group rule (maximum 50 characters)
expressionstringYesOkta expression that must evaluate to a boolean (e.g., user.department=="Engineering")
assignUserToGroupIdsstringYesComma-separated group IDs that matching users are assigned to
excludedUserIdsstringNoComma-separated user IDs to exclude from the rule

Output

ParameterTypeDescription
idstringCreated group rule ID
namestringGroup rule name
typestringRule type, always group_rule
statusstringRule status, which is INACTIVE for a newly created rule
createdstringCreation timestamp
lastUpdatedstringLast update timestamp
expressionstringOkta expression that decides which users the rule matches
expressionTypestringExpression language, typically urn:okta:expression:1.0
assignUserToGroupIdsarrayGroups that matching users are assigned to
excludedUserIdsarrayUsers excluded from the rule
excludedGroupIdsarrayGroups excluded from the rule. Always empty — Okta does not currently support group exclusions.
successbooleanOperation success status

Activate Group Rule in Okta

Activate a group rule so Okta starts applying it, assigning every matching user to the target groups.

Input

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

Output

ParameterTypeDescription
groupRuleIdstringActivated group rule ID
activatedbooleanWhether the rule was activated
successbooleanOperation success status

Deactivate Group Rule in Okta

Deactivate a group rule so Okta stops applying it. Existing memberships the rule created are left in place. A rule must be INACTIVE before it can be edited.

Input

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

Output

ParameterTypeDescription
groupRuleIdstringDeactivated group rule ID
deactivatedbooleanWhether the rule was deactivated
successbooleanOperation success status

Delete Group Rule in Okta

Permanently delete a group rule. Destructive and irreversible. Optionally also removes the users that this rule had assigned from those groups, which revokes any access those groups grant.

Input

ParameterTypeRequiredDescription
apiKeystringYesOkta API token for authentication
domainstringYesOkta domain (e.g., dev-123456.okta.com)
groupRuleIdstringYesGroup rule ID to delete
removeUsersbooleanNoAlso remove the users this rule assigned from the groups it targeted (default: false)

Output

ParameterTypeDescription
groupRuleIdstringDeleted group rule ID
deletedbooleanWhether the deletion was accepted. Okta answers 202 and removes the rule asynchronously.
successbooleanOperation success status

List Factors from Okta

List the MFA factors a user has enrolled, with each factor type, provider, and enrollment status. Use this before resetting a factor to confirm which one to target.

Input

ParameterTypeRequiredDescription
apiKeystringYesOkta API token for authentication
domainstringYesOkta domain (e.g., dev-123456.okta.com)
userIdstringYesOkta user ID (not a login or email) to list enrolled factors for

Output

ParameterTypeDescription
factorsarrayArray of enrolled MFA factors
idstringFactor ID
factorTypestringFactor type (sms, call, email, push, question, token:software:totp, webauthn, etc.)
providerstringFactor provider (OKTA, GOOGLE, FIDO, DUO, RSA, SYMANTEC, YUBICO, CUSTOM)
vendorNamestringFactor vendor name
statusstringEnrollment status (ACTIVE, PENDING_ACTIVATION, NOT_SETUP, etc.)
createdstringEnrollment timestamp
lastUpdatedstringLast update timestamp
profilejsonFactor-specific attributes, which vary by factor type (phone number, email, question, credential ID)
countnumberNumber of enrolled factors
successbooleanOperation success status

Get Factor from Okta

Retrieve a single enrolled MFA factor for a user, including its type, provider, enrollment status, and factor-specific profile.

Input

ParameterTypeRequiredDescription
apiKeystringYesOkta API token for authentication
domainstringYesOkta domain (e.g., dev-123456.okta.com)
userIdstringYesOkta user ID (not a login or email) the factor belongs to
factorIdstringYesFactor ID to look up

Output

ParameterTypeDescription
idstringFactor ID
factorTypestringFactor type
providerstringFactor provider
vendorNamestringFactor vendor name
statusstringEnrollment status
createdstringEnrollment timestamp
lastUpdatedstringLast update timestamp
profilejsonFactor-specific attributes, which vary by factor type (phone number, email, question, credential ID)
successbooleanOperation success status

Enroll Factor in Okta

Enroll an MFA factor for a user. The profile fields required depend on the factor type: a phone number for sms and call, an email address for email, and a question and answer for question. Factors that enroll from the user device, such as webauthn and push, need no profile fields.

Input

ParameterTypeRequiredDescription
apiKeystringYesOkta API token for authentication
domainstringYesOkta domain (e.g., dev-123456.okta.com)
userIdstringYesOkta user ID (not a login or email) to enroll the factor for
factorTypestringYesFactor type to enroll (sms, call, email, question, push, token:software:totp, u2f, webauthn)
providerstringYesFactor provider (OKTA, GOOGLE, FIDO, DUO, RSA, SYMANTEC, YUBICO, CUSTOM). Each provider supports a subset of factor types
phoneNumberstringNoPhone number in E.164 format. Required for the sms and call factor types
factorEmailstringNoEmail address to enroll. Required for the email factor type
securityQuestionstringNoSecurity question key (e.g., disliked_food). Required for the question factor type
securityAnswerstringNoAnswer to the security question, minimum 4 characters. Required for the question factor type
activatebooleanNoActivate the factor immediately as part of enrollment. Supported by the sms, call, email, and token:hotp factor types (default: false)

Output

ParameterTypeDescription
idstringEnrolled factor ID
factorTypestringFactor type
providerstringFactor provider
vendorNamestringFactor vendor name
statusstringEnrollment status, typically PENDING_ACTIVATION until the user activates it
createdstringEnrollment timestamp
lastUpdatedstringLast update timestamp
profilejsonFactor-specific attributes, which vary by factor type (phone number, email, question, credential ID)
enrolledbooleanWhether the factor was enrolled
successbooleanOperation success status

Reset Factor in Okta

Unenroll one specific MFA factor for a user so they can re-enroll it. Destructive and irreversible: the existing enrollment is removed. Unenrolling a push or signed_nonce factor also unenrolls the related Okta Verify factors. Factors cannot be unenrolled from a deactivated user.

Input

ParameterTypeRequiredDescription
apiKeystringYesOkta API token for authentication
domainstringYesOkta domain (e.g., dev-123456.okta.com)
userIdstringYesOkta user ID (not a login or email) the factor belongs to
factorIdstringYesFactor ID to unenroll
removeRecoveryEnrollmentbooleanNoAlso remove the phone number as a recovery method, not only as a factor. Applies to sms and call factors only (default: false)

Output

ParameterTypeDescription
userIdstringUser the factor belonged to
factorIdstringUnenrolled factor ID
resetbooleanWhether the factor was unenrolled
successbooleanOperation success status

Reset All Factors in Okta

Reset every MFA factor for a user, returning all enrollments to the unenrolled state. Destructive and irreversible: the user must re-enroll each factor before they can complete MFA again. The user status stays ACTIVE.

Input

ParameterTypeRequiredDescription
apiKeystringYesOkta API token for authentication
domainstringYesOkta domain (e.g., dev-123456.okta.com)
userIdstringYesUser ID or login whose MFA factors will all be reset

Output

ParameterTypeDescription
userIdstringUser whose factors were reset
resetbooleanWhether all factors were reset
successbooleanOperation success status

Clear User Sessions in Okta

Revoke every active Okta session for a user, signing them out of all devices immediately. Destructive and irreversible: the user must sign in again. Optionally also revokes their OAuth and OpenID Connect tokens, and clears remembered factors.

Input

ParameterTypeRequiredDescription
apiKeystringYesOkta API token for authentication
domainstringYesOkta domain (e.g., dev-123456.okta.com)
userIdstringYesOkta user ID (not a login or email) whose sessions will be revoked
oauthTokensbooleanNoAlso revoke the user OpenID Connect and OAuth refresh and access tokens (default: false)
forgetDevicesbooleanNoClear the user remembered factors for all devices (default: true)

Output

ParameterTypeDescription
userIdstringUser whose sessions were revoked
clearedbooleanWhether the sessions were revoked
successbooleanOperation success status

Get Session from Okta

Retrieve an Okta session by ID, including who it belongs to, when it expires, and which authentication methods were used to establish it.

Input

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

Output

ParameterTypeDescription
idstringSession ID
loginstringLogin of the session user
userIdstringID of the session user
statusstringSession status (ACTIVE, MFA_ENROLL, MFA_REQUIRED)
createdAtstringSession creation timestamp
expiresAtstringSession expiry timestamp
lastPasswordVerificationstringTimestamp of the last password verification
lastFactorVerificationstringTimestamp of the last factor verification
amrarrayAuthentication methods used to establish the session
idpIdstringIdentity provider ID
idpTypestringIdentity provider type
successbooleanOperation success status

Revoke Session in Okta

Revoke a single Okta session by ID, ending that sign-in immediately. Destructive and irreversible: the affected user must sign in again on that device.

Input

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

Output

ParameterTypeDescription
sessionIdstringRevoked session ID
revokedbooleanWhether the session was revoked
successbooleanOperation success status

List Applications from Okta

List the applications configured in your Okta organization, with optional name search, filtering, and cursor pagination.

Input

ParameterTypeRequiredDescription
apiKeystringYesOkta API token for authentication
domainstringYesOkta domain (e.g., dev-123456.okta.com)
qstringNoSearch for applications whose name or label starts with this value
filterstringNoOkta filter expression (e.g., status eq "ACTIVE")
includeNonDeletedbooleanNoAlso return inactive applications. Deleted applications stay excluded either way (default: false)
afterstringNoOpaque pagination cursor returned as nextCursor by a previous call
limitnumberNoMaximum number of applications to return (max: 200)

Output

ParameterTypeDescription
appsarrayArray of Okta applications
idstringApplication ID
namestringApplication name (the app template key)
labelstringApplication display label
statusstringApplication status (ACTIVE, INACTIVE, DELETED)
signOnModestringSign-on mode (SAML_2_0, OPENID_CONNECT, BOOKMARK, etc.)
featuresarrayEnabled provisioning features
createdstringCreation timestamp
lastUpdatedstringLast update timestamp
countnumberNumber of applications returned
nextCursorstringCursor for the next page, or null on the last page
hasMorebooleanWhether more applications are available
successbooleanOperation success status

Get Application from Okta

Retrieve a single Okta application by ID, including its sign-on mode, status, enabled provisioning features, and configuration objects.

Input

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

Output

ParameterTypeDescription
idstringApplication ID
namestringApplication name (the app template key)
labelstringApplication display label
statusstringApplication status (ACTIVE, INACTIVE, DELETED)
signOnModestringSign-on mode
featuresarrayEnabled provisioning features
createdstringCreation timestamp
lastUpdatedstringLast update timestamp
accessibilityjsonAccess settings for the app
errorRedirectUrlstringCustom error page URL
loginRedirectUrlstringCustom login page URL
selfServicebooleanWhether users can self-assign the app
visibilityjsonVisibility settings for the app
appLinksjsonMap of app link name to whether it appears on the End-User Dashboard
autoLaunchbooleanSigns in to the app automatically when the user signs in to Okta
autoSubmitToolbarbooleanSigns in automatically when the user lands on the sign-in page
hidejsonWhich end-user apps hide this app
iOSbooleanHidden in Okta Mobile
webbooleanHidden on the Okta End-User Dashboard
settingsjsonApplication settings. Okta types these per app kind, so settings.app differs between a SAML, OIDC, bookmark, or SWA app
profilejsonApplication profile attributes. Okta accepts any valid JSON schema here, so the shape is whatever the org configured
successbooleanOperation success status

List Application Users from Okta

List the users assigned to an Okta application, including how each assignment was made and its provisioning sync state. Use this to audit who has access to an app.

Input

ParameterTypeRequiredDescription
apiKeystringYesOkta API token for authentication
domainstringYesOkta domain (e.g., dev-123456.okta.com)
appIdstringYesApplication ID to list assigned users for
qstringNoSearch assigned users whose userName, firstName, lastName, or email starts with this value
afterstringNoOpaque pagination cursor returned as nextCursor by a previous call
limitnumberNoMaximum number of assigned users to return (default: 50, max: 500)

Output

ParameterTypeDescription
appUsersarrayArray of application user assignments
idstringOkta user ID
externalIdstringID of the user in the downstream application
createdstringAssignment creation timestamp
lastUpdatedstringLast update timestamp
scopestringHow the assignment was made: USER (direct) or GROUP (inherited)
statusstringAssignment status
statusChangedstringStatus change timestamp
passwordChangedstringApp password change timestamp
syncStatestringProvisioning sync state
lastSyncstringLast provisioning sync
userNamestringUsername the user signs in to the application with
profilejsonApp-specific profile attributes, whose shape is set by the app schema
countnumberNumber of assignments returned
nextCursorstringCursor for the next page, or null on the last page
hasMorebooleanWhether more assignments are available
successbooleanOperation success status

Assign User to Application in Okta

Assign a user to an Okta application, granting them access to it. Applications that require credentials also need the username the user signs in with.

Input

ParameterTypeRequiredDescription
apiKeystringYesOkta API token for authentication
domainstringYesOkta domain (e.g., dev-123456.okta.com)
appIdstringYesApplication ID to assign the user to
userIdstringYesOkta user ID to assign
scopestringNoAssignment scope: USER for a direct assignment, or GROUP
appUserNamestringNoUsername the user signs in to the application with. Required by applications that store credentials

Output

ParameterTypeDescription
idstringOkta user ID that was assigned
externalIdstringID of the user in the downstream application
createdstringAssignment creation timestamp
lastUpdatedstringLast update timestamp
scopestringAssignment scope (USER or GROUP)
statusstringAssignment status
statusChangedstringStatus change timestamp
passwordChangedstringApp password change timestamp
syncStatestringProvisioning sync state
lastSyncstringLast provisioning sync
userNamestringUsername the user signs in to the application with
profilejsonApp-specific profile attributes, whose shape is set by the app schema
assignedbooleanWhether the user was assigned
successbooleanOperation success status

Remove User from Application in Okta

Unassign a user from an Okta application, revoking their access. Destructive and irreversible: the app profile for that user is permanently removed, and if provisioning is enabled the downstream account is deactivated.

Input

ParameterTypeRequiredDescription
apiKeystringYesOkta API token for authentication
domainstringYesOkta domain (e.g., dev-123456.okta.com)
appIdstringYesApplication ID to remove the user from
userIdstringYesOkta user ID to unassign
sendEmailbooleanNoSend a deactivation email to the administrator (default: false)

Output

ParameterTypeDescription
appIdstringApplication ID
userIdstringUser unassigned from the application
removedbooleanWhether the user was unassigned
successbooleanOperation success status

List Application Groups from Okta

List the groups assigned to an Okta application. Every member of an assigned group inherits access to the app, so this is the starting point for an app access review.

Input

ParameterTypeRequiredDescription
apiKeystringYesOkta API token for authentication
domainstringYesOkta domain (e.g., dev-123456.okta.com)
appIdstringYesApplication ID to list assigned groups for
qstringNoSearch assigned groups whose name starts with this value
afterstringNoOpaque pagination cursor returned as nextCursor by a previous call
limitnumberNoMaximum number of assigned groups to return (default: 20, range: 20 to 200)

Output

ParameterTypeDescription
appGroupsarrayArray of application group assignments
idstringAssigned group ID
prioritynumberAssignment priority, which resolves conflicting profile mappings
lastUpdatedstringLast update timestamp
profilejsonApp-specific profile attributes, whose shape is set by the app schema
countnumberNumber of assignments returned
nextCursorstringCursor for the next page, or null on the last page
hasMorebooleanWhether more assignments are available
successbooleanOperation success status

Assign Group to Application in Okta

Assign a group to an Okta application so every member of the group inherits access to it.

Input

ParameterTypeRequiredDescription
apiKeystringYesOkta API token for authentication
domainstringYesOkta domain (e.g., dev-123456.okta.com)
appIdstringYesApplication ID to assign the group to
groupIdstringYesGroup ID to assign
prioritynumberNoAssignment priority, which resolves conflicting profile mappings when a user belongs to several assigned groups

Output

ParameterTypeDescription
idstringAssigned group ID
prioritynumberAssignment priority
lastUpdatedstringLast update timestamp
profilejsonApp-specific profile attributes, whose shape is set by the app schema
assignedbooleanWhether the group was assigned
successbooleanOperation success status

Remove Group from Application in Okta

Unassign a group from an Okta application. Destructive: every member who had access only through this group loses access to the app.

Input

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

Output

ParameterTypeDescription
appIdstringApplication ID
groupIdstringGroup unassigned from the application
removedbooleanWhether the group was unassigned
successbooleanOperation success status

List User Roles from Okta

List the administrator roles assigned to a user. Returns both standard roles and custom role bindings, so you can review who holds privileged access.

Input

ParameterTypeRequiredDescription
apiKeystringYesOkta API token for authentication
domainstringYesOkta domain (e.g., dev-123456.okta.com)
userIdstringYesOkta user ID (not a login or email) to list admin roles for

Output

ParameterTypeDescription
rolesarrayArray of admin role assignments
idstringRole assignment ID, which is the resource set binding ID for a custom role. Pass this to Remove User Role
labelstringRole label
typestringRole type (SUPER_ADMIN, ORG_ADMIN, APP_ADMIN, USER_ADMIN, HELP_DESK_ADMIN, READ_ONLY_ADMIN, CUSTOM, etc.)
statusstringRole status (ACTIVE, INACTIVE)
createdstringAssignment timestamp
lastUpdatedstringLast update timestamp
assignmentTypestringHow the role was assigned (USER, GROUP, CLIENT)
rolestringCustom role ID, present only on custom role assignments
resourceSetstringResource set ID, present only on custom role assignments
countnumberNumber of role assignments returned
successbooleanOperation success status

Assign User Role in Okta

Grant a user an administrator role. Use a standard role type such as USER_ADMIN or HELP_DESK_ADMIN, or CUSTOM together with a custom role ID and a resource set ID. This grants privileged access, so confirm the role is the least privilege that fits.

Input

ParameterTypeRequiredDescription
apiKeystringYesOkta API token for authentication
domainstringYesOkta domain (e.g., dev-123456.okta.com)
userIdstringYesOkta user ID (not a login or email) to assign the admin role to
roleTypestringYesRole type to assign: SUPER_ADMIN, ORG_ADMIN, APP_ADMIN, USER_ADMIN, HELP_DESK_ADMIN, READ_ONLY_ADMIN, API_ACCESS_MANAGEMENT_ADMIN, GROUP_MEMBERSHIP_ADMIN, REPORT_ADMIN, WORKFLOWS_ADMIN, ACCESS_CERTIFICATIONS_ADMIN, ACCESS_REQUESTS_ADMIN, or CUSTOM
customRoleIdstringNoCustom role ID. Required when the role type is CUSTOM
resourceSetIdstringNoResource set ID the custom role applies to. Required when the role type is CUSTOM
disableNotificationsbooleanNoGrant the user third-party admin status, which suppresses Okta admin notifications (default: false)

Output

ParameterTypeDescription
idstringRole assignment ID, which is what Remove User Role takes
labelstringRole label
typestringAssigned role type
statusstringRole status
createdstringAssignment timestamp
lastUpdatedstringLast update timestamp
assignmentTypestringHow the role was assigned (USER, GROUP, CLIENT)
rolestringCustom role ID, for custom roles
resourceSetstringResource set ID, for custom roles
assignedbooleanWhether the role was assigned
successbooleanOperation success status

Remove User Role in Okta

Revoke an administrator role from a user. Destructive: the user immediately loses the admin permissions that role granted. Takes the role assignment ID, not the role type, which List User Roles returns as the role id field.

Input

ParameterTypeRequiredDescription
apiKeystringYesOkta API token for authentication
domainstringYesOkta domain (e.g., dev-123456.okta.com)
userIdstringYesOkta user ID (not a login or email) to revoke the admin role from
roleAssignmentIdstringYesRole assignment ID to revoke, as returned by List User Roles. For a custom role this is the resource set binding ID

Output

ParameterTypeDescription
userIdstringUser the role was revoked from
roleAssignmentIdstringRevoked role assignment ID
removedbooleanWhether the role was revoked
successbooleanOperation success status

Get System Log Events from Okta

Query the Okta System Log for sign-ins, admin changes, and security events. Supports a time window, SCIM filter expressions, keyword search, and cursor pagination for audit and investigation workflows.

Input

ParameterTypeRequiredDescription
apiKeystringYesOkta API token for authentication
domainstringYesOkta domain (e.g., dev-123456.okta.com)
sincestringNoStart of the query time window as an ISO 8601 timestamp (default: 7 days before "until"). Ignored when a cursor is supplied in "after", which already encodes the resume position
untilstringNoEnd of the query time window as an ISO 8601 timestamp (default: now)
filterstringNoSCIM filter expression (e.g., eventType eq "user.session.start" or outcome.result eq "FAILURE")
qstringNoKeyword search across the event payload (max 40 characters per keyword, max 10 keywords)
sortOrderstringNoSort order: ASCENDING (default) or DESCENDING
afterstringNoOpaque pagination cursor returned as nextCursor by a previous call
limitnumberNoMaximum number of events to return (default: 100, max: 1000)

Output

ParameterTypeDescription
eventsarrayArray of System Log events
uuidstringUnique event ID
publishedstringEvent timestamp
eventTypestringEvent type (e.g., user.session.start, user.account.update_password)
severitystringEvent severity (DEBUG, ERROR, INFO, WARN)
legacyEventTypestringLegacy event type
displayMessagestringHuman-readable event description
outcomeResultstringEvent outcome (SUCCESS, FAILURE, CHALLENGE, DENY, etc.)
outcomeReasonstringReason for the outcome
actorIdstringID of the actor
actorTypestringActor type (User, Client, etc.)
actorAlternateIdstringActor alternate ID, usually the login
actorDisplayNamestringActor display name
clientIpAddressstringClient IP address
clientDevicestringClient device category (e.g., Computer)
clientZonestringNetwork zone
clientBrowserstringClient browser
clientOsstringClient operating system
clientCitystringClient city
clientStatestringClient state or region
clientCountrystringClient country
authenticationProviderstringAuthentication provider used
credentialTypestringCredential type used
externalSessionIdstringExternal session ID for correlating events
securityAsOrgstringAutonomous system organization
securityIspstringInternet service provider
securityIsProxybooleanWhether the request came through a proxy
transactionIdstringTransaction ID
transactionTypestringTransaction type (e.g., WEB, JOB)
targetsarrayEntities the event acted upon
idstringTarget ID
typestringTarget type
alternateIdstringTarget alternate ID
displayNamestringTarget display name
debugDatajsonExtra context whose keys depend on the event type. Okta states these keys and values can change between releases, so treat them as a debugging aid rather than a contract
countnumberNumber of events returned
nextCursorstringCursor to resume from, or null when Okta advertised no next link. On a polling query it stays set on an empty page so the next scheduled run resumes from here rather than replaying from the start
hasMorebooleanWhether more events are available. A query with no "until" is a polling query, which Okta always answers with a next link even when there are no new events, so this reports false once a page comes back empty
successbooleanOperation success status