@@ -300,7 +300,7 @@ Permanently delete a user from your Okta organization. Can only be performed on
300300| --------- | ---- | -------- | ----------- |
301301| ` apiKey ` | string | Yes | Okta API token for authentication |
302302| ` domain ` | string | Yes | Okta domain \( e.g., dev-123456.okta.com\) |
303- | ` userId ` | string | Yes | User ID to delete |
303+ | ` userId ` | string | Yes | User ID or login \( email \) to delete |
304304| ` sendEmail ` | boolean | No | Send deactivation email to admin \( default: false\) |
305305
306306#### Output
@@ -690,7 +690,7 @@ List the MFA factors a user has enrolled, with each factor type, provider, and e
690690| --------- | ---- | -------- | ----------- |
691691| ` apiKey ` | string | Yes | Okta API token for authentication |
692692| ` domain ` | string | Yes | Okta domain \( e.g., dev-123456.okta.com\) |
693- | ` userId ` | string | Yes | User ID or login to list enrolled factors for |
693+ | ` userId ` | string | Yes | Okta user ID \( not a login or email \) to list enrolled factors for |
694694
695695#### Output
696696
@@ -718,7 +718,7 @@ Retrieve a single enrolled MFA factor for a user, including its type, provider,
718718| --------- | ---- | -------- | ----------- |
719719| ` apiKey ` | string | Yes | Okta API token for authentication |
720720| ` domain ` | string | Yes | Okta domain \( e.g., dev-123456.okta.com\) |
721- | ` userId ` | string | Yes | User ID or login the factor belongs to |
721+ | ` userId ` | string | Yes | Okta user ID \( not a login or email \) the factor belongs to |
722722| ` factorId ` | string | Yes | Factor ID to look up |
723723
724724#### Output
@@ -745,7 +745,7 @@ Enroll an MFA factor for a user. The profile fields required depend on the facto
745745| --------- | ---- | -------- | ----------- |
746746| ` apiKey ` | string | Yes | Okta API token for authentication |
747747| ` domain ` | string | Yes | Okta domain \( e.g., dev-123456.okta.com\) |
748- | ` userId ` | string | Yes | User ID or login to enroll the factor for |
748+ | ` userId ` | string | Yes | Okta user ID \( not a login or email \) to enroll the factor for |
749749| ` factorType ` | string | Yes | Factor type to enroll \( sms, call, email, question, push, token:software:totp, u2f, webauthn\) |
750750| ` provider ` | string | Yes | Factor provider \( OKTA, GOOGLE, FIDO, DUO, RSA, SYMANTEC, YUBICO, CUSTOM\) . Each provider supports a subset of factor types |
751751| ` phoneNumber ` | string | No | Phone number in E.164 format. Required for the sms and call factor types |
@@ -779,7 +779,7 @@ Unenroll one specific MFA factor for a user so they can re-enroll it. Destructiv
779779| --------- | ---- | -------- | ----------- |
780780| ` apiKey ` | string | Yes | Okta API token for authentication |
781781| ` domain ` | string | Yes | Okta domain \( e.g., dev-123456.okta.com\) |
782- | ` userId ` | string | Yes | User ID or login the factor belongs to |
782+ | ` userId ` | string | Yes | Okta user ID \( not a login or email \) the factor belongs to |
783783| ` factorId ` | string | Yes | Factor ID to unenroll |
784784| ` removeRecoveryEnrollment ` | boolean | No | Also remove the phone number as a recovery method, not only as a factor. Applies to sms and call factors only \( default: false\) |
785785
@@ -822,7 +822,7 @@ Revoke every active Okta session for a user, signing them out of all devices imm
822822| --------- | ---- | -------- | ----------- |
823823| ` apiKey ` | string | Yes | Okta API token for authentication |
824824| ` domain ` | string | Yes | Okta domain \( e.g., dev-123456.okta.com\) |
825- | ` userId ` | string | Yes | User ID or login whose sessions will be revoked |
825+ | ` userId ` | string | Yes | Okta user ID \( not a login or email \) whose sessions will be revoked |
826826| ` oauthTokens ` | boolean | No | Also revoke the user OpenID Connect and OAuth refresh and access tokens \( default: false\) |
827827| ` forgetDevices ` | boolean | No | Clear the user remembered factors for all devices \( default: true\) |
828828
@@ -1136,7 +1136,7 @@ List the administrator roles assigned to a user. Returns both standard roles and
11361136| --------- | ---- | -------- | ----------- |
11371137| ` apiKey ` | string | Yes | Okta API token for authentication |
11381138| ` domain ` | string | Yes | Okta domain \( e.g., dev-123456.okta.com\) |
1139- | ` userId ` | string | Yes | User ID or login to list admin roles for |
1139+ | ` userId ` | string | Yes | Okta user ID \( not a login or email \) to list admin roles for |
11401140
11411141#### Output
11421142
@@ -1165,7 +1165,7 @@ Grant a user an administrator role. Use a standard role type such as USER_ADMIN
11651165| --------- | ---- | -------- | ----------- |
11661166| ` apiKey ` | string | Yes | Okta API token for authentication |
11671167| ` domain ` | string | Yes | Okta domain \( e.g., dev-123456.okta.com\) |
1168- | ` userId ` | string | Yes | User ID or login to assign the admin role to |
1168+ | ` userId ` | string | Yes | Okta user ID \( not a login or email \) to assign the admin role to |
11691169| ` roleType ` | string | Yes | Role 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 |
11701170| ` customRoleId ` | string | No | Custom role ID. Required when the role type is CUSTOM |
11711171| ` resourceSetId ` | string | No | Resource set ID the custom role applies to. Required when the role type is CUSTOM |
@@ -1197,7 +1197,7 @@ Revoke an administrator role from a user. Destructive: the user immediately lose
11971197| --------- | ---- | -------- | ----------- |
11981198| ` apiKey ` | string | Yes | Okta API token for authentication |
11991199| ` domain ` | string | Yes | Okta domain \( e.g., dev-123456.okta.com\) |
1200- | ` userId ` | string | Yes | User ID or login to revoke the admin role from |
1200+ | ` userId ` | string | Yes | Okta user ID \( not a login or email \) to revoke the admin role from |
12011201| ` roleAssignmentId ` | string | Yes | Role assignment ID to revoke, as returned by List User Roles. For a custom role this is the resource set binding ID |
12021202
12031203#### Output
0 commit comments