User Management API

/api/space/user-management/users/{id}

The following operations are supported on this resource:

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


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

Access Control

The following capabilities are required to access this API:
"ReadUser"


Example Usage

GET /api/space/user-management/users/{id}


Parameters

NameTypeURI TypeDescriptionRequired
idintPathThe ID for user whose information will be retrieved. Y

Content Types

  • Produces content types:
    application/vnd.net.juniper.space.user-management.user+xml;version=1
    application/vnd.net.juniper.space.user-management.user+json;version=1


  • Sample Output XML:
    <user uri="/api/space/user-management/users/519">
      <id>519</id>
      <name>super</name>
      <firstName>Open</firstName>
      <middleName>Open</middleName>
      <lastName>Space</lastName>
       <password>ok89Nva6qHxytSHsP8AeLg==</password>
      <primaryPhone>0013010000001</primaryPhone>
      <primaryEmail>super@juniper.net</primaryEmail>
      <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>
      <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",
      "middleName":"Test",
      "lastName":"Space",
      "password":"ok89Nva6qHxytSHsP8AeLg==",
      "primaryPhone":"0013010000001",
      "primaryEmail":"super@juniper.net",
      "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"
       }
     },
      "method":{
       "@href":"/api/space/user-management/users/196651/change-password",
       "@rel":"change-password"
     }
    }}



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


This API is used to modify user information.

Access Control

The following capabilities are required to access this API:
"ModifyUser"


Example Usage

PUT /api/space/user-management/users/{id}


Parameters

NameTypeURI TypeDescriptionRequired
idIntegerPathThe ID of the user whose information will be modified. Y

Data Notification

This API supports data notification.

See the following links for information about enabling data notifications changes to be received for this service:

  • Data Notification Usage.


Content Types

  • Consumes content types:
    application/vnd.net.juniper.space.user-management.user+xml;version=1;charset=UTF-8
    application/vnd.net.juniper.space.user-management.user+json;version=1;charset=UTF-8


  • Produces content types:
    application/vnd.net.juniper.space.user-management.user+xml;version=1
    application/vnd.net.juniper.space.user-management.user+json;version=1


  • Sample Input XML:
    <user>
       <name>test_12</name>
       <firstName>Test</firstName>
       <middleName>Test12</middleName>
       <lastName>Test</lastName>
       <password>0Nf72o7CPMCYNY6Ks213EQ==</password>
       <primaryPhone>0013010000001</primaryPhone>
       <primaryEmail>super@juniper.net</primaryEmail>
       <roles>
         <role href="/api/space/user-management/roles/65659" />
       </roles>
    </user>


  • Sample Output XML:
    <user uri="/api/space/user-management/users/3506194">
      <id>3506194</id>
      <name>test_12</name>
      <firstName>Test1</firstName>
      <middleName>Test</middleName>
      <lastName>Test</lastName>
      <password>ofQT2y3J5L5ujweGtHMuXg==</password>
      <primaryPhone>0013010000001</primaryPhone>
      <primaryEmail>super@juniper.net</primaryEmail>
      <roles uri="/api/space/user-management/users/3506194/roles">
        <role uri="/api/space/user-management/users/3506194/roles/65659" href="/api/space/user-management/roles/65659">
          <id>65659</id>
          <name>auditLogAdmin</name>

        </role>
      </roles>
    </user>


  • Sample Input JSON:
    {"user": {"name":"test_12", "firstName":"Test1", "middleName":"Test", "lastName":"Test", "password":"diJ900Bu5xYJvVGFzfNVaQ==", "primaryPhone":"0013010000001", "primaryEmail":"super@juniper.net", "roles": {"role":{ "@href":"/api/space/user-management/roles/65659" }} }}


  • Sample Output JSON:
    {"user":
      {"@uri":"/api/space/user-management/users/3506197",
        "id":3506197,
        "name":"test_12",
        "firstName":"Test1",
        "middleName":"Test",
        "lastName":"Test",
        "password":"ofQT2y3J5L5ujweGtHMuXg==",
        "primaryPhone":"0013010000001",
        "primaryEmail":"super@juniper.net",
        "roles":{"@uri":"/api/space/user-management/users/3506197/roles",
          "role":{"@uri":"/api/space/user-management/users/3506197/roles/65659",
            "@href":"/api/space/user-management/roles/65659",
            "id":656598,
            "name":"auditLogAdmin"
        }}
    }}



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


This API is used to delete a user specified by user ID.

Access Control

The following capabilities are required to access this API:
"DeleteUser"


Example Usage

DELETE /api/space/user-management/users/{id}


Parameters

NameTypeURI TypeDescriptionRequired
idIntegerPathUser ID of the user to be removed from the database. Y

Data Notification

This API supports data notification.

See the following links for information about enabling data notifications changes to be received for this service:

  • Data Notification Usage.