RoleManagementService
The following resources are part of this group:
- /roleManagementService/allRoles
- /roleManagementService/assignRole
- /roleManagementService/assignRoleByName
- /roleManagementService/assignTemplatedRole
- /roleManagementService/createTemplatedRole
- /roleManagementService/detailledAllRoles
- /roleManagementService/removeTemplatedRole
- /roleManagementService/roleExists
- /roleManagementService/templatedRoleExists
- /roleManagementService/unassignRole
- /roleManagementService/unassignRoleByName
- /roleManagementService/updateRole
- /roleManagementService/updateRoleDescription
- /roleManagementService/updateRoleUsers
- /roleManagementService/updateUserRoles
- /roleManagementService/verifyTemplatedRole
- /roleManagementService/getApplicationRoles/{username}
- /roleManagementService/getApplications/{username}
- /roleManagementService/getEffectivelyAssignedRoles/{username}
- /roleManagementService/getRole/{roleName}
/roleManagementService/allRoles
Mount Point: /redbackServices/roleManagementService/allRoles
Available Since: 2.0
GET
Available Since: 2.0
Response Body
| element: | (custom) |
| media types: | application/xml text/plain application/json |
(no documentation provided)
/roleManagementService/assignRole
Mount Point: /redbackServices/roleManagementService/assignRole
GET
Assigns the role indicated by the roleId to the given principal
Parameters
| name | description | type | default |
|---|---|---|---|
| roleId | (no documentation provided) | query | |
| principal | (no documentation provided) | query |
Response Body
| element: | (custom) |
| media types: | application/xml text/plain application/json |
(no documentation provided)
/roleManagementService/assignRoleByName
Mount Point: /redbackServices/roleManagementService/assignRoleByName
GET
Assigns the role indicated by the roleName to the given principal
Parameters
| name | description | type | default |
|---|---|---|---|
| roleName | (no documentation provided) | query | |
| principal | (no documentation provided) | query |
Response Body
| element: | (custom) |
| media types: | application/xml text/plain application/json |
(no documentation provided)
/roleManagementService/assignTemplatedRole
Mount Point: /redbackServices/roleManagementService/assignTemplatedRole
GET
Assigns the templated role indicated by the templateId
fails if the templated role has not been createdParameters
| name | description | type | default |
|---|---|---|---|
| templateId | (no documentation provided) | query | |
| resource | (no documentation provided) | query | |
| principal | (no documentation provided) | query |
Response Body
| element: | (custom) |
| media types: | application/xml text/plain application/json |
(no documentation provided)
/roleManagementService/createTemplatedRole
Mount Point: /redbackServices/roleManagementService/createTemplatedRole
GET
Parameters
| name | description | type | default |
|---|---|---|---|
| templateId | (no documentation provided) | query | |
| resource | (no documentation provided) | query |
Response Body
| element: | (custom) |
| media types: | application/xml text/plain application/json |
(no documentation provided)
/roleManagementService/detailledAllRoles
Mount Point: /redbackServices/roleManagementService/detailledAllRoles
Available Since: 2.0
GET
Available Since: 2.0
Response Body
| element: | (custom) |
| media types: | application/xml text/plain application/json |
(no documentation provided)
/roleManagementService/removeTemplatedRole
Mount Point: /redbackServices/roleManagementService/removeTemplatedRole
GET
removes a role corresponding to the role Id that was manufactured with the given resource
it also removes any user assignments for that roleParameters
| name | description | type | default |
|---|---|---|---|
| templateId | (no documentation provided) | query | |
| resource | (no documentation provided) | query |
Response Body
| element: | (custom) |
| media types: | application/xml text/plain application/json |
(no documentation provided)
/roleManagementService/roleExists
Mount Point: /redbackServices/roleManagementService/roleExists
GET
true of a role exists with the given roleId
Parameters
| name | description | type | default |
|---|---|---|---|
| roleId | (no documentation provided) | query |
Response Body
| element: | (custom) |
| media types: | application/xml text/plain application/json |
(no documentation provided)
/roleManagementService/templatedRoleExists
Mount Point: /redbackServices/roleManagementService/templatedRoleExists
GET
true of a role exists with the given roleId
Parameters
| name | description | type | default |
|---|---|---|---|
| templateId | (no documentation provided) | query | |
| resource | (no documentation provided) | query |
Response Body
| element: | (custom) |
| media types: | application/xml text/plain application/json |
(no documentation provided)
/roleManagementService/unassignRole
Mount Point: /redbackServices/roleManagementService/unassignRole
GET
Unassigns the role indicated by the role id from the given principal
Parameters
| name | description | type | default |
|---|---|---|---|
| roleId | (no documentation provided) | query | |
| principal | (no documentation provided) | query |
Response Body
| element: | (custom) |
| media types: | application/xml text/plain application/json |
(no documentation provided)
/roleManagementService/unassignRoleByName
Mount Point: /redbackServices/roleManagementService/unassignRoleByName
GET
Unassigns the role indicated by the role name from the given principal
Parameters
| name | description | type | default |
|---|---|---|---|
| roleName | (no documentation provided) | query | |
| principal | (no documentation provided) | query |
Response Body
| element: | (custom) |
| media types: | application/xml text/plain application/json |
(no documentation provided)
/roleManagementService/updateRole
Mount Point: /redbackServices/roleManagementService/updateRole
GET
allows for a role coming from a template to be renamed effectively swapping out the bits of it that were labeled with the oldResource with the newResource
it also manages any user assignments for that roleParameters
| name | description | type | default |
|---|---|---|---|
| templateId | (no documentation provided) | query | |
| oldResource | (no documentation provided) | query | |
| newResource | (no documentation provided) | query |
Response Body
| element: | (custom) |
| media types: | application/xml text/plain application/json |
(no documentation provided)
/roleManagementService/updateRoleDescription
Mount Point: /redbackServices/roleManagementService/updateRoleDescription
Available Since: 2.0
GET
Available Since: 2.0
Parameters
| name | description | type | default |
|---|---|---|---|
| roleName | (no documentation provided) | query | |
| roleDescription | (no documentation provided) | query |
Response Body
| element: | (custom) |
| media types: | application/xml text/plain application/json |
(no documentation provided)
/roleManagementService/updateRoleUsers
Mount Point: /redbackServices/roleManagementService/updateRoleUsers
Available Since: 2.0
POST
Available Since: 2.0
update users assigned to a role
Request Body
| element: | role |
| media types: | application/xml application/json |
(no documentation provided)
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
(no documentation provided)
/roleManagementService/updateUserRoles
Mount Point: /redbackServices/roleManagementService/updateUserRoles
Available Since: 2.0
POST
Available Since: 2.0
update roles assigned to a user
Request Body
| element: | user |
| media types: | application/xml application/json |
(no documentation provided)
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
(no documentation provided)
/roleManagementService/verifyTemplatedRole
Mount Point: /redbackServices/roleManagementService/verifyTemplatedRole
GET
Check a role template is complete in the RBAC store.
Parameters
| name | description | type | default |
|---|---|---|---|
| templateId | the templated role | query | |
| resource | the resource to verify | query |
Response Body
| element: | (custom) |
| media types: | application/xml text/plain application/json |
(no documentation provided)
/roleManagementService/getApplicationRoles/{username}
Mount Point: /redbackServices/roleManagementService/getApplicationRoles/{username}
Available Since: 2.0
GET
Available Since: 2.0
Parameters
| name | description | type | default |
|---|---|---|---|
| username | (no documentation provided) | path |
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
(no documentation provided)
/roleManagementService/getApplications/{username}
Mount Point: /redbackServices/roleManagementService/getApplications/{username}
Available Since: 2.0
GET
Available Since: 2.0
Parameters
| name | description | type | default |
|---|---|---|---|
| username | (no documentation provided) | path |
Response Body
| element: | (custom) |
| media types: | application/xml text/plain application/json |
(no documentation provided)
/roleManagementService/getEffectivelyAssignedRoles/{username}
Mount Point: /redbackServices/roleManagementService/getEffectivelyAssignedRoles/{username}
Available Since: 1.4
GET
Available Since: 1.4
Parameters
| name | description | type | default |
|---|---|---|---|
| username | (no documentation provided) | path |
Response Body
| element: | (custom) |
| media types: | application/xml text/plain application/json |
(no documentation provided)
/roleManagementService/getRole/{roleName}
Mount Point: /redbackServices/roleManagementService/getRole/{roleName}
Available Since: 2.0
GET
Available Since: 2.0
Parameters
| name | description | type | default |
|---|---|---|---|
| roleName | (no documentation provided) | path |
Response Body
| element: | role |
| media types: | application/xml text/plain application/json |
(no documentation provided)