User Group Roles
Quick Navigation
- GET UserGroups/{userGroupId}/SmartRules/{smartRuleId}/Roles
- POST UserGroups/{userGroupId}/SmartRules/{smartRuleId}/Roles
- DELETE UserGroups/{userGroupId}/SmartRules/{smartRuleId}/Roles
GET UserGroups/{userGroupId}/SmartRules/{smartRuleId}/Roles
Purpose
Returns a list of roles for the user group and Smart Rule referenced by ID.
Required Permissions
- User Accounts Management (Read)
- Password Safe Role Management (Read).
URL Parameters
- userGroupId: ID of the user group.
- smartRuleId: ID of the Smart Rule.
Request Body
None.
Response Body
Content-Type: application/json
[ { RoleID : int, Name : string }, … ]
Response Codes
200 – Request successful. Roles in the response body.
For more information, please see Common Response Codes.
POST UserGroups/{userGroupId}/SmartRules/{smartRuleId}/Roles
Purpose
Sets Password Safe roles for the user group and Smart Rule referenced by ID.
Required Permissions
- User Accounts Management (Read/Write).
- Password Safe Role Management (Read/Write).
URL Parameters
- userGroupId: ID of the user group.
- smartRuleId: ID of the Smart Rule.
Request Body
Content-Type: application/json
{ Roles : [ { RoleID : int }, … ], AccessPolicyID : int }
Request Body Details
- Roles: (required) Zero or more roles to set on the UserGroup-SmartRule.
- AccessPolicyID: The access policy ID to set on the UserGroup-SmartRule. Required when the Requestor or Requestor/Approver role is set.
Response Body
None.
Response Codes
204 – Request successful. No content in body.
For more information, please see Common Response Codes.
DELETE UserGroups/{userGroupId}/SmartRules/{smartRuleId}/Roles
Purpose
Deletes all Password Safe roles for the user group and Smart Rule referenced by ID.
Required Permissions
- User Accounts Management (Read/Write).
- Password SafeRole Management (Read/Write).
URL Parameters
- userGroupId: ID of the user group.
- smartRuleId: ID of the Smart Rule.
Request Body
None.
Response Body
None.
Response Codes
200 – Request successful.
For more information, please see Common Response Codes.