Okta API wrapper for Node.js

Class: GeneratedApiClient

GeneratedApiClient

new GeneratedApiClient()

Auto-Generated API client, implementes the operations as defined in the OpenaAPI JSON spec

Extends

Methods

activateRule(ruleId)

Convenience method for /api/v1/groups/rules/{ruleId}/lifecycle/activate
Parameters:
Name Type Description
ruleId String

activateUser(userId, queryParams)

Convenience method for /api/v1/users/{userId}/lifecycle/activate
Parameters:
Name Type Description
userId String
queryParams Object Map of query parameters to add to this request
Properties
Name Type Argument Description
sendEmail String <optional>

addGroupTargetToRole(userId, roleId, groupId)

Convenience method for /api/v1/users/{userId}/roles/{roleId}/targets/groups/{groupId}
Parameters:
Name Type Description
userId String
roleId String
groupId String

addRoleToUser(userId, role)

Convenience method for /api/v1/users/{userId}/roles
Parameters:
Name Type Description
userId String
role Role

addUserToGroup(groupId, userId)

Convenience method for /api/v1/groups/{groupId}/users/{userId}
Parameters:
Name Type Description
groupId String
userId String

changePassword(userId, changePasswordRequest)

Convenience method for /api/v1/users/{userId}/credentials/change_password
Parameters:
Name Type Description
userId String
changePasswordRequest ChangePasswordRequest

changeRecoveryQuestion(userId, userCredentials)

Convenience method for /api/v1/users/{userId}/credentials/change_recovery_question
Parameters:
Name Type Description
userId String
userCredentials UserCredentials

createGroup(group)

Adds a new group with `OKTA_GROUP` type to your organization.
Parameters:
Name Type Description
group Group

createRule(groupRule)

Creates a group rule to dynamically add users to the specified group if they match the condition
Parameters:
Name Type Description
groupRule GroupRule

createUser(user, queryParams)

Creates a new user in your Okta organization with or without credentials.
Parameters:
Name Type Description
user User
queryParams Object Map of query parameters to add to this request
Properties
Name Type Argument Description
activate String <optional>
provider String <optional>

deactivateOrDeleteUser(userId)

Convenience method for /api/v1/users/{userId}
Parameters:
Name Type Description
userId String

deactivateRule(ruleId)

Convenience method for /api/v1/groups/rules/{ruleId}/lifecycle/deactivate
Parameters:
Name Type Description
ruleId String

deactivateUser(userId)

Convenience method for /api/v1/users/{userId}/lifecycle/deactivate
Parameters:
Name Type Description
userId String

deleteGroup(groupId)

Convenience method for /api/v1/groups/{groupId}
Parameters:
Name Type Description
groupId String

deleteRule(ruleId, queryParams)

Convenience method for /api/v1/groups/rules/{ruleId}
Parameters:
Name Type Description
ruleId String
queryParams Object Map of query parameters to add to this request
Properties
Name Type Argument Description
removeUsers String <optional>

expirePassword(userId, queryParams)

Convenience method for /api/v1/users/{userId}/lifecycle/expire_password
Parameters:
Name Type Description
userId String
queryParams Object Map of query parameters to add to this request
Properties
Name Type Argument Description
tempPassword String <optional>

forgotPassword(userId, userCredentials, queryParams)

Convenience method for /api/v1/users/{userId}/credentials/forgot_password
Parameters:
Name Type Description
userId String
userCredentials UserCredentials
queryParams Object Map of query parameters to add to this request
Properties
Name Type Argument Description
sendEmail String <optional>

getGroup(groupId, queryParams)

Convenience method for /api/v1/groups/{groupId}
Parameters:
Name Type Description
groupId String
queryParams Object Map of query parameters to add to this request
Properties
Name Type Argument Description
expand String <optional>

getGroupStats(groupId)

Convenience method for /api/v1/groups/{groupId}/stats
Parameters:
Name Type Description
groupId String

getRule(ruleId)

Convenience method for /api/v1/groups/rules/{ruleId}
Parameters:
Name Type Description
ruleId String

getUser(userId)

Convenience method for /api/v1/users/{userId}
Parameters:
Name Type Description
userId String
Convenience method for /api/v1/users/{userId}/appLinks
Parameters:
Name Type Description
userId String
queryParams Object Map of query parameters to add to this request
Properties
Name Type Argument Description
showAll String <optional>

listAssignedRoles(userId, queryParams)

Convenience method for /api/v1/users/{userId}/roles
Parameters:
Name Type Description
userId String
queryParams Object Map of query parameters to add to this request
Properties
Name Type Argument Description
expand String <optional>

listGroups(queryParams)

Enumerates groups in your organization with pagination. A subset of groups can be returned that match a supported filter expression or query.
Parameters:
Name Type Description
queryParams Object Map of query parameters to add to this request
Properties
Name Type Argument Description
q String <optional>
filter String <optional>
after String <optional>
limit String <optional>
expand String <optional>

listGroupTargetsForRole(userId, roleId, queryParams)

Convenience method for /api/v1/users/{userId}/roles/{roleId}/targets/groups
Parameters:
Name Type Description
userId String
roleId String
queryParams Object Map of query parameters to add to this request
Properties
Name Type Argument Description
after String <optional>
limit String <optional>

listGroupUsers(groupId, queryParams)

Convenience method for /api/v1/groups/{groupId}/users
Parameters:
Name Type Description
groupId String
queryParams Object Map of query parameters to add to this request
Properties
Name Type Argument Description
after String <optional>
limit String <optional>

listRules(queryParams)

Lists all group rules for your organization.
Parameters:
Name Type Description
queryParams Object Map of query parameters to add to this request
Properties
Name Type Argument Description
limit String <optional>
after String <optional>

listUserGroups(userId, queryParams)

Convenience method for /api/v1/users/{userId}/groups
Parameters:
Name Type Description
userId String
queryParams Object Map of query parameters to add to this request
Properties
Name Type Argument Description
after String <optional>
limit String <optional>

listUsers(queryParams)

Lists users in your organization with pagination in most cases. A subset of users can be returned that match a supported filter expression or search criteria.
Parameters:
Name Type Description
queryParams Object Map of query parameters to add to this request
Properties
Name Type Argument Description
q String <optional>
after String <optional>
limit String <optional>
filter String <optional>
format String <optional>
search String <optional>
expand String <optional>

removeGroupTargetFromRole(userId, roleId, groupId)

Convenience method for /api/v1/users/{userId}/roles/{roleId}/targets/groups/{groupId}
Parameters:
Name Type Description
userId String
roleId String
groupId String

removeGroupUser(groupId, userId)

Convenience method for /api/v1/groups/{groupId}/users/{userId}
Parameters:
Name Type Description
groupId String
userId String

removeRoleFromUser(userId, roleId)

Convenience method for /api/v1/users/{userId}/roles/{roleId}
Parameters:
Name Type Description
userId String
roleId String

resetAllFactors(userId)

Convenience method for /api/v1/users/{userId}/lifecycle/reset_factors
Parameters:
Name Type Description
userId String

resetPassword(userId, queryParams)

Convenience method for /api/v1/users/{userId}/lifecycle/reset_password
Parameters:
Name Type Description
userId String
queryParams Object Map of query parameters to add to this request
Properties
Name Type Argument Description
provider String <optional>
sendEmail String <optional>

suspendUser(userId)

Convenience method for /api/v1/users/{userId}/lifecycle/suspend
Parameters:
Name Type Description
userId String

unlockUser(userId)

Convenience method for /api/v1/users/{userId}/lifecycle/unlock
Parameters:
Name Type Description
userId String

unsuspendUser(userId)

Convenience method for /api/v1/users/{userId}/lifecycle/unsuspend
Parameters:
Name Type Description
userId String

updateGroup(groupId, group)

Convenience method for /api/v1/groups/{groupId}
Parameters:
Name Type Description
groupId String
group Group

updateRule(ruleId, groupRule)

Convenience method for /api/v1/groups/rules/{ruleId}
Parameters:
Name Type Description
ruleId String
groupRule GroupRule

updateUser(userId, user)

Convenience method for /api/v1/users/{userId}
Parameters:
Name Type Description
userId String
user User