Jump to

• Request
• Response

PasswordReset using OTP and userdetails

post

/oam/services/rest/access/api/v1/pswdmanagement/PasswordResetRequestsWithOTP

An authenticated web application can update the password or challenges to be reset for a user uniquely identified by query parameter or the request object . The query parameter takes precendence if present over the request object and is of the form systemTenant::UserDN::IDSTOREREF::UserID. For example, userdetails=systemTenant::cn=normal,ou=users,dc=ngam,dc=oracle,dc=com::oud::normal.

Request

Query Parameters

• userdetails(optional): string
  userdetails object in query parameter.The query parameter takes the input of the form systemTenant::UserDN::IDSTOREREF::UserID. For example, userdetails=systemTenant::cn=normal,ou=users,dc=ngam,dc=oracle,dc=com::oud::normal.

Body ()

The request object

Root Schema : PasswordResetRequestWithOTPRequest

Type: object

Show Source

• otp(optional): object ValidateOTPRequest
• password(optional): string
  User password
• username(optional): object userdetails

{
    "type":"object",
    "properties":{
        "username":{
            "$ref":"#/definitions/userdetails"
        },
        "password":{
            "type":"string",
            "description":"User password"
        },
        "otp":{
            "$ref":"#/definitions/ValidateOTPRequest"
        }
    }
}

Nested Schema : ValidateOTPRequest

Type: object

Show Source

• appName: string
  Name defining calling app.
• correlationId: string
  CorrelationId returned by createOTP api.
• otpCode: string
  User entered otp code to be validated.
• sessionId(optional): string
  SessionId associated with OTP generation.
• userId: string
  Username of user to generate OTP code for.

{
    "type":"object",
    "required":[
        "userId",
        "correlationId",
        "otpCode",
        "appName"
    ],
    "properties":{
        "userId":{
            "description":"Username of user to generate OTP code for.",
            "type":"string"
        },
        "correlationId":{
            "description":"CorrelationId returned by createOTP api.",
            "type":"string"
        },
        "otpCode":{
            "description":"User entered otp code to be validated.",
            "type":"string"
        },
        "appName":{
            "description":"Name defining calling app.",
            "type":"string"
        },
        "sessionId":{
            "description":"SessionId associated with OTP generation.",
            "type":"string"
        }
    }
}

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 policy assignment

Body ()

Root Schema : PasswordResetWithOTPResponse

Type: object

Show Source

• isValid(optional): boolean
• messages(optional): array messages
• validateOTPResponse(optional): object ValidateOTPResponse

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

Nested Schema : messages

Type: array

Show Source

• Array of: object PolicyMessage

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

Nested Schema : ValidateOTPResponse

Type: object

Show Source

• message(optional): string
  Message describing error, if any.
• minorCode(optional): string
  Minor code indicating error details.
• resultCode(optional): string
  Respose code indicating success (0) or error.

{
    "properties":{
        "resultCode":{
            "type":"string",
            "description":"Respose code indicating success (0) or error."
        },
        "minorCode":{
            "type":"string",
            "description":"Minor code indicating error details."
        },
        "message":{
            "type":"string",
            "description":"Message describing error, if any."
        }
    }
}

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