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
The following operations are supported on this resource:
GET /roles | Version 3 |
Get all RBAC roles.
Sample Usage
GET /roles
- Accept Headers:
application/vnd.net.juniper.space.user-management.roles+xml;version=3
application/vnd.net.juniper.space.user-management.roles+json;version=3
<roles total="Integer" uri="/api/space/user-management/roles">
<role href="/api/space/user-management/roles/{roleId}" uri="/api/space/user-management/roles/{roleId}">
<id>Integer</id>
<description>String</description>
<name>String</name>
<title>String</title>
<predefined>Boolean</predefined>
<less-tasks>String</less-tasks>
</role>
</roles>
{
"roles" : {
"@total" : "Integer" ,
"@uri" : "/api/space/user-management/roles" ,
"role" : {
"@href" : "/api/space/user-management/roles/{roleId}" ,
"@uri" : "/api/space/user-management/roles/{roleId}" ,
"id" : "Integer" ,
"description" : "String" ,
"name" : "String" ,
"title" : "String" ,
"predefined" : "Boolean" ,
"less-tasks" : "String"
}
}
}
Access Control
The following capabilities are required to access this API: DefaultRead
POST /roles | Version 3 |
Add an RBAC role with capabilities associated with it.
Sample Usage
POST /roles
- 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: CreateRole, CloneRole
POST /roles | Version 3 |
This API is used to export the roles.
Sample Usage
This API makes an asynchronous method call; so, you can optionally specify queue and schedule parameters:
POST /roles?queue=<queue>&schedule=<schedule>
Note: The queue URL denoted by <queue> must have been created already.
- Parameters:
Name Type URI Type Description Required queue Queue URL Query A fully qualified queue URL, where job progress notifications will be sent (See Asynchronous API Usage) N schedule cron-like-expression Query Schedule this API in the future, by specifying a cron-like-expression (See Job Scheduling) N
- Content-Type Headers:
application/vnd.net.juniper.space.user-management.export-roles-request+xml;version=3;charset=UTF-8
application/vnd.net.juniper.space.user-management.export-roles-request+json;version=3;charset=UTF-8 - Accept Headers:
application/vnd.net.juniper.space.job-management.task+xml;version=1
application/vnd.net.juniper.space.job-management.task+json;version=1
<export-roles-request>
<roles>
<role href="/api/space/user-management/roles/{roleId}"/>
</roles>
</export-roles-request>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<task href="/api/space/job-management/jobs/786496" >
<id>786496</id>
</task>
{
"export-roles-request" : {
"roles" : {
"role" : {
"@href" : "/api/space/user-management/roles/{roleId}"
}
}
}
}
{
task: {
"@href"="/api/space/job-management/jobs/786496",
id: 786496
}
}
Access Control
The following capabilities are required to access this API: ExportRole
POST /roles | Version 3 |
This API is used to import the roles.
Sample Usage
This API makes an asynchronous method call; so, you can optionally specify queue and schedule parameters:
POST /roles?queue=<queue>&schedule=<schedule>
Note: The queue URL denoted by <queue> must have been created already.
- Parameters:
Name Type URI Type Description Required queue Queue URL Query A fully qualified queue URL, where job progress notifications will be sent (See Asynchronous API Usage) N schedule cron-like-expression Query Schedule this API in the future, by specifying a cron-like-expression (See Job Scheduling) N
- Content-Type Headers:
application/vnd.net.juniper.space.user-management.import-roles-request+xml;version=3;charset=UTF-8
application/vnd.net.juniper.space.user-management.import-roles-request+json;version=3;charset=UTF-8 - Accept Headers:
application/vnd.net.juniper.space.job-management.task+xml;version=1
application/vnd.net.juniper.space.job-management.task+json;version=1
<import-roles-request>
<roles>
<role>
<title>String</title>
<description>String</description>
<capabilities total="Integer">
<capability>
<id>Integer</id>
<name>String</name>
</capability>
</capabilities>
<lessTasks>String</lessTasks>
</role>
</roles>
</import-roles-request>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<task href="/api/space/job-management/jobs/786496" >
<id>786496</id>
</task>
{
"import-roles-request" : {
"roles" : {
"role" : {
"title" : "String" ,
"description" : "String" ,
"capabilities" : {
"@total" : "Integer" ,
"capability" : {
"id" : "Integer" ,
"name" : "String"
}
} ,
"lessTasks" : "String"
}
}
}
}
{
task: {
"@href"="/api/space/job-management/jobs/786496",
id: 786496
}
}
Access Control
The following capabilities are required to access this API: ImportRole
PATCH /roles | Version 3 |
Multiple adds/deletes to the roles collection.
Sample Usage
PATCH /roles
- Content-Type Headers:
application/vnd.net.juniper.space.user-management.roles_patch+xml;version=3;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="roles"/>
<!-- or -->
<remove sel="roles/role[@some attribute='some value']"/>
<!-- or using element selection-->
<remove sel="roles/role[some element='some value']"/>
</diff>
Access Control
The following capabilities are required to access this API: CreateRole, ModifyRole, DeleteRole