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/roles/{id}
The following operations are supported on this resource:
| GET /roles/{id} | Version 3 |
Get an RBAC role.
Sample Usage
GET /roles/{id}
- Parameters:
Name Type URI Type Description Required id Integer Path ID Y
- Accept Headers:
application/vnd.net.juniper.space.user-management.role+xml;version=3
application/vnd.net.juniper.space.user-management.role+json;version=3
<role href="/api/space/user-management/roles/{roleId}" uri="/api/space/user-management/roles/{id}">
<id>Integer</id>
<name>String</name>
<title>String</title>
<description>String</description>
<predefined>Boolean</predefined>
<sharable>Boolean</sharable>
<less-tasks>String</less-tasks>
<capabilities uri="/api/space/user-management/roles/{id}/capabilities">
<capability
href="/api/space/user-management/capabilities/{capId}"
uri="/api/space/user-management/roles/{id}/capabilities/{capId}">
<id>Integer</id>
<name>String</name>
<title>String</title>
</capability>
</capabilities>
<tasks href="/api/space/user-management/roles/{roleId}/tasks"/>
</role>{
"role" : {
"@href" : "/api/space/user-management/roles/{roleId}" ,
"@uri" : "/api/space/user-management/roles/{id}" ,
"id" : "Integer" ,
"name" : "String" ,
"title" : "String" ,
"description" : "String" ,
"predefined" : "Boolean" ,
"sharable" : "Boolean" ,
"less-tasks" : "String" ,
"capabilities" : {
"@uri" : "/api/space/user-management/roles/{id}/capabilities" ,
"capability" : {
"@href" : "/api/space/user-management/capabilities/{capId}"
,
"@uri" : "/api/space/user-management/roles/{id}/capabilities/{capId}"
,
"id" : "Integer" ,
"name" : "String" ,
"title" : "String"
}
} ,
"tasks" : {
"@href" : "/api/space/user-management/roles/{roleId}/tasks"
}
}
}Access Control
The following capabilities are required to access this API: ReadRole
For the deprecated versions of this API, refer to :
version 1
| PUT /roles/{id} | Version 3 |
Update/Replace a Role.
Sample Usage
PUT /roles/{id}
- Parameters:
Name Type URI Type Description Required id Integer Path ID Y
- Content-Type Headers:
application/vnd.net.juniper.space.user-management.role+xml;version=3;charset=UTF-8
application/vnd.net.juniper.space.user-management.role+json;version=3;charset=UTF-8 - Accept Headers:
application/vnd.net.juniper.space.user-management.role+xml;version=3
application/vnd.net.juniper.space.user-management.role+json;version=3
<role>
<title>String</title>
<description>String</description>
<less-tasks>String</less-tasks>
<capabilities>
<capability href="/api/space/user-management/capabilities/{capId}"/>
</capabilities>
</role><role href="/api/space/user-management/roles/{roleId}" uri="/api/space/user-management/roles/{id}">
<id>Integer</id>
<name>String</name>
<title>String</title>
<description>String</description>
<predefined>Boolean</predefined>
<sharable>Boolean</sharable>
<less-tasks>String</less-tasks>
<capabilities uri="/api/space/user-management/roles/{id}/capabilities">
<capability
href="/api/space/user-management/capabilities/{capId}"
uri="/api/space/user-management/roles/{id}/capabilities/{capId}">
<id>Integer</id>
<name>String</name>
<title>String</title>
</capability>
</capabilities>
</role>{
"role" : {
"title" : "String" ,
"description" : "String" ,
"less-tasks" : "String" ,
"capabilities" : {
"capability" : {
"@href" : "/api/space/user-management/capabilities/{capId}"
}
}
}
}{
"role" : {
"@href" : "/api/space/user-management/roles/{roleId}" ,
"@uri" : "/api/space/user-management/roles/{id}" ,
"id" : "Integer" ,
"name" : "String" ,
"title" : "String" ,
"description" : "String" ,
"predefined" : "Boolean" ,
"sharable" : "Boolean" ,
"less-tasks" : "String" ,
"capabilities" : {
"@uri" : "/api/space/user-management/roles/{id}/capabilities" ,
"capability" : {
"@href" : "/api/space/user-management/capabilities/{capId}"
,
"@uri" : "/api/space/user-management/roles/{id}/capabilities/{capId}"
,
"id" : "Integer" ,
"name" : "String" ,
"title" : "String"
}
}
}
}Access Control
The following capabilities are required to access this API: ModifyRole
| PATCH /roles/{id} | Version 3 |
Partial updates to a role.
Sample Usage
PATCH /roles/{id}
- Parameters:
Name Type URI Type Description Required id Integer Path ID Y
- Content-Type Headers:
application/vnd.net.juniper.space.user-management.role_patch+xml;version=3;charset=UTF-8 - Accept Headers:
application/vnd.net.juniper.space.user-management.role+xml;version=3
<?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-->
<replace sel="role/title">
<title>String</title>
</replace>
<replace sel="role/description">
<description>String</description>
</replace>
<replace sel="role/less-tasks">
<less-tasks>String</less-tasks>
</replace>
<replace sel="role/capabilities">
<capabilities>
<capability href="/api/space/user-management/capabilities/{capId}"/>
</capabilities>
</replace>
</diff><role href="/api/space/user-management/roles/{roleId}" uri="/api/space/user-management/roles/{id}">
<id>Integer</id>
<name>String</name>
<title>String</title>
<description>String</description>
<predefined>Boolean</predefined>
<sharable>Boolean</sharable>
<less-tasks>String</less-tasks>
<capabilities uri="/api/space/user-management/roles/{id}/capabilities">
<capability
href="/api/space/user-management/capabilities/{capId}"
uri="/api/space/user-management/roles/{id}/capabilities/{capId}">
<id>Integer</id>
<name>String</name>
<title>String</title>
</capability>
</capabilities>
<tasks href="/api/space/user-management/roles/{roleId}/tasks"/>
</role>{
"role" : {
"@href" : "/api/space/user-management/roles/{roleId}" ,
"@uri" : "/api/space/user-management/roles/{id}" ,
"id" : "Integer" ,
"name" : "String" ,
"title" : "String" ,
"description" : "String" ,
"predefined" : "Boolean" ,
"sharable" : "Boolean" ,
"less-tasks" : "String" ,
"capabilities" : {
"@uri" : "/api/space/user-management/roles/{id}/capabilities" ,
"capability" : {
"@href" : "/api/space/user-management/capabilities/{capId}"
,
"@uri" : "/api/space/user-management/roles/{id}/capabilities/{capId}"
,
"id" : "Integer" ,
"name" : "String" ,
"title" : "String"
}
} ,
"tasks" : {
"@href" : "/api/space/user-management/roles/{roleId}/tasks"
}
}
}Access Control
The following capabilities are required to access this API: ModifyRole
| DELETE /roles/{id} | Version 3 |
Delete a role.
Sample Usage
DELETE /roles/{id}
- Parameters:
Name Type URI Type Description Required id Integer Path ID Y
Access Control
The following capabilities are required to access this API: DeleteRole