Identity Manager Home REST APIs

Identity Manager Home incorporates several REST APIs that enable different features within the user interface.

For information about the REST APIs Identity Manager Home uses, see the following sections:

IMPORTANT:When you invoke a REST call containing an incorrect payload for removing an object, it returns a success response even if the item required to be removed does not exist.

1.0 POST /api/util/permssort (sort a list of permissions by display name)

Sort the specified list of permissions by display name.

NOTE:This REST API does not require authentication.

Used In

Team compare view

URL Parameters

None

Data to Send

{
    "perms": [
        {
            "id": "cn=changepwd,cn=RequestDefs,cn=AppConfig,cn=User Application Driver,cn=driverset1,o=system",
            "name": "Change Password"
        },
        {
            "id": "cn=billing,cn=Level10,cn=RoleDefs,cn=RoleConfig,cn=AppConfig,cn=User Application Driver,cn=driverset1,o=system",
            "name": "Billing Department Access" 
        }
    ]
}

Response payload for status code: 200 OK

{
    "perms": [
        {
            "id": "cn=billing,cn=Level10,cn=RoleDefs,cn=RoleConfig,cn=AppConfig,cn=User Application Driver,cn=driverset1,o=system",
            "name": "Billing Department Access" 
        },
        {
            "id": "cn=changepwd,cn=RequestDefs,cn=AppConfig,cn=User Application Driver,cn=driverset1,o=system",
            "name": "Change Password"
        }
        
    ]
}

2.0 POST /api/util/usersort (sort a list of users by full name)

Sort the specified list of users by full name.

NOTE:This REST API does not require authentication.

Used In

Team compare view

URL Parameters

None

Data to Send

{
    "users": [
        {
            "id": "cn=bbender,ou=users,o=novell",
            "name": "Bill Bender"
        },
        {
            "id": "cn=cnano,ou=users,o=novell",
            "name": "Chip Nano" 
        },
        {
            "id": "cn=ablake,ou=users,o=novell",
            "name": "Allison Blake" 
        }
    ]
}

Response payload for status code: 200 OK

{
    "users": [
        {
            "id": "cn=ablake,ou=users,o=novell",
            "name": "Allison Blake" 
        },
        {
            "id": "cn=bbender,ou=users,o=novell",
            "name": "Bill Bender"
        },
        {
            "id": "cn=cnano,ou=users,o=novell",
            "name": "Chip Nano" 
        }
        
    ]
}

3.0 POST /api/util/tasksort (sort a list of tasks by the specified column)

Sort the specified tasks by the specified column.

NOTE:This REST API does not require authentication.

Used In

Dashboard task view

URL Parameters

None

Data to Send

{
    "sortBy":"recipientName",
    "sortOrder":"ASC",
    "tasks": [
        {
            "taskId":"85a180b8fad3425fb58a6d906075571a",
            "processName":"Anonymous Access - Create New User",
            "creationTime":"1337273009422",
            "expirationTime":"1338482609422",
            "recipient":  "cn=bmalley,ou=users,o=novell",    
            "recipientName":  "Bill Malley",    
            "simpleForm":  true
        },
        { 
            "taskId":"85a180b8fad3425fb58a6d906075571a",
            "processName":"Anonymous Access -Delete User",
            "creationTime":"1337273009422",
            "expirationTime":"1338482609422",
            "recipient":  "cn=ablake,ou=users,o=novell",    
            "recipientName":  "Allison Blake",    
            "simpleForm":  true
        }
    ]
}

NOTE:

The recipientName value must be a value in the JSON data.
For the sortOrder value, you can specify either ASC (ascending order) or DESC (descending order).

Response payload for status code: 200 OK

{
    "sortBy":"recipientName",
    "sortOrder":"ASC",
    "tasks": [
        { 
            "taskId":"85a180b8fad3425fb58a6d906075571a",
            "processName":"Anonymous Access -Delete User",
            "creationTime":"1337273009422",
            "expirationTime":"1338482609422",
            "recipient":  "cn=ablake,ou=users,o=novell",    
            "recipientName":  "Allison Blake",    
            "simpleForm":  true
        },
        {
            "taskId":"85a180b8fad3425fb58a6d906075571a",
            "processName":"Anonymous Access - Create New User",
            "creationTime":"1337273009422",
            "expirationTime":"1338482609422",
            "recipient":  "cn=bmalley,ou=users,o=novell",    
            "recipientName":  "Bill Malley",    
            "simpleForm":  true
        }
    ]
}