v4.0 Device Security Profiles API
TrueSight Network Automation REST API – DeviceSecurityProfileService
The base URL for the API is:
device_security_profiles
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/device_security_profiles
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
query | Filter for device security profiles matching this name, asterisk wildcards allowed | string | ||
filter.realm | query | Filter for device security profiles that belong to this realm, either by exact name or by database key; device security profiles associated with the entire network belong to every realm | string | |
orderBy | query | Sort by the specified attribute (name, loginUsername, privilegedUsername, realm, or priority) 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 device security profiles 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 device security profiles | |
500 | Internal server error: Unexpected exception occurred |
{{status subtle="false" colour="Green" title="POST"/}}
/v4.0/device_security_profiles
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
body | body | Complete attributes of the new device security profile | ||
Authorization | header | Authorization token formatted as 'Bearer [token]' | string * |
Responses
Code | Description | Schema |
---|---|---|
201 | Created: New device security profile successfully added | |
400 | Bad request: Input device security profile DTO is missing or new device security profile 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 device security profile | |
500 | Internal server error: Unexpected exception occurred |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/device_security_profiles/{nameOrKey}
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
nameOrKey | path | Name or database key of the device security profile 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 device security profiles | |
404 | Not found: No single matching accessible device security profile found | |
500 | Internal server error: Unexpected exception occurred |
{{status subtle="false" colour="Yellow" title="PUT"/}}
/v4.0/device_security_profiles/{nameOrKey}
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
nameOrKey | path | Name or database key of the device security profile to be modified | string * | |
body | body | Complete new attribute values for the device security profile; anything left out will be considered to be null and will be nulled out in the device security profile | ||
Authorization | header | Authorization token formatted as 'Bearer [token]' | string * |
Responses
Code | Description | Schema |
---|---|---|
200 | successful operation | |
400 | Bad request: Input device security profile DTO is missing or modified device security profile 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 device security profile | |
404 | Not found: No single matching accessible device security profile found | |
500 | Internal server error: Unexpected exception occurred |
{{status subtle="false" colour="Red" title="DELETE"/}}
/v4.0/device_security_profiles/{nameOrKey}
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
nameOrKey | path | Name or database key of the device security profile to be deleted | string * | |
Authorization | header | Authorization token formatted as 'Bearer [token]' | string * |
Responses
Code | Description | Schema |
---|---|---|
200 | successful operation | string |
400 | Bad request: Device security profile is currently in use | |
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 device security profile | |
404 | Not found: No single matching accessible device security profile found | |
500 | Internal server error: Unexpected exception occurred |
{{status subtle="false" colour="Yellow" title="PATCH"/}}
/v4.0/device_security_profiles/{nameOrKey}
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
nameOrKey | path | Name or database key of the device security profile to be modified | string * | |
body | body | New attribute values for the device security profile, 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 device security profile 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 device security profile | |
404 | Not found: No single matching accessible device security profile found | |
500 | Internal server error: Unexpected exception occurred |
Object Definitions
Object | Schema |
---|---|
ComponentId | Click here to expand...{ |
DeviceSecurityProfileDTO | 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...{ |