Jump to

• Request
• Response

PasswordReset using current password and userid

post

/oam/services/rest/access/api/v1/pswdmanagement/PasswordResetRequests/${userid}

An admin authenticated web application can update the user password by using the current and the new password provided to update the password to a new value. The user details can be given as path parameter. This variation of the API is used for users belonging to default idstore in OAM.

Request

Path Parameters

• userid: string
  Input to uniquely identify user

Query Parameters

• userdetails(optional): string
  userdetails object in query parameter.

Body ()

The request object

Root Schema : PasswordResetRequest

Type: object

Show Source

• newpassword(optional): string
  Password to be set
• originalpassword(optional): string
  User password
• username(optional): object userdetails

{
    "type":"object",
    "properties":{
        "username":{
            "$ref":"#/definitions/userdetails"
        },
        "originalpassword":{
            "type":"string",
            "description":"User password"
        },
        "newpassword":{
            "type":"string",
            "description":"Password to be set"
        }
    }
}

Nested Schema : userdetails

Type: object

Show Source

• dn(optional): string
  the distinguished name of the user in the identity store
• idstoreref(optional): string
  idstore that the user belongs to
• tenantname(optional): string
  tenant name. Its always systemTenant
• username(optional): string
  the short name of the user

{
    "type":"object",
    "properties":{
        "tenantname":{
            "type":"string",
            "description":"tenant name. Its always systemTenant"
        },
        "idstoreref":{
            "type":"string",
            "description":"idstore that the user belongs to"
        },
        "dn":{
            "type":"string",
            "description":"the distinguished name of the user in the identity store"
        },
        "username":{
            "type":"string",
            "description":"the short name of the user"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Password reset response

Body ()

Root Schema : ResetPasswordChallengesResponse

Type: object

Show Source

• isValid(optional): boolean
• messages(optional): array messages

{
    "type":"object",
    "properties":{
        "isValid":{
            "type":"boolean"
        },
        "messages":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PolicyMessage"
            }
        }
    }
}

Nested Schema : messages

Type: array

Show Source

• Array of: object PolicyMessage

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PolicyMessage"
    }
}

Nested Schema : PolicyMessage

Type: object

Show Source

• displayValue(optional): string
• resourceBundleKey(optional): string

{
    "properties":{
        "resourceBundleKey":{
            "type":"string"
        },
        "displayValue":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

404 Response

Requested entity not found

500 Response

Internal Server Error

Back to Top