Attributes

Quick Navigation

GET ManagedAccounts/{managedAccountID}/Attributes

Purpose

Returns a list of attributes by managed account ID.

Required Permissions

Password Safe Account Management (Read), Attribute Management (Read).

URL Parameters

managedAccountID: ID of the managed account.

Request Body

None.

Response Body

Content-Type: application/json

[
    {
        AttributeID : int,
        AttributeTypeID : int,
        ParentAttributeID : int, // can be null 
        ShortName : string,
        LongName : string, 
        Description : string, ValueInt : int, // can be null 
        IsReadOnly: bool
    },
    …
]

Response Codes

201 - Request successful. Attributes associated with the asset in the response body.

For more information, please see Common Response Codes.

GET ManagedSystems/{managedSystemID}/Attributes

Purpose

Returns a list of attributes by managed system ID.

Required Permissions

Password Safe System Management (Read), Attribute Management (Read).

URL Parameters

managedSystemID: ID of the managed system.

Request Body

None.

Response Body

Content-Type: application/json

[
    {
        AttributeID : int,
        AttributeTypeID : int,
        ParentAttributeID : int, // can be null
        ShortName : string,
        LongName : string,
        Description : string,
        ValueInt : int, // can be null
        IsReadOnly: bool
    },
…
]

Response Codes

200 - Request successful. Attributes associated with the Managed System in the response body.

For more information, please see Common Response Codes.

POST ManagedAccounts/{managedAccountID}/Attributes/{attributeID}

Purpose

Assigns an attribute to a managed account.

Required Permissions

Password Safe Account Management (Read/Write), Attribute Management (Read/Write).

URL Parameters

  • managedAccountID: ID of the managed account.
  • attributeID: ID of the attribute.

Request Body

None.

Response Body

Content-Type: application/json

[
    {
        AttributeID : int,
        AttributeTypeID : int,
        ParentAttributeID : int, // can be null 
        ShortName : string,
        LongName : string, 
        Description : string, ValueInt : int, // can be null 
        IsReadOnly: bool
    },
    …
]

Response Codes

201 - Request successful. Attribute in the response body.

For more information, please see Common Response Codes.

POST ManagedSystems/{managedSystemID}/Attributes/{attributeID}

Purpose

Assigns an attribute to a managed system.

Required Permissions

Password Safe System Management (Read/Write), Attribute Management (Read/Write).

URL Parameters

managedSystemID: ID of the managed system.

attributeID: ID of the attribute.

Request Body

None.

Response Body

Content-Type: application/json

[
    {
        AttributeID : int,
        AttributeTypeID : int,
        ParentAttributeID : int, // can be null
        ShortName : string,
        LongName : string,
        Description : string,
        ValueInt : int, // can be null
        IsReadOnly: bool
    },
    …
]

Response Codes

201 - Request successful. Attribute in the response body.

For more information, please see Common Response Codes.

DELETE ManagedAccounts/{managedAccountID}/Attributes

Purpose

Deletes all managed account attributes by managed account ID.

Required Permissions

Password Safe Account Management (Read/Write), Attribute Management (Read/Write).

URL Parameters

managedAccountID: ID of the managed account.

Request Body

None.

Response Body

None.

Response Codes

200 - Request successful.

For more information, please see Common Response Codes.

DELETE ManagedAccounts/{managedAccountID}/Attributes/{attributeID}

Purpose

Deletes a managed account attribute by managed account ID and attribute ID.

Required Permissions

Password Safe Account Management (Read/Write), Attribute Management (Read/Write).

URL Parameters

  • managedAccountID: ID of the managed account.
  • attributeID: ID of the attribute.

Request Body

None.

Response Body

None.

Response Codes

200 - Request successful.

For more information, please see Common Response Codes.

DELETE ManagedSystems/{managedSystemID}/Attributes

Purpose

Deletes all managed system attributes by managed system ID.

Required Permissions

Password Safe System Management (Read/Write), Attribute Management (Read/Write).

URL Parameters

managedSystemID: ID of the managed system.

Request Body

None.

Response Body

None.

Response Codes

200 - Request successful.

For more information, please see Common Response Codes.

DELETE ManagedSystems/{managedSystemID}/Attributes/{attributeID}

Purpose

Deletes a managed system attribute by managed system ID and attribute ID.

Required Permissions

Password Safe System Management (Read/Write), Attribute Management (Read/Write).

URL Parameters

managedSystemID: ID of the managed system.

attributeID: ID of the attribute.

Request Body

None.

Response Body

None.

Response Codes

200 - Request successful.

For more information, please see Common Response Codes.