Folders

Quick Navigation

POST TeamPasswords/Folders/

Purpose

Creates a new team passwords folder for the given user group.

Required Permissions

TeamPasswords (Read/Write).

Request Body

Content-Type: application/json

{
    Name: string,
    Description: string,
    ParentId: Guid,
    UserGroupId: int,
}

Request Body Details

Max string length for description is 256.

Response Body

Content-Type: application/json

{
    Id: Guid,
    Name: string,
    Description: string,
    ParentId: Guid,
    UserGroupId: int,
}

Response Codes

  • 201 - Request successful. Team Passwords Folder in the response body.
  • 409 - Conflict.

For more information, please see Common Response Codes.

GET TeamPasswords/Folders/

Purpose

Returns a list of team passwords folders to which the current user has access.

Required Permissions

TeamPasswords (Read).

Request Body

None.

Response Body

Content-Type: application/json

[{
    Id: Guid,
    Name: string,
    Description: string,
    ParentId: Guid,
    UserGroupId: int,
},
…
]

Response Codes

200 - Request successful. Team Passwords Folders in the response body.

For more information, please see Common Response Codes.

PUT TeamPasswords/Folders/{id}

Purpose

Updates a team password folder by ID.

Required Permissions

TeamPasswords (Read/Write).

Parameters

id: the folder ID (GUID).

Request Body

Content-Type: application/json

{
    Name: string,
    Description: string,
    ParentId: Guid,
    UserGroupId: int,
}

Request Body Details

Max string length for description is 256.

Response Body

Content-Type: application/json

[{
    Id: Guid,
    Name: string,
    Description: string,
    ParentId: Guid,
    UserGroupId: int,
},
…
]

Response Codes

200 - Request successful. Team Passwords Folders in the response body.

For more information, please see Common Response Codes.

DELETE TeamPasswords/Folders/{id}

Purpose

Deletes a team passwords folder by ID.

Required Permissions

TeamPasswords (Read/Write).

Parameters

id: the folder ID (GUID).

Request Body

None.

Response Body

None.

Response Codes

200 - Request successful. Team passwords folders in the response body.

For more information, please see Common Response Codes.

GET TeamPasswords/Folders/{id}

Purpose

Returns a team passwords folder by ID.

Required Permissions

TeamPasswords (Read).

Parameters

id: the folder ID (GUID).

Request Body

None.

Response Body

Content-Type: application/json

{
    Id: Guid,
    Name: string,
    Description: string,
    ParentId: Guid,
    UserGroupId: int,
}

Response Codes

200 - Request successful. Team Passwords Folder in the response body.

For more information, please see Common Response Codes.