REST API for Password Management in Oracle Access Manager

Get Password policy using userdetails

get

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

REST API for getting the applicable password policy for the user. This can be used in an application to display the password rules for the user that the password need to conform to. The userdetails is given as part of query parameter.

Request

Query Parameters

isDescription: boolean

Whether password rules are supposed to come as description
userdetails: string

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.

Response

Supported Media Types

application/json

200 Response

Password policy assignment

Root Schema : PolicyDescriptionResponse

Type: object

Show Source

messages: array messages

{
    "properties":{
        "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: string
resourceBundleKey: string

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

401 Response

Unauthorized

404 Response

Requested entity not found

500 Response

Internal Server Error

Examples

This example demonstrates the method of getting queried templates.

cURL Example

curl  -H "Content-Type: application/json"  -X GET  -u username:password  https://pseudo.com/iam/governance/applicationmanagement/api/v1/templates?name=Sample

Example of Request Body

The following example shows the contents of the response body in JSON format.

[
  {
    "applicationName": "Sample Disconnected Template",
    "status": "ACTIVE"
  }
]