/api/space/user-management/clear-local-passwords

The following operation is supported on this resource:

  • POST - Clear local password of users
POST /clear-local-passwords Version 3

Clear local password of users.

Sample Usage

POST /clear-local-passwords


  • Sample Input XML:
    <clear-local-passwords-request>
         <users>
               <user href="/api/space/user-management/users/{id}"/>
         </users>
    </clear-local-passwords-request>

  • Sample Output XML:
    <users total="Integer" uri="/api/space/user-management/users">
         <user href="/api/space/user-management/users/{id}" uri="/api/space/user-management/users/{id}">
               <id>Integer</id>
               <name>String</name>
               <first-name>String</first-name>
               <last-name>String</last-name>
               <primary-email>String</primary-email>
               <domains total="Integer">
                   <domain href="/api/space/domain-management/domains/{id}" uri="/api/space/user-management/users/{id}">
                         <id>Integer</id>
                         <name>String</name>
                   </domain>
               </domains>
               <auth-mode>String</auth-mode>
               <status>String</status>
               <password-status>ACTIVE</password-status>
               <role-type>GUI_ROLE_ACCESS</role-type>
               <lock-out-status>String</lock-out-status>
               <read-only>Boolean</read-only>
         </user>
    </users>

  • Sample Input JSON:
    {
       "clear-local-passwords-request" : {
         "users" : {
           "user" : [
             {
               "@href" : "/api/space/user-management/users/{id}"
             }
           ]
         }
       }
    }

  • Sample Output JSON:
    {
       "users" : {
         "@total" : "Integer" ,
         "@uri" : "/api/space/user-management/users" ,
         "user" : {
           "@href" : "/api/space/user-management/users/{id}" ,
           "@uri" : "/api/space/user-management/users/{id}" ,
           "id" : "Integer" ,
           "name" : "String" ,
           "first-name" : "String" ,
           "last-name" : "String" ,
           "primary-email" : "String" ,
           "domains" : {
             "@total" : "Integer" ,
             "domain" : {
               "@href" : "/api/space/domain-management/domains/{id}" ,
               "@uri" : "/api/space/user-management/users/{id}" ,
               "id" : "Integer" ,
               "name" : "String"
             }
           } ,
           "auth-mode" : "String" ,
           "status" : "String" ,
           "password-status" : "ACTIVE" ,
           "role-type" : "GUI_ROLE_ACCESS" ,
           "lock-out-status" : "String" ,
           "read-only" : "Boolean"
         }
       }
    }

  • Access Control

    The following capabilities are required to access this API: ClearLocalPasswords