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
The following operations are supported on this resource:
GET /users | Version 3 |
Get All Users.
Sample Usage
GET /users
- Accept Headers:
application/vnd.net.juniper.space.user-management.users+xml;version=3
application/vnd.net.juniper.space.user-management.users+json;version=3
<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>
{
"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: ReadUser, CreateDomain, ModifyDomain
For other non-deprecated versions of this API, refer to :
POST /users | Version 1 |
Create a new user in Junos Space.
Sample Usage
POST /users?email-password=<email-password>&generate-password=<generate-password>
- Parameters:
Name Type URI Type Description Required 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</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/65601" />
<role href="/api/space/user-management/roles/65603" />
</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>test12</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/65658"
href="/api/space/user-management/roles/65658">
<id>65658</id>
<name>jobsAdmin</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/196637/change-password" rel="change-password"
/>
</user>
{
"user":{
"name":"testUser",
"firstName":"testFirstName",
"lastName":"testLastName",
"password":"test@123",
"viewAllObjects":"true",
"primaryEmail":"test@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/65601"
},
{
"@href":"/api/space/user-management/roles/65603"
}
]
},
"x509-authentication-parameters" : {
"x509-authentication-parameter" : {
"parameter-value" : "String" ,
"x509-certificate-parameter" : {
"x509-parameter-name" : "String"
}
}
}
}
}
{
"user":{
"@uri":
"/api/space/user-management/users/196651",
"id":196651,
"name":"testuser",
"firstName":"testFirstName",
"lastName":"testLastName",
"password":
"zrbJcGWPMVBKkBuJ3NPkYQ==",
"primaryEmail":"test@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": {
"@url":"/api/space/user-management/users/196651/roles",
"role": [
{
"@url":
"/api/space/user-management/users/196651/roles/65655",
"@href":"/api/space/user-management/roles/65655",
"id":65655,
"name":"userAdmin"
},
{
"@url":
"/api/space/user-management/users/196651/roles/65656",
"@href":"/api/space/user-management/roles/65656",
"id":65656,
"name":"tagsAdmin"
}
]
},
"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: CreateUser
Data Notification
This API supports data notification.
PATCH /users | Version 1 |
Multiple deletes to the users collection.
Sample Usage
PATCH /users
- Content-Type Headers:
application/vnd.net.juniper.space.user-management.users_patch+xml;version=1;charset=UTF-8
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<diff>
<!--What you see below are just samples of patch operations that may be performed on this DTO.-->
<!--For more information about patch document format please look at http://http://www.rfc-editor.org/rfc/rfc5261.txt-->
<add sel="users">
<user>
<name>test</name>
<firstName>Test</firstName>
<lastName>Test</lastName>
<password>123admin</password>
<primaryEmail>super@juniper.net</primaryEmail>
<auto-logout-time>5</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/65601" />
<role href="/api/space/user-management/roles/65603" />
</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>
</add>
<!-- or -->
<remove sel="users/user[@some attribute='some value']"/>
<!-- or using element selection-->
<remove sel="users/user[some element='some value']"/>
</diff>
Access Control
The following capabilities are required to access this API: DeleteUser