Folders

TeamPasswords API endpoints are deprecated in v22.4 of this guide, and replaced with SecretsSafe v22.4. TeamPasswords API endpoints remain usable, but will be removed in time.

Quick Navigation

POST Secrets-Safe/Folders/

Purpose

Creates a new Secrets Safe folder for the given user group.

Required Permissions

Secrets-Safe (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. Secrets Safe Folder in the response body.
  • 409 - Conflict.

For more information, please see Common Response Codes.

GET Secrets-Safe/Folders/

Purpose

Returns a list of Secrets Safe folders to which the current user has access.

Required Permissions

Secrets-Safe (Read).

Parameters

To filter the results, use any combination of the following:

  • FolderName: The partial name of the folder.
  • FolderPath: Child folders are also included. Separator is /.
  • IncludeSubfolders: Indicate whether to include the subfolder. Default is true.
  • RootOnly: The results only include those folders at the root level.
  • FolderOwnerId: Filter results by the folders which are owned by the given FolderOwnerId.
  • Limit: Limits the results by the given integer greater than 0. Default is 1000.
  • Offset: Skip the first (offset) number of secrets.

Request Body

None.

Response Body

Content-Type: application/json

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

Response Codes

200 - Request successful. Secrets Safe Folders in the response body.

For more information, please see Common Response Codes.

PUT Secrets-Safe/Folders/{id}

Purpose

Updates a Secrets Safe folder by ID.

Required Permissions

Secrets-Safe (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. Secrets Safe Folders in the response body.

For more information, please see Common Response Codes.

DELETE Secrets-Safe/Folders/{id}

Purpose

Deletes a Secrets Safe folder by ID.

Required Permissions

Secrets-Safe (Read/Write).

Folders that contain secrets cannot be deleted.

Parameters

id: the folder ID (GUID).

Request Body

None.

Response Body

None.

Response Codes

200 - Request successful. Secrets Safe folders in the response body.

For more information, please see Common Response Codes.

GET Secrets-Safe/Folders/{id}

Purpose

Returns a Secrets Safe folder by ID.

Required Permissions

Secrets-Safe (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. Secrets Safe Folder in the response body.

For more information, please see Common Response Codes.