Credentials

Quick Navigation

POST TeamPasswords/Folders/{id}/Credentials/

Purpose

Creates a team passwords credential in the folder by ID.

Required Permissions

TeamPasswords (Read/Write).

Parameters

id: the folder ID (GUID).

Query Parameters

Version: (optional, default: 3.0) Request body model version (3.0, 3.1, 3.2).

Request Body (version. 3.0)

Content-Type: application/json

{
    Title : string,
    Description : string,
    Username : string,
    Password : string,
}

Request Body Details

  • Max string length for description and password is 256.
  • Title, username, password.
  • OwnerId (for each owner in the list).
  • Either owners or GroupId is also required.

Response Body

Content-Type: application/json

{
    Id : Guid,
    Title : string,
    Description : string,
    Username : string,
    Password : string,
    OwnerId : int,
    FolderId : Guid,
    CreatedOn : Datetime,
    CreatedBy : string,
    ModifiedOn : Datetime,
    ModifiedBy : string,
    Owner : string,
    Folder : string,
    FolderPath : string,
    Owners : [{ 
        OwnerId : int, 
        Owner : string,
        Email : string,
    }],
    OwnerType : string,
}

Request Body (version 3.1)

{
    Title : string,
    Description : string,
    Username : string,
    Password : string,
    Owners : [{
        OwnerId : int,
        Owner : string,
        Email : string,
    }],
    OwnerId : int
    OwnerType : string,
    GroupId : int // can be null
}

Request Body Details

  • Max string length for description and password is 256.
  • Title, username, password.
  • OwnerId (for each owner in the list).
  • Either owners or GroupId is also required.

Response Body

Content-Type: application/json

{
    Id : Guid,
    Title : string,
    Description : string,
    Username : string,
    Password : string,
    OwnerId : int,
    FolderId : Guid,
    CreatedOn : Datetime,
    CreatedBy : string,
    ModifiedOn : Datetime,
    ModifiedBy : string,
    Owner : string,
    Folder : string,
    FolderPath : string,
    Owners : [{
        OwnerId : int,
        Owner : string,
        Email : string,
    }],
    OwnerType : string,
}

Request Body (version 3.2)

{
    Title : string,
    Description : string,
    Username : string,
    Password : string,
    Owners : [{
        OwnerId : int,
        Owner : string,
        Email : string,
    }],
    OwnerId : int
    OwnerType : string,
    GroupId : int // can be null
    PasswordRuleID : int // can be null
    Notes : string // 4000 character limit
}

Request Body Details

  • Max string length for description and password is 256.
  • Title, username, password.
  • OwnerId (for each owner in the list).
  • Either owners or GroupId is also required.
  • A password or a PasswordRuleID is required.
    • If a PasswordRuleID is passed in, then a password is generated (based on the Password Policy defined by the PasswordPolicyId).
    • If the password is passed in instead, the same behavior is followed (using that as the password).

Response Body

Content-Type: application/json

{
    Id : Guid,
    Title : string,
    Description : string,
    Username : string,
    Password : string,
    OwnerId : int,
    FolderId : Guid,
    CreatedOn : Datetime,
    CreatedBy : string,
    ModifiedOn : Datetime,
    ModifiedBy : string,
    Owner : string,
    Folder : string,
    FolderPath : string,
    Owners : [{
        OwnerId : int,
        Owner : string,
        Email : string,
    }],
    OwnerType : string,
    PasswordRuleID : int // can be null
    Notes : string // 4000 character limit
}

Response Codes

  • 201 - Request successful. Team Passwords Folder in the response body.
  • 400 - Enabled product not valid.
  • 409 - Conflict.

For more information, please see Common Response Codes.

PUT TeamPasswords/Credentials/{id}/

Purpose

Updates a team passwords credential by ID.

Required Permissions

TeamPasswords (Read/Write).

Parameters

id: the credential ID (GUID).

Query Parameters

version: (optional, default: 3.0) Request body model version (3.0, 3.1, 3.2).

Request Body (version 3.0)

Content-Type: application/json

{
       Id : Guid,
       Title : string,
       Description : string,
       Username : string,
       Password : string,
       OwnerId : int,
       FolderId : Guid
}

Request Body Details

Max string length for Description and Password is 256.

Response Body

Content-Type: application/json

Max string length for Description and Password is 256.

{
     Id : Guid,
     Title : string,
     Description : string,
     Username : string,
     Password : string,
     OwnerId : int,
     FolderId : Guid,
     CreatedOn : Datetime,
     CreatedBy : string,
     ModifiedOn : Datetime,
     ModifiedBy : string,
     Owner : string,
     Folder : string,
     FolderPath : string,
}

Request Body (version 3.1)

Content-Type: application/json

{
    Title : string,
    Description : string,
    Username : string,
    Password : string,
    Owners : [{
        OwnerId : int,
        Owner : string,
        Email: string,
    }],
    OwnerId : int
    OwnerType: string,
    GroupId : int // can be null
}

Request Body Details

  • Max string length for description and password is 256.
  • Title, username, password.
  • OwnerId (for each owner in the list).
  • Either Owners or GroupId is also required.

