Okta

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`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`domain`	string	Yes	No description
`search`	string	No	Okta search expression (e.g., profile.firstName eq "John" or profile.email co "example.com")
`filter`	string	No	Okta filter expression (e.g., status eq "ACTIVE")
`limit`	number	No	No description

Output

Parameter	Type	Description
`users`	array	Array of Okta user objects
↳ `id`	string	User ID
↳ `status`	string	User status (ACTIVE, STAGED, PROVISIONED, etc.)
↳ `firstName`	string	First name
↳ `lastName`	string	Last name
↳ `email`	string	Email address
↳ `login`	string	Login (usually email)
↳ `mobilePhone`	string	Mobile phone
↳ `title`	string	Job title
↳ `department`	string	Department
↳ `created`	string	Creation timestamp
↳ `lastLogin`	string	Last login timestamp
↳ `lastUpdated`	string	Last update timestamp
↳ `activated`	string	Activation timestamp
↳ `statusChanged`	string	Status change timestamp
`count`	number	Number of users returned
`success`	boolean	Operation success status

`okta_get_user`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`domain`	string	Yes	No description
`userId`	string	Yes	No description

Output

Parameter	Type	Description
`id`	string	User ID
`status`	string	User status
`firstName`	string	First name
`lastName`	string	Last name
`email`	string	Email address
`login`	string	Login (usually email)
`mobilePhone`	string	Mobile phone
`secondEmail`	string	Secondary email
`displayName`	string	Display name
`title`	string	Job title
`department`	string	Department
`organization`	string	Organization
`manager`	string	Manager name
`managerId`	string	Manager ID
`division`	string	Division
`employeeNumber`	string	Employee number
`userType`	string	User type
`created`	string	Creation timestamp
`activated`	string	Activation timestamp
`lastLogin`	string	Last login timestamp
`lastUpdated`	string	Last update timestamp
`statusChanged`	string	Status change timestamp
`passwordChanged`	string	Password change timestamp
`success`	boolean	Operation success status

`okta_create_user`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`domain`	string	Yes	No description
`firstName`	string	Yes	No description
`lastName`	string	Yes	No description
`email`	string	Yes	No description
`login`	string	No	No description
`password`	string	No	No description
`mobilePhone`	string	No	No description
`title`	string	No	No description
`department`	string	No	No description
`activate`	boolean	No	No description

Output

Parameter	Type	Description
`id`	string	Created user ID
`status`	string	User status
`firstName`	string	First name
`lastName`	string	Last name
`email`	string	Email address
`login`	string	Login
`created`	string	Creation timestamp
`lastUpdated`	string	Last update timestamp
`success`	boolean	Operation success status

`okta_update_user`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`domain`	string	Yes	No description
`userId`	string	Yes	No description
`firstName`	string	No	No description
`lastName`	string	No	No description
`email`	string	No	No description
`login`	string	No	No description
`mobilePhone`	string	No	No description
`title`	string	No	No description
`department`	string	No	No description

Output

Parameter	Type	Description
`id`	string	User ID
`status`	string	User status
`firstName`	string	First name
`lastName`	string	Last name
`email`	string	Email address
`login`	string	Login
`created`	string	Creation timestamp
`lastUpdated`	string	Last update timestamp
`success`	boolean	Operation 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

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`domain`	string	Yes	No description
`userId`	string	Yes	No description
`sendEmail`	boolean	No	No description

Output

Parameter	Type	Description
`userId`	string	Activated user ID
`activated`	boolean	Whether the user was activated
`activationUrl`	string	Activation URL (only returned when sendEmail is false)
`activationToken`	string	Activation token (only returned when sendEmail is false)
`success`	boolean	Operation success status

`okta_deactivate_user`

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

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`domain`	string	Yes	No description
`userId`	string	Yes	No description
`sendEmail`	boolean	No	No description

Output

Parameter	Type	Description
`userId`	string	Deactivated user ID
`deactivated`	boolean	Whether the user was deactivated
`success`	boolean	Operation 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

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`domain`	string	Yes	No description
`userId`	string	Yes	No description

Output

Parameter	Type	Description
`userId`	string	Suspended user ID
`suspended`	boolean	Whether the user was suspended
`success`	boolean	Operation success status

`okta_unsuspend_user`

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

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`domain`	string	Yes	No description
`userId`	string	Yes	No description

Output

Parameter	Type	Description
`userId`	string	Unsuspended user ID
`unsuspended`	boolean	Whether the user was unsuspended
`success`	boolean	Operation 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

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`domain`	string	Yes	No description
`userId`	string	Yes	No description
`sendEmail`	boolean	No	No description

Output

Parameter	Type	Description
`userId`	string	User ID
`resetPasswordUrl`	string	Password reset URL (only returned when sendEmail is false)
`success`	boolean	Operation 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

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`domain`	string	Yes	No description
`userId`	string	Yes	No description
`sendEmail`	boolean	No	No description

Output

Parameter	Type	Description
`userId`	string	Deleted user ID
`deleted`	boolean	Whether the user was deleted
`success`	boolean	Operation success status

`okta_list_groups`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`domain`	string	Yes	No description
`search`	string	No	Okta search expression for groups (e.g., profile.name sw "Engineering" or type eq "OKTA_GROUP")
`filter`	string	No	Okta filter expression (e.g., type eq "OKTA_GROUP")
`limit`	number	No	No description

Output

Parameter	Type	Description
`groups`	array	Array of Okta group objects
↳ `id`	string	Group ID
↳ `name`	string	Group name
↳ `description`	string	Group description
↳ `type`	string	Group type (OKTA_GROUP, APP_GROUP, BUILT_IN)
↳ `created`	string	Creation timestamp
↳ `lastUpdated`	string	Last update timestamp
↳ `lastMembershipUpdated`	string	Last membership change timestamp
`count`	number	Number of groups returned
`success`	boolean	Operation success status

`okta_get_group`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`domain`	string	Yes	No description
`groupId`	string	Yes	No description

Output

Parameter	Type	Description
`id`	string	Group ID
`name`	string	Group name
`description`	string	Group description
`type`	string	Group type
`created`	string	Creation timestamp
`lastUpdated`	string	Last update timestamp
`lastMembershipUpdated`	string	Last membership change timestamp
`success`	boolean	Operation success status

`okta_create_group`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`domain`	string	Yes	No description
`name`	string	Yes	No description
`description`	string	No	No description

Output

Parameter	Type	Description
`id`	string	Created group ID
`name`	string	Group name
`description`	string	Group description
`type`	string	Group type
`created`	string	Creation timestamp
`lastUpdated`	string	Last update timestamp
`lastMembershipUpdated`	string	Last membership change timestamp
`success`	boolean	Operation 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

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`domain`	string	Yes	No description
`groupId`	string	Yes	No description
`name`	string	Yes	No description
`description`	string	No	No description

Output

Parameter	Type	Description
`id`	string	Group ID
`name`	string	Group name
`description`	string	Group description
`type`	string	Group type
`created`	string	Creation timestamp
`lastUpdated`	string	Last update timestamp
`lastMembershipUpdated`	string	Last membership change timestamp
`success`	boolean	Operation success status

`okta_delete_group`

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

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`domain`	string	Yes	No description
`groupId`	string	Yes	No description

Output

Parameter	Type	Description
`groupId`	string	Deleted group ID
`deleted`	boolean	Whether the group was deleted
`success`	boolean	Operation success status

`okta_add_user_to_group`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`domain`	string	Yes	No description
`groupId`	string	Yes	No description
`userId`	string	Yes	No description

Output

Parameter	Type	Description
`groupId`	string	Group ID
`userId`	string	User ID added to the group
`added`	boolean	Whether the user was added
`success`	boolean	Operation success status

`okta_remove_user_from_group`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`domain`	string	Yes	No description
`groupId`	string	Yes	No description
`userId`	string	Yes	No description

Output

Parameter	Type	Description
`groupId`	string	Group ID
`userId`	string	User ID removed from the group
`removed`	boolean	Whether the user was removed
`success`	boolean	Operation success status

`okta_list_group_members`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`domain`	string	Yes	No description
`groupId`	string	Yes	No description
`limit`	number	No	No description

Output

Parameter	Type	Description
`members`	array	Array of group member user objects
↳ `id`	string	User ID
↳ `status`	string	User status
↳ `firstName`	string	First name
↳ `lastName`	string	Last name
↳ `email`	string	Email address
↳ `login`	string	Login
↳ `mobilePhone`	string	Mobile phone
↳ `title`	string	Job title
↳ `department`	string	Department
↳ `created`	string	Creation timestamp
↳ `lastLogin`	string	Last login timestamp
↳ `lastUpdated`	string	Last update timestamp
↳ `activated`	string	Activation timestamp
↳ `statusChanged`	string	Status change timestamp
`count`	number	Number of members returned
`success`	boolean	Operation success status

On this page