REST Resources
-
/ -
/active-user-sessions -
/active-user-sessions /{id} -
/api-access-profiles -
/api-access-profiles /{id} -
/capabilities -
/capabilities /{cid} /roles /{rid} -
/capabilities /{cid} /tasks /{tid} -
/capabilities /{id} -
/capabilities /{id} /roles -
/capabilities /{id} /tasks -
/certificate -
/certificate /{certificate-id} -
/check-enabled-tasks -
/clear-local-passwords -
/disable-users -
/enable-users -
/generate-temp-password -
/job-instances /{job-id} /export-roles-data -
/job-instances /{job-id} /terminate-user-session-job-results -
/login -
/login-status -
/logout -
/profiles -
/profiles /{id} -
/profiles /{id} /roles -
/profiles /{id} /roles /{rid} -
/roles -
/roles /{id} -
/roles /{role-id} /capabilities -
/roles /{role-id} /capabilities /{capability-id} -
/roles /{role-id} /tasks -
/roles /{role-id} /tasks /{task-id} -
/tasks -
/tasks /{id} -
/terminate-user-sessions -
/unlock-users -
/upload-image -
/user-preference-states -
/user-profiles -
/user-profiles /{profile-id} -
/users -
/users /{id} -
/users /{id} /active-user-sessions -
/users /{id} /disable-user -
/users /{id} /enable-user -
/users /{id} /roles -
/users /{uid} /active-user-sessions /{rid} -
/users /{uid} /roles /{rid} -
/users /{user-id} /capabilities -
/users /{user-id} /change-password -
/users /{user-id} /image -
/users /{user-id} /validate-password -
/validate-password
/api/space/user-management/users/{id}
The following operations are supported on this resource:
GET /users/{id} | Version 3 |
Get user by ID and encode the password with * characters.
Sample Usage
GET /users/{id}
- Parameters:
Name Type URI Type Description Required id Integer Path ID Y
- Accept Headers:
application/vnd.net.juniper.space.user-management.user+xml;version=3
application/vnd.net.juniper.space.user-management.user+json;version=3
<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>
<password>String</password>
<password-status>ACTIVE</password-status>
<password-expiry-date>java.sql.Timestamp</password-expiry-date>
<status>String</status>
<primary-email>String</primary-email>
<domain-name>String</domain-name>
<api-access-profile>String</api-access-profile>
<roles total="Integer" uri="/api/space/user-management/users/{id}/roles">
<role href="/api/space/user-management/roles/{roleId}"
uri="/api/space/user-management/users/{id}/roles/{roleId}">
<role-id>Integer</role-id>
<name>String</name>
</role>
</roles>
<role-type>GUI_ROLE_ACCESS</role-type>
<auth-mode>String</auth-mode>
<active-user-sessions total="Integer" uri="/api/space/user-management/users/{id}/active-user-sessions">
<active-user-session
href="/api/space/user-management/active-user-sessions/{id}"
uri="/api/space/user-management/users/{id}/active-user-sessions/{id}">
<id>Integer</id>
<name>String</name>
</active-user-session>
</active-user-sessions>
<change-password href="/api/space/user-management/users/{id}/change-password"/>
<enable-user href="/api/space/user-management/users/{id}/enable-user"/>
<disable-user href="/api/space/user-management/users/{id}/disable-user"/>
<capabilities href="/api/space/user-management/users/{id}/capabilities"/>
</user>
{
"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" ,
"password" : "String" ,
"password-status" : "String" ,
"password-expiry-date" : "java.sql.Timestamp" ,
"status" : "String" ,
"primary-email" : "String" ,
"domain-name" : "String" ,
"api-access-profile" : "String" ,
"roles" : {
"@total" : "Integer" ,
"@uri" : "/api/space/user-management/users/{id}/roles" ,
"role" : {
"@href" : "/api/space/user-management/roles/{roleId}"
,
"@uri" : "/api/space/user-management/users/{id}/roles/{roleId}"
,
"role-id" : "Integer" ,
"name" : "String"
}
} ,
"role-type" : "GUI_ROLE_ACCESS" ,
"auth-mode" : "String" ,
"active-user-sessions" : {
"@total" : "Integer" ,
"@uri" : "/api/space/user-management/users/{id}/active-user-sessions"
,
"active-user-session" : {
"@href" : "/api/space/user-management/active-user-sessions/{id}"
,
"@uri" : "/api/space/user-management/users/{id}/active-user-sessions/{id}"
,
"id" : "Integer" ,
"name" : "String"
}
} ,
"change-password" : {
"@href" : "/api/space/user-management/users/{id}/change-password"
} ,
"enable-user" : {
"@href" : "/api/space/user-management/users/{id}/enable-user"
} ,
"disable-user" : {
"@href" : "/api/space/user-management/users/{id}/disable-user"
} ,
"capabilities" : {
"@href" : "/api/space/user-management/users/{id}/capabilities"
}
}
}
Access Control
The following capabilities are required to access this API: ReadUser
For other non-deprecated versions of this API, refer to :
PUT /users/{id} | Version 1 |
This API is used to modify user information.
Sample Usage
PUT /users/{id}?email-password=<email-password>&generate-password=<generate-password>
- Parameters:
Name Type URI Type Description Required id Integer Path The ID of the user whose information will be modified. Y email-password Boolean Query Should the password be mailed to the user? This works only for temporary password. N generate-password Boolean Query Generate a temporary password. N
- Content-Type Headers:
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 - Accept Headers:
application/vnd.net.juniper.space.user-management.user+xml;version=1
application/vnd.net.juniper.space.user-management.user+json;version=1
<user>
<name>test_12</name>
<firstName>Test</firstName>
<lastName>Test</lastName>
<password>0Nf72o7CPMCYNY6Ks213EQ==</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" />
<roles>
<role href="/api/space/user-management/roles/65659" />
</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>
</user>
<user uri="/api/space/user-management/users/3506194">
<id>3506194</id>
<name>test_12</name>
<firstName>Test1</firstName>
<lastName>Test</lastName>
<password>ofQT2y3J5L5ujweGtHMuXg==</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>
<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>
<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>
</user>
{
"user": {
"name":"test_12",
"firstName":"Test1",
"lastName":"Test",
"password":"diJ900Bu5xYJvVGFzfNVaQ==",
"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"
},
"roles": {
"role":{
"@href":"/api/space/user-management/roles/65659"
}
},
"x509-authentication-parameters" : {
"x509-authentication-parameter" : {
"parameter-value" : "String" ,
"x509-certificate-parameter" : {
"x509-parameter-name" : "String"
}
}
}
}
}
{
"user": {
"@uri":
"/api/space/user-management/users/3506197",
 "id":3506197,
"name":"test_12",
"firstName":"Test1",
"lastName":"Test",
"password":"ofQT2y3J5L5ujweGtHMuXg==",
"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"
},
"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"
}
}
},
"x509-authentication-parameters" : {
"x509-authentication-parameter" : {
"parameter-value" : "String" ,
"x509-certificate-parameter" : {
"x509-parameter-name" : "String"
}
}
}
}
Access Control
The following capabilities are required to access this API: DefaultRead
Data Notification
This API supports data notification.
DELETE /users/{id} | Version 1 |
This API is used to delete a user specified by user ID.
DELETE action would force delete the users. Scheduled jobs could be associated to the users.
The user may execute the following query to get the list of pending/inprogress jobs and may
avoid deleting those users. These jobs can be retrieved with the following API:
/api/space/job-management/jobs?filter=(user eq 'username' and (job-state eq 'SCHEDULED' or job-state eq 'INPROGRESS' or job-state eq 'STARTING'))
.Sample Usage
DELETE /users/{id}
- Parameters:
Name Type URI Type Description Required id Integer Path User ID of the user to be removed from the database. Y
Access Control
The following capabilities are required to access this API: DeleteUser
Data Notification
This API supports data notification.