Response Body

Content-Type: application/json

{
    Id : Guid,
    Title : string,
    Description : string,
    Username : string,
    Password : string,
    OwnerId : int,
    FolderId : Guid,
    CreatedOn : Datetime,
    CreatedBy : string,
    ModifiedOn : Datetime,
    ModifiedBy : string,
    Owner : string,
    Folder : string,
    FolderPath : string,
    Owners : [{ 
        OwnerId : int, 
        Owner : string,
        Email : string,
    }],
    OwnerType : string,
}

Request Body (version 3.2)

Content-Type: application/json

{
    Title : string,
    Description : string,
    Username : string,
    Password : string,
    Owners : [{
        OwnerId : int,
        Owner : string,
        Email: string,
    }],
    OwnerId : int
    OwnerType: string,
    GroupId : int // can be null
    PasswordRuleID : int // can be null
    Notes : string // 4000 character limit
}

Request Body Details

  • Max string length for description and password is 256.
  • Title, username, password.
  • OwnerId (for each owner in the list).
  • Either Owners or GroupId is also required.
  • A password or a PasswordRuleID is required.
    • If a PasswordRuleID is passed in, then a password is generated (based on the Password Policy defined by the PasswordPolicyId).
    • If the password is passed in instead, the same behavior is followed (using that as the password).

Response Body

Content-Type: application/json

{
    Id : Guid,
    Title : string,
    Description : string,
    Username : string,
    Password : string,
    OwnerId : int,
    FolderId : Guid,
    CreatedOn : Datetime,
    CreatedBy : string,
    ModifiedOn : Datetime,
    ModifiedBy : string,
    Owner : string,
    Folder : string,
    FolderPath : string,
    Owners : [{ 
        OwnerId : int, 
        Owner : string,
        Email : string,
    }],
    OwnerType : string,
    PasswordRuleID : int // can be null
    Notes : string // 4000 character limit
}

Response Codes

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

400 - Enabled product not valid.

For more information, please see Common Response Codes.

DELETE TeamPasswords/Credentials/{id}/

Purpose

Deletes a team password credential by ID.

Required Permissions

TeamPasswords (Read/Write).

Parameters

id: the credential ID (GUID).

Request Body

None.

Response Body

None.

Response Codes

200 – Request successful.

 

For more information, please see Common Response Codes.

GET TeamPasswords/Credentials/{id}/

Purpose

Returns a team passwords credential by ID.

Required Permissions

TeamPasswords (Read).

Parameters

id: the credential ID (GUID).

Request Body

None.

Response Body (version 3.1)

Content-Type: application/json

{
    Id : Guid,
    Title : string,
    Description : string,
    Username : string,
    Password : string,
    OwnerId : int,
    FolderId : Guid,
    CreatedOn : Datetime,
    CreatedBy : string,
    ModifiedOn : Datetime,
    ModifiedBy : string,
    Owner : string,
    Folder : string,
    FolderPath : string,
    Owners : [{
        OwnerId : int,
        Owner : string,
        Email : string,
    }],
    OwnerType : string,
}

Response Codes

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

For more information, please see Common Response Codes.

GET TeamPasswords/Folders/{id}/Credentials/

Purpose

Returns a list of team passwords credentials by folder ID.

Required Permissions

TeamPasswords (Read).

Parameters

id: the folder ID (GUID).

Request Body

None.

Response Body (version 3.0)

Content-Type: application/json

[
    {
        Id : Guid,
        Title : string,
        Description : string,
        Username : string,
        OwnerId : int,
        FolderId : Guid,
        CreatedOn : Datetime,
        CreatedBy : string,
        ModifiedOn : Datetime,
        ModifiedBy : string,
        Owner : string,
        Folder : string,
        FolderPath : string,
    },
    …
]

Response Codes

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

For more information, please see Common Response Codes.

Response Body (version 3.1)

Content-Type: application/json

{
    Id : Guid,
    Title : string,
    Description : string,
    Username : string,
    OwnerId : int,
    FolderId : Guid,
    CreatedOn : Datetime,
    CreatedBy : string,
    ModifiedOn : Datetime,
    ModifiedBy : string,
    Owner : string,
    Folder : string,
    FolderPath : string,
    Owners : [{
        OwnerId : int,
        Owner : string,
        Email : string,
    }],
    OwnerType : string,
}

Response Body (version 3.2)

Content-Type: application/json

{
    Id : Guid,
    Title : string,
    Description : string,
    Username : string,
    OwnerId : int,
    FolderId : Guid,
    CreatedOn : Datetime,
    CreatedBy : string,
    ModifiedOn : Datetime,
    ModifiedBy : string,
    Owner : string,
    Folder : string,
    FolderPath : string,
    Owners : [{
        OwnerId : int,
        Owner : string,
        Email : string,
    }],
    OwnerType : string,
    PasswordRuleID : int // can be null
    Notes : string // 4000 character limit
}

Response Codes

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

400 - Enabled product not valid.

For more information, please see Common Response Codes.