v4.0 Roles API
TrueSight Network Automation REST API – RoleService
The base URL for the API is:
roles
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/roles
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
filter.name | query | Filter for roles matching this name, asterisk wildcards allowed | string | |
filter.rightsManagement | query | Filter for roles whose rights you can manage in the specified context; a value of "copyable" selects roles whose rights you can copy from; a value of "editable" selects roles whose rights you are allowed to edit (which does not include any role with full network rights); when null, no such filtering occurs | string | |
orderBy | query | Sort by the specified attribute (name, associatedUsernames, or a listable dynamic field name) in the specified order (prefix with a '+' for ascending or a '-' for descending) | "+name" | string |
offset | query | Return the specified page number | 1 | integer |
limit | query | Define the number of rows in a page or the maximum number of roles to return | 25 | integer |
Authorization | header | Authorization token formatted as 'Bearer [token]' | String * |
Responses
Code | Description | Schema |
---|---|---|
200 | successful operation | [ |
401 | Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
403 | Forbidden: Not allowed to access roles | |
500 | Internal server error: Unexpected exception occurred |
{{status subtle="false" colour="Green" title="POST"/}}
/v4.0/roles
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
body | body | Complete attributes of the new role | ||
Authorization | header | Authorization token formatted as 'Bearer [token]' | string * |
Responses
Code | Description | Schema |
---|---|---|
201 | Created: New role successfully added | |
400 | Bad request: Input role DTO is missing or new role is invalid | |
401 | Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
403 | Forbidden: Not allowed to add a new role or not allowed to grant the new right(s) | |
500 | Internal server error: Unexpected exception occurred |
{{status subtle="false" colour="Green" title="POST"/}}
/v4.0/roles/changes_to_rights
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
body | body | Changes to be made in the selected roles | ||
Authorization | header | Authorization token formatted as 'Bearer [token]' | string * |
Responses
Code | Description | Schema |
---|---|---|
200 | OK: Roles updated successfully | |
400 | Bad request: Input DTO is missing or invalid or modified role is invalid | |
401 | Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
403 | Forbidden: Not allowed to modify roles or not allowed to grant or revoke a particular right | |
500 | Internal server error: Unexpected exception occurred |
{{status subtle="false" colour="Green" title="POST"/}}
/v4.0/roles/replication_of_rights
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
body | body | How rights are to be replicated from one role to another | ||
Authorization | header | Authorization token formatted as 'Bearer [token]' | string * |
Responses
Code | Description | Schema |
---|---|---|
200 | OK: Role updated successfully | |
400 | Bad request: Input DTO is missing or invalid | |
401 | Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
403 | Forbidden: Not allowed to modify role or not allowed to grant or revoke a particular right | |
500 | Internal server error: Unexpected exception occurred |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/roles/{nameOrKey}
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
nameOrKey | path | Name or database key of the role of interest | string * | |
Authorization | header | Authorization token formatted as 'Bearer [token]' | String * |
Responses
Code | Description | Schema |
---|---|---|
200 | successful operation | |
401 | Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
403 | Forbidden: Not allowed to access roles | |
404 | Not found: No single matching accessible role found | |
500 | Internal server error: Unexpected exception occurred |
{{status subtle="false" colour="Yellow" title="PUT"/}}
/v4.0/roles/{nameOrKey}
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
nameOrKey | path | Name or database key of the role to be modified | string * | |
body | body | Complete new attribute values for the role; anything left out will be considered to be null and will be nulled out in the role | ||
Authorization | header | Authorization token formatted as 'Bearer [token]' | string * |
Responses
Code | Description | Schema |
---|---|---|
200 | successful operation | |
400 | Bad request: Input role DTO is missing or modified role is invalid | |
401 | Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
403 | Forbidden: Not allowed to modify the role or not allowed to grant/revoke rights in the requested way | |
404 | Not found: No single matching accessible role found | |
500 | Internal server error: Unexpected exception occurred |
{{status subtle="false" colour="Red" title="DELETE"/}}
/v4.0/roles/{nameOrKey}
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
nameOrKey | path | Name or database key of the role to be deleted | string * | |
Authorization | header | Authorization token formatted as 'Bearer [token]' | string * |
Responses
Code | Description | Schema |
---|---|---|
200 | successful operation | string |
400 | Bad request: Role is currently in use by a user, a job approval type, or a system parameter; or role is the root role that cannot be deleted | |
401 | Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
403 | Forbidden: Not allowed to delete the role | |
404 | Not found: No single matching accessible role found | |
500 | Internal server error: Unexpected exception occurred |
{{status subtle="false" colour="Yellow" title="PATCH"/}}
/v4.0/roles/{nameOrKey}
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
nameOrKey | path | Name or database key of the role to be modified | string * | |
body | body | New attribute values for the role, in JSON Patch format | ||
Authorization | header | Authorization token formatted as 'Bearer [token]' | string * |
Responses
Code | Description | Schema |
---|---|---|
200 | successful operation | |
400 | Bad request: Input JSON patch information is missing or modified role is invalid | |
401 | Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
403 | Forbidden: Not allowed to modify the role or not allowed to grant/revoke rights in the requested way | |
404 | Not found: No single matching accessible role found | |
500 | Internal server error: Unexpected exception occurred |
Object Definitions
Object | Schema |
---|---|
ComponentId | Click here to expand...{ |
DynamicFieldValueDTO | Click here to expand...{ |
JsonPatch | Click here to expand...[ |
JsonPatch.OneOperation | Click here to expand... |
JsonPatch.Pointer | Click here to expand...string |
JsonPatch.Add | Click here to expand...{ |
JsonPatch.Remove | Click here to expand...{ |
JsonPatch.Replace | Click here to expand...{ |
JsonPatch.Move | Click here to expand...{ |
JsonPatch.Copy | Click here to expand...{ |
JsonPatch.Test | Click here to expand...{ |
NetworkRightsDTO | Click here to expand...{ |
RoleDTO | Click here to expand...{ |
RoleRightsChangesDTO | Click here to expand...{ |
RoleRightsReplicationDTO | Click here to expand...{ |