Integrations / Okta
Okta
Okta identity: list, search, create, suspend and deactivate users, list groups, group members and applications. Orgs on okta.com only.
10 actions
API key
6 read3 write1 destructive
Calls okta.com
Connect
const conn = await setu.connections.initiate({ userId: "user_1", toolkit: "okta" });
console.log(conn.connectUrl); // show this to your user
await conn.waitUntilActive();Permissions requested
This toolkit uses a single credential and requests no scopes.
Actions
Create userwriteokta.create_userCreate an Okta user without a password. With activate true (default) Okta sends an activation email; with false the user stays STAGED.
| Input | Type | Description | |
|---|---|---|---|
first_name | string | Required | First name |
last_name | string | Required | Last name |
email | string | Required | Email address |
login | string | Required | Login (usually the email address) |
mobile_phone | string | Optional | Mobile phone number |
activate | boolean | Optional | Activate the user and send the activation email (default true) |
await setu.execute({
userId: "user_1",
action: "okta.create_user",
input: {
"first_name": "<first_name>",
"last_name": "<last_name>",
"email": "<email>",
"login": "<login>"
},
});Deactivate userdestructiveokta.deactivate_userDeactivate a user: removes their access and app assignments. A deactivated user can only be reactivated by an admin; deleting is a separate step.
| Input | Type | Description | |
|---|---|---|---|
user_id | string | Required | Okta user ID |
await setu.execute({
userId: "user_1",
action: "okta.deactivate_user",
input: {
"user_id": "<user_id>"
},
confirm: true,
});Get userreadokta.get_userGet one user by Okta user ID, login or email-style login: status, profile and last login.
| Input | Type | Description | |
|---|---|---|---|
user_id | string | Required | Okta user ID (00u...) or login |
await setu.execute({
userId: "user_1",
action: "okta.get_user",
input: {
"user_id": "<user_id>"
},
});List applicationsreadokta.list_appsList the applications in the org, optionally those whose label starts with a text.
| Input | Type | Description | |
|---|---|---|---|
q | string | Optional | Matches the start of the app label |
limit | integer | Optional | Apps to return (max 200) |
await setu.execute({
userId: "user_1",
action: "okta.list_apps",
input: {},
});List group membersreadokta.list_group_membersList the users in a group.
| Input | Type | Description | |
|---|---|---|---|
group_id | string | Required | Group ID (00g...) |
limit | integer | Optional | Users to return (max 1000) |
await setu.execute({
userId: "user_1",
action: "okta.list_group_members",
input: {
"group_id": "<group_id>"
},
});List groupsreadokta.list_groupsList groups, optionally those whose name starts with a text.
| Input | Type | Description | |
|---|---|---|---|
q | string | Optional | Matches the start of the group name |
limit | integer | Optional | Groups to return (max 10000) |
await setu.execute({
userId: "user_1",
action: "okta.list_groups",
input: {},
});List a user's groupsreadokta.list_user_groupsList the groups a user belongs to.
| Input | Type | Description | |
|---|---|---|---|
user_id | string | Required | Okta user ID |
await setu.execute({
userId: "user_1",
action: "okta.list_user_groups",
input: {
"user_id": "<user_id>"
},
});List or search usersreadokta.list_usersList users, or find them with 'q' (matches name or email start), or 'search' (an expression such as profile.department eq "Engineering" or status eq "ACTIVE").
| Input | Type | Description | |
|---|---|---|---|
q | string | Optional | Matches the start of first name, last name or email |
search | string | Optional | Search expression, e.g. profile.department eq "Engineering" |
limit | integer | Optional | Users to return (max 200) |
await setu.execute({
userId: "user_1",
action: "okta.list_users",
input: {},
});Suspend userwriteokta.suspend_userSuspend an active user: they cannot sign in until unsuspended, but their data and assignments are kept.
| Input | Type | Description | |
|---|---|---|---|
user_id | string | Required | Okta user ID |
await setu.execute({
userId: "user_1",
action: "okta.suspend_user",
input: {
"user_id": "<user_id>"
},
});Unsuspend userwriteokta.unsuspend_userReturn a suspended user to ACTIVE so they can sign in again.
| Input | Type | Description | |
|---|---|---|---|
user_id | string | Required | Okta user ID |
await setu.execute({
userId: "user_1",
action: "okta.unsuspend_user",
input: {
"user_id": "<user_id>"
},
});