Integrate Okta identity management into your workflow. List, create, update, activate, suspend, and delete users. Reset passwords. Manage groups and group membership.
List all users in your Okta organization with optional search and filtering
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Okta API token for authentication |
domain | string | はい | Okta domain (e.g., dev-123456.okta.com) |
search | string | いいえ | Okta search expression (e.g., profile.firstName eq "John" or profile.email co "example.com") |
filter | string | いいえ | Okta filter expression (e.g., status eq "ACTIVE") |
limit | number | いいえ | Maximum number of users to return (default: 200, max: 200) |
| パラメータ | 型 | 説明 |
|---|
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 |
Get a specific user by ID or login from your Okta organization
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Okta API token for authentication |
domain | string | はい | Okta domain (e.g., dev-123456.okta.com) |
userId | string | はい | User ID or login (email) to look up |
| パラメータ | 型 | 説明 |
|---|
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 |
Create a new user in your Okta organization
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Okta API token for authentication |
domain | string | はい | Okta domain (e.g., dev-123456.okta.com) |
firstName | string | はい | First name of the user |
lastName | string | はい | Last name of the user |
email | string | はい | Email address of the user |
login | string | いいえ | Login for the user (defaults to email if not provided) |
password | string | いいえ | Password for the user (if not set, user will be emailed to set password) |
mobilePhone | string | いいえ | Mobile phone number |
title | string | いいえ | Job title |
department | string | いいえ | Department |
activate | boolean | いいえ | Whether to activate the user immediately (default: true) |
| パラメータ | 型 | 説明 |
|---|
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 |
Update a user profile in your Okta organization
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Okta API token for authentication |
domain | string | はい | Okta domain (e.g., dev-123456.okta.com) |
userId | string | はい | User ID or login to update |
firstName | string | いいえ | Updated first name |
lastName | string | いいえ | Updated last name |
email | string | いいえ | Updated email address |
login | string | いいえ | Updated login |
mobilePhone | string | いいえ | Updated mobile phone number |
title | string | いいえ | Updated job title |
department | string | いいえ | Updated department |
| パラメータ | 型 | 説明 |
|---|
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 |
Activate a user in your Okta organization. Can only be performed on users with STAGED or DEPROVISIONED status. Optionally sends an activation email.
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Okta API token for authentication |
domain | string | はい | Okta domain (e.g., dev-123456.okta.com) |
userId | string | はい | User ID or login to activate |
sendEmail | boolean | いいえ | Send activation email to the user (default: true) |
| パラメータ | 型 | 説明 |
|---|
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 |
Deactivate a user in your Okta organization. This transitions the user to DEPROVISIONED status.
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Okta API token for authentication |
domain | string | はい | Okta domain (e.g., dev-123456.okta.com) |
userId | string | はい | User ID or login to deactivate |
sendEmail | boolean | いいえ | Send deactivation email to admin (default: false) |
| パラメータ | 型 | 説明 |
|---|
userId | string | Deactivated user ID |
deactivated | boolean | Whether the user was deactivated |
success | boolean | Operation success status |
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.
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Okta API token for authentication |
domain | string | はい | Okta domain (e.g., dev-123456.okta.com) |
userId | string | はい | User ID or login to suspend |
| パラメータ | 型 | 説明 |
|---|
userId | string | Suspended user ID |
suspended | boolean | Whether the user was suspended |
success | boolean | Operation success status |
Unsuspend a previously suspended user in your Okta organization. Returns the user to ACTIVE status.
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Okta API token for authentication |
domain | string | はい | Okta domain (e.g., dev-123456.okta.com) |
userId | string | はい | User ID or login to unsuspend |
| パラメータ | 型 | 説明 |
|---|
userId | string | Unsuspended user ID |
unsuspended | boolean | Whether the user was unsuspended |
success | boolean | Operation success status |
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.
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Okta API token for authentication |
domain | string | はい | Okta domain (e.g., dev-123456.okta.com) |
userId | string | はい | User ID or login to reset password for |
sendEmail | boolean | いいえ | Send password reset email to the user (default: true) |
| パラメータ | 型 | 説明 |
|---|
userId | string | User ID |
resetPasswordUrl | string | Password reset URL (only returned when sendEmail is false) |
success | boolean | Operation success status |
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.
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Okta API token for authentication |
domain | string | はい | Okta domain (e.g., dev-123456.okta.com) |
userId | string | はい | User ID to delete |
sendEmail | boolean | いいえ | Send deactivation email to admin (default: false) |
| パラメータ | 型 | 説明 |
|---|
userId | string | Deleted user ID |
deleted | boolean | Whether the user was deleted |
success | boolean | Operation success status |
List all groups in your Okta organization with optional search and filtering
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Okta API token for authentication |
domain | string | はい | Okta domain (e.g., dev-123456.okta.com) |
search | string | いいえ | Okta search expression for groups (e.g., profile.name sw "Engineering" or type eq "OKTA_GROUP") |
filter | string | いいえ | Okta filter expression (e.g., type eq "OKTA_GROUP") |
limit | number | いいえ | Maximum number of groups to return (default: 10000, max: 10000) |
| パラメータ | 型 | 説明 |
|---|
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 |
Get a specific group by ID from your Okta organization
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Okta API token for authentication |
domain | string | はい | Okta domain (e.g., dev-123456.okta.com) |
groupId | string | はい | Group ID to look up |
| パラメータ | 型 | 説明 |
|---|
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 |
Create a new group in your Okta organization
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Okta API token for authentication |
domain | string | はい | Okta domain (e.g., dev-123456.okta.com) |
name | string | はい | Name of the group |
description | string | いいえ | Description of the group |
| パラメータ | 型 | 説明 |
|---|
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 |
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).
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Okta API token for authentication |
domain | string | はい | Okta domain (e.g., dev-123456.okta.com) |
groupId | string | はい | Group ID to update |
name | string | はい | Updated group name |
description | string | いいえ | Updated group 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 |
Delete a group from your Okta organization. Groups of OKTA_GROUP or APP_GROUP type can be removed.
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Okta API token for authentication |
domain | string | はい | Okta domain (e.g., dev-123456.okta.com) |
groupId | string | はい | Group ID to delete |
| パラメータ | 型 | 説明 |
|---|
groupId | string | Deleted group ID |
deleted | boolean | Whether the group was deleted |
success | boolean | Operation success status |
Add a user to a group in your Okta organization
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Okta API token for authentication |
domain | string | はい | Okta domain (e.g., dev-123456.okta.com) |
groupId | string | はい | Group ID to add the user to |
userId | string | はい | User ID to add to the group |
| パラメータ | 型 | 説明 |
|---|
groupId | string | Group ID |
userId | string | User ID added to the group |
added | boolean | Whether the user was added |
success | boolean | Operation success status |
Remove a user from a group in your Okta organization
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Okta API token for authentication |
domain | string | はい | Okta domain (e.g., dev-123456.okta.com) |
groupId | string | はい | Group ID to remove the user from |
userId | string | はい | User ID to remove from the group |
| パラメータ | 型 | 説明 |
|---|
groupId | string | Group ID |
userId | string | User ID removed from the group |
removed | boolean | Whether the user was removed |
success | boolean | Operation success status |
List all members of a specific group in your Okta organization
| パラメータ | 型 | 必須 | 説明 |
|---|
apiKey | string | はい | Okta API token for authentication |
domain | string | はい | Okta domain (e.g., dev-123456.okta.com) |
groupId | string | はい | Group ID to list members for |
limit | number | いいえ | Maximum number of members to return (default: 1000, max: 1000) |
| パラメータ | 型 | 説明 |
|---|
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 |