v4.0 Device Security Profiles API


TrueSight Network Automation REST API – DeviceSecurityProfileService
The base URL for the API is:

https://serverName:portNumber/bca-networks/api

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 
Enum: [
 "+name",
 "-name",
 "+realm",
 "-realm",
 "+loginUsername",
 "-loginUsername",
 "+privilegedUsername",
 "-privilegedUsername",
 "+priority",
 "-priority"
]

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...


{ 
    id: string 
    The database key of the component; an incoming component can be identified either by its database key, or by its unique name, or by its name with qualifiers which are unique when combined; when this database key is present, it takes precedence and componentName and qualifiers(when present) are used to verify the retrieved component 

     componentName: string 
    The name of the component; an incoming component can be identified either by its database key, or by its unique name, or by its name with qualifiers which are unique when combined; this name is used to verify any component retrieved by database key, and is used if there is no database key or if the database key fails to resolve; for componentType Configuration and HardwareInventory, componentName is the created timestamp (in milliseconds); for componentType SecurityVulnerability, componentName is the securityVulnerabilityID; for componentType SnmpManagerStation, componentName is the address 

     componentType: string * 
    The type of the component, used to verify what is retrieved by key/name; valid values are: Combogroup, Condition, Configuration, Device, DeviceAdapter, DeviceAgent, DeviceSecurityProfile DynamicField, EmailDistributionList, Group, HardwareInventory, JobApprovalType, Keyword, Model, OsImage, PredefinedJob, Realm, RemoteFileServer, Role, Rule, RuleSet, SecurityVulnerability, SnmpManagerStation, Template, and User 

     qualifiers: { 
      Any additional single qualifier needed to identify the component uniquely, when the name alone is not sufficient; the map key is the extra attribute name string; the map value string completes the identification of the component; for componentType Configuration and HardwareInventory: key=deviceKey, value=database key of the device the item belongs to, key=deviceName, value=name of the device the item belongs to, key=timestamp, value=creation date/time in server display format; for componentType DeviceAdapter: key=adapterType, value=type of the device adapter, key=parent, value=parent or owner used for organizing certain types of adapters, key=vendorName, value=name of the vendor that owns a device type; for componentType DynamicField: key=type, value=base class name of the component associated with the dynamic field; for componentType Group, ComboGroup: key=realmName, value=name of the realm the group belongs to; for componentType Model: key=vendorGuid, value=the vendor GUID; for componentType OsImage: key=filename, value=name of the file(s) making up the image; for componentType SecurityVulnerability: key=vendorGuid, value=the vendor GUID 
    } 
}

DeviceSecurityProfileDTO


Click here to expand...


{ 
    id: string 
    The device security profile's unique database key (read-only) 

     canCopyFlag: boolean 
    Whether or not the user is allowed to copy this device security profile (read-only) 

     canDeleteFlag: boolean 
    Whether or not the user is allowed to delete this device security profile (read-only) 

     canEditFlag: boolean 
    Whether or not the user is allowed to edit this device security profile (read-only) 

     loginUsername: string 
    Username for logging in to devices 

     loginPassword: string 
    Password for logging in to devices 

     loginPasswordEncryptedFlag: boolean 
    Whether or not the loginPassword value is encrypted; when false, loginPassword is in clear text 

     managedByTerminalServerFlag: boolean 
    Whether or not devices are accessed via a terminal server 

     name: string * 
    The device security profile's unique display name 

     priority: integer 
    Order (from 0 to 99) in which this device security profile appears among other device security profiles when auto-discovering the login credentials for a device. A DSP with a lower/smaller priority is tried before one with a higher/larger priority. DSPs with the same priority are tried in random order. A DSP with priority of 0 is skipped. 

     privilegedUsername: string 
    Privileged username for logging in to devices 

     privilegedPassword: string 
    Privileged password for logging in to devices 

     privilegedPasswordEncryptedFlag: boolean 
    Whether or not the privilegedPassword value is encrypted; when false, privilegedPassword is in clear text 

     realm: ComponentId
    Identifies the associated realm; when null, this device security profile is available to the entire network 

     realmDetailsLink: string 
    Link to get complete details about the associated realm (read-only) 

     terminalServerPassphrase: string 
   {{ Passphrase for logging into a terminal server using SSH key based authentication}}

     terminalServerPassphraseEncryptedFlag: boolean 
    Whether or not the terminalServerPassphrase value is encrypted; when false, terminalServerPassphrase is in clear text 

     terminalServerPassword: string 
    Password for logging into a terminal server 

     terminalServerPasswordEncryptedFlag: boolean 
    Whether or not the terminalServerPassword value is encrypted; when false, terminalServerPassword is in clear text 

     terminalServerType: integer 
    Identifies the type of terminal server involved, when managedByTerminalServerFlag is set to true. A value of 0 indicates a serial terminal server. A value of 1 indicates the custom connection proxy. 

     terminalServerUsername: string 
    Username for logging into a terminal server 
}

JsonPatch


Click here to expand...


[ 
    A list of JSON Patch operations 

     JsonPatch.OneOperation
  ]

JsonPatch.OneOperation

JsonPatch.Pointer


Click here to expand...


string 
  Pointer or path to an element or property

JsonPatch.Add


Click here to expand...


{ 
    op: string * 
   Enum: [
     "add"
   ]
    value: any * 
    path: JsonPatch.Pointer*
}

JsonPatch.Remove


Click here to expand...


{ 
    op: string * 
   Enum: [
     "remove"
   ]
    path: JsonPatch.Pointer*
}

JsonPatch.Replace


Click here to expand...


{ 
    op: string * 
   Enum: [
     "replace"
   ]
    value: any * 
    path: JsonPatch.Pointer*
}

JsonPatch.Move


Click here to expand...


{ 
    op: string * 
   Enum: [
     "move"
   ]
    path: JsonPatch.Pointer*
    from: JsonPatch.Pointer*
}

JsonPatch.Copy


Click here to expand...


{ 
    op: string * 
   Enum: [
     "copy"
   ]
    path: JsonPatch.Pointer*
    from: JsonPatch.Pointer*
}

JsonPatch.Test


Click here to expand...


{ 
    op: string * 
   Enum: [
     "test"
   ]
    value: any * 
    path: JsonPatch.Pointer*
}

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

TrueSight Network Automation 22.1