← Tools Reference

Okta

Okta integration (Security). Imported from open-connector.

Credentials form13 toolshttps://{org_url}
GET
okta_list_users
List Okta users with search, filtering, sorting, field projection, and cursor pagination.

/api/v1/users

8 parameters
ParamTypeRequiredDescription
limitintegeroptionalThe maximum number of users to return.
afterstringoptionalThe opaque Okta pagination cursor from a previous response.
searchstringoptionalAn Okta Users API search expression.
filterstringoptionalAn Okta Users API filter expression.
qstringoptionalA simple prefix query for user first name, last name, or email.
sortBystringoptionalThe user property used to sort search results.
sortOrderstringoptionalThe sort direction for an Okta search query.
fieldsstringoptionalA comma-separated projection of user properties to return.
GET
okta_get_user
Get one Okta user by ID, login, or login shortname.

/api/v1/users/{userId}

1 parameter
ParamTypeRequiredDescription
userIdstringrequiredThe Okta user ID, login, or login shortname accepted by the Users API.
POST
okta_update_user
Partially update an Okta user's profile or credentials.

/api/v1/users/{userId}

4 parameters
ParamTypeRequiredDescription
userIdstringrequiredThe Okta user ID, login, or login shortname accepted by the Users API.
profileobjectoptionalOkta user profile fields, including required attributes and custom profile prop…
credentialsobjectoptionalOkta user credentials, such as password, recovery question, or authentication p…
strictbooleanoptionalWhether Okta should enforce password age and history policies.
DELETE
okta_delete_user
Deactivate an active Okta user, or permanently delete a user that is already deactivated.

/api/v1/users/{userId}

2 parameters
ParamTypeRequiredDescription
userIdstringrequiredThe Okta user ID, login, or login shortname accepted by the Users API.
sendEmailbooleanoptionalWhether Okta should send a deactivation email to the admin.
POST
okta_lifecycle_user
Activate, reactivate, deactivate, suspend, unsuspend, unlock, or expire an Okta user's password.

/api/v1/users/{userId}/lifecycle/{pathOperation}

6 parameters
ParamTypeRequiredDescription
userIdstringrequiredThe Okta user ID, login, or login shortname accepted by the Users API.
operationstringrequiredThe lifecycle operation to perform.
sendEmailbooleanoptionalWhether supported activation or deactivation operations should send email.
tempPasswordbooleanoptionalFor expire_password, whether Okta should expire the password and return a tempo…
revokeSessionsbooleanoptionalWhen returning a temporary password, whether Okta should revoke the user's exis…
pathOperationstringrequiredPath parameter: pathOperation
GET
okta_list_groups
List Okta groups with search, filtering, sorting, expansion, and cursor pagination.

/api/v1/groups

8 parameters
ParamTypeRequiredDescription
limitintegeroptionalThe maximum number of groups to return.
afterstringoptionalThe opaque Okta pagination cursor from a previous response.
searchstringoptionalAn Okta Groups API search expression.
filterstringoptionalAn Okta Groups API filter expression.
qstringoptionalA simple query that matches the Okta group name.
expandstringoptionalAdditional group metadata to include.
sortBystringoptionalThe group property used to sort search results.
sortOrderstringoptionalThe sort direction for an Okta search query.
GET
okta_get_group
Get one Okta group by ID.

/api/v1/groups/{groupId}

1 parameter
ParamTypeRequiredDescription
groupIdstringrequiredThe Okta group ID.
POST
okta_create_group
Create an Okta-managed group.

/api/v1/groups

1 parameter
ParamTypeRequiredDescription
profileobjectoptionalThe Okta group profile.
PUT
okta_update_group
Replace an Okta-managed group's profile.

/api/v1/groups/{groupId}

2 parameters
ParamTypeRequiredDescription
groupIdstringrequiredThe Okta group ID.
profileobjectoptionalThe Okta group profile.
DELETE
okta_delete_group
Delete an Okta-managed group by ID.

/api/v1/groups/{groupId}

1 parameter
ParamTypeRequiredDescription
groupIdstringrequiredThe Okta group ID.
GET
okta_list_group_users
List the users that are members of an Okta group.

/api/v1/groups/{groupId}/users

3 parameters
ParamTypeRequiredDescription
groupIdstringrequiredThe Okta group ID.
limitintegeroptionalThe maximum number of group members to return.
afterstringoptionalThe opaque Okta pagination cursor from a previous response.
PUT
okta_add_user_to_group
Assign an Okta user to an Okta-managed group.

/api/v1/groups/{groupId}/users/{userId}

2 parameters
ParamTypeRequiredDescription
groupIdstringrequiredThe Okta group ID.
userIdstringrequiredThe Okta user ID, login, or login shortname accepted by the Users API.
DELETE
okta_remove_user_from_group
Unassign an Okta user from an Okta-managed group.

/api/v1/groups/{groupId}/users/{userId}

2 parameters
ParamTypeRequiredDescription
groupIdstringrequiredThe Okta group ID.
userIdstringrequiredThe Okta user ID, login, or login shortname accepted by the Users API.