REST Resources

/api/space/user-management/users/{id} (v1)

The following operations are supported on this resource:

  • GET - Get a single user
GET /users/{id} Version 1

This API retrieves information about a user specified by user ID. The information is returned in a User transfer object.

Sample Usage

GET /users/{id}


  • Parameters:
    Name Type URI Type Description Required
    id int Path The ID for user whose information will be retrieved. Y
  • Sample Output XML:
    <user uri="/api/space/user-management/users/519">
        <id>519</id>
        <name>super</name>
        <firstName>Open</firstName>
        <lastName>Space</lastName>
        <password>ok89Nva6qHxytSHsP8AeLg==</password>
        <primaryEmail>super@juniper.net</primaryEmail>
        <auto-logout-time>111</auto-logout-time>
        <use-global-logout-time>false</use-global-logout-time>
       <api-access-profile href="/api/space/user-management/api-access-profiles/12345" >
              <id>12345</id>
            <name>apiaccessprofile</name>
       </api-access-profile>
        <authMode>local</authMode>
        <roles uri="/api/space/user-management/users/519/roles" >
            <role uri="/api/space/user-management/users/519/roles/54"
                 href= "/api/space/user-management/roles/54">
              <id>54</id>
            <name>superAdmin</name>
            </role>
        </roles>
         <x509-authentication-parameters>
               <x509-authentication-parameter>
                   <parameter-value>String</parameter-value>
                   <x509-certificate-parameter>
                         <x509-parameter-name>String</x509-parameter-name>
                   </x509-certificate-parameter>
               </x509-authentication-parameter>
         </x509-authentication-parameters>
      <method href="/api/space/user-management/users/196651/change-password" rel="change-password" />
    </user>

  • Sample Output JSON:
    {
      "user": {
          "@uri":"/api/space/user-management/users/65859" ,
          "id":65859,
          "name":"super",
          "firstName":"Open",
          "lastName":"Space",
          "password":"ok89Nva6qHxytSHsP8AeLg==",
          "primaryEmail":"super@juniper.net",
          "auto-logout-time":5,
          "use-global-logout-time":false,
        "api-access-profile": {
            "@href":"/api/space/user-management/api-access-profiles/12345",
                 "id": 12345,
                  "name":"apiaccessprofile"
              },
          "authMode":"local",
          "roles": {
              "@uri": "/api/space/user-management/users/65859/roles",
              "role": {
                  "@uri":"/api/space/user-management/users/65859/roles/65593",
                  "@href":"/api/space/user-management/roles/65593",
                 "id": 65593,
                  "name":"superAdmin"
              }
          },
         "x509-authentication-parameters" : {
           "x509-authentication-parameter" : {
             "parameter-value" : "String" ,
             "x509-certificate-parameter" : {
               "x509-parameter-name" : "String"
             }
           }
         },
          "method":{
               "@href": "/api/space/user-management/users/196651/change-password",
               "@rel": "change-password"
          }
      }
    }

    • Access Control

    The following capabilities are required to access this API: DefaultRead

      For the current version of this API, refer to :
    • version 3