Showing content from https://developer.okta.com/okta-sdk-nodejs/jsdocs/User.html below:
Okta API wrapper for Node.js Class: User
Class: User User
new User()
Properties:
Name Type Description _embedded hash _links hash activated dateTime created dateTime credentials UserCredentials id string lastLogin dateTime lastUpdated dateTime passwordChanged dateTime profile UserProfile status UserStatus statusChanged dateTime transitioningToStatus UserStatus type UserType
Extends
Methods
-
activate(queryParameters)
-
Parameters: Name Type Description
queryParameters object
Returns:
-
Type
-
Promise.<UserActivationToken>
-
addAllAppsAsTarget(roleId)
-
Parameters: Name Type Description
roleId string
-
addGroupTarget(roleId, groupId)
-
Parameters: Name Type Description
roleId string groupId string
-
addToGroup(groupId)
-
Parameters: Name Type Description
groupId string
-
assignRole(assignRoleRequest, queryParameters)
-
Parameters:
Returns:
-
Type
-
Promise.<Role>
-
changePassword(changePasswordRequest, queryParameters)
-
Parameters:
Returns:
-
Type
-
Promise.<UserCredentials>
-
changeRecoveryQuestion(userCredentials)
-
Parameters:
Returns:
-
Type
-
Promise.<UserCredentials>
-
clearSessions(queryParameters)
-
Parameters: Name Type Description
queryParameters object
-
deactivate(queryParameters)
-
Parameters: Name Type Description
queryParameters object
-
delete(queryParameters)
-
Parameters: Name Type Description
queryParameters object
-
deleteFactor(factorId)
-
Parameters: Name Type Description
factorId string
-
enrollFactor(userFactor, queryParameters)
-
Parameters: Name Type Description
userFactor UserFactor queryParameters object
Returns:
-
Type
-
Promise.<UserFactor>
-
expirePassword()
-
Returns:
-
Type
-
Promise.<User>
-
expirePasswordAndGetTemporaryPassword()
-
Returns:
-
Type
-
Promise.<TempPassword>
-
forgotPasswordGenerateOneTimeToken(queryParameters)
-
Parameters: Name Type Description
queryParameters object
Returns:
-
Type
-
Promise.<ForgotPasswordResponse>
-
forgotPasswordSetNewPassword(userCredentials, queryParameters)
-
Parameters: Name Type Description
userCredentials UserCredentials queryParameters object
Returns:
-
Type
-
Promise.<ForgotPasswordResponse>
-
getFactor(factorId)
-
Parameters: Name Type Description
factorId string
Returns:
-
Type
-
Promise.<UserFactor>
-
getLinkedObjects(relationshipName, queryParameters)
-
Parameters: Name Type Description
relationshipName string queryParameters object
Returns:
-
Type
-
Promise.<Collection>
-
getRefreshTokenForUserAndClient(clientId, tokenId, queryParameters)
-
Parameters: Name Type Description
clientId string tokenId string queryParameters object
Returns:
-
Type
-
Promise.<OAuth2RefreshToken>
-
getRole(roleId)
-
Parameters: Name Type Description
roleId string
Returns:
-
Type
-
Promise.<Role>
-
listAppLinks()
-
Returns:
A collection that will yield
AppLink
instances.
-
Type
-
Promise.<Collection>
-
listAssignedRoles(queryParameters)
-
Parameters: Name Type Description
queryParameters object
Returns:
A collection that will yield
Role
instances.
-
Type
-
Promise.<Collection>
-
listClients()
-
Returns:
-
Type
-
Promise.<Collection>
-
listFactors()
-
Returns:
A collection that will yield
UserFactor
instances.
-
Type
-
Promise.<Collection>
-
listGrants(queryParameters)
-
Parameters: Name Type Description
queryParameters object
Returns:
-
Type
-
Promise.<Collection>
-
listGroups()
-
Returns:
A collection that will yield
Group
instances.
-
Type
-
Promise.<Collection>
-
listGroupTargets(roleId, queryParameters)
-
Parameters: Name Type Description
roleId string queryParameters object
Returns:
A collection that will yield
Group
instances.
-
Type
-
Promise.<Collection>
-
listIdentityProviders()
-
Returns:
-
Type
-
Promise.<Collection>
-
listRefreshTokensForUserAndClient(clientId, queryParameters)
-
Parameters: Name Type Description
clientId string queryParameters object
Returns:
-
Type
-
Promise.<Collection>
-
listSupportedFactors()
-
Returns:
A collection that will yield
UserFactor
instances.
-
Type
-
Promise.<Collection>
-
listSupportedSecurityQuestions()
-
Returns:
-
Type
-
Promise.<Collection>
-
reactivate(queryParameters)
-
Parameters: Name Type Description
queryParameters object
Returns:
-
Type
-
Promise.<UserActivationToken>
-
removeGroupTarget(roleId, groupId)
-
Parameters: Name Type Description
roleId string groupId string
-
removeLinkedObject(relationshipName)
-
Parameters: Name Type Description
relationshipName string
-
removeRole(roleId)
-
Parameters: Name Type Description
roleId string
-
resetPassword(queryParameters)
-
Parameters: Name Type Description
queryParameters object
Returns:
-
Type
-
Promise.<ResetPasswordToken>
-
revokeGrant(grantId)
-
Parameters: Name Type Description
grantId string
-
revokeGrantsForUserAndClient(clientId)
-
Parameters: Name Type Description
clientId string
-
revokeTokenForUserAndClient(clientId, tokenId)
-
Parameters: Name Type Description
clientId string tokenId string
-
revokeTokensForUserAndClient(clientId)
-
Parameters: Name Type Description
clientId string
-
setLinkedObject(primaryRelationshipName, primaryUserId)
-
Parameters: Name Type Description
primaryRelationshipName string primaryUserId string
-
update(queryParameters)
-
Parameters: Name Type Description
queryParameters object
Returns:
-
Type
-
Promise.<User>
RetroSearch is an open source project built by @garambo
| Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4