Update Safe member

This method updates an existing Safe member.

The user who runs this web service requires Manage Safe Members permissions in the Vault.

URL

 
https://<IIS_Server_Ip>/PasswordVault/API/Safes/{SafeUrlId}/Members/{MemberName}/
  • Make sure there are no spaces in the URL.

  • The following characters are not supported in URL values: + & %

  • If the URL includes a dot (.), add a forward slash (/) at the end of the URL. For example: api/Safes/MySafe/Members/user@cyber.com/

Resource information

HTTP method

Content type

PUT

application/json

Header parameter

Parameter

Description

Authorization

The token that identifies the session, encoded in BASE 64.

Type: String

Mandatory: Yes

Default value: None

URL parameters

Parameter

Description

safeUrlId

The unique ID of the Safe.

Type: String

Mandatory: Yes

Default value: None

memberName

The Vault user name, Domain user name or group name of the Safe member.

The following characters cannot be used in the Safe member name: \ / : * < > “ | ? % & +

Type: String

Mandatory: Yes

Default value: False

Body parameters

{
    "membershipExpirationDate":1234567,
    "permissions": {
                "useAccounts": true,
                "retrieveAccounts": true,
                "listAccounts": true,
                "addAccounts": true,
                "updateAccountContent": true,
                "updateAccountProperties": true,
                "initiateCPMAccountManagementOperations": true,
                "specifyNextAccountContent": true,
                "renameAccounts": true,
                "deleteAccounts": true,
                "unlockAccounts": true,
                "manageSafe": true,
                "manageSafeMembers": true,
                "backupSafe": true,
                "viewAuditLog": true,
                "viewSafeMembers": true,
                "accessWithoutConfirmation": true,
                "createFolders": true,
                "deleteFolders": false,
                "moveAccountsAndFolders": true,
                "requestsAuthorizationLevel1": true,
                "requestsAuthorizationLevel2": false
            }
}

Parameter

Description

MembershipExpirationDate

When the user's Safe membership expires.

Type: DateTime

Default value: None

Permissions

User or group permissions in the Safe.

Type: Boolean/Numeric

Valid values: See Permissions parameters.

Permissions parameters

Parameter

Description

UseAccounts

Use accounts but cannot view passwords.

Type: Boolean

Valid values: True/False

RetrieveAccounts

Retrieve and view accounts in the Safe.

Type: Boolean

Valid values: True/False

ListAccounts

View accounts list.

Type: Boolean

Valid values: True/False

AddAccounts

Add accounts in the Safe. Users who have this permission automatically have UpdateAccountProperties permissions as well.

Type: Boolean

Valid values: True/False

UpdateAccountContent

Update existing account content.

Type: Boolean

Valid values: True/False

UpdateAccountProperties

Update existing account properties.

Type: Boolean

Valid values: True/False

InitiateCPMAccountManagementOperations

Initiate password management operations through the CPM such as changing passwords, or verifying and reconciling passwords. When this parameter is set to False, the SpecifyNextAccountContent is automatically set to False.

Type: Boolean

Valid values: True/False

SpecifyNextAccountContent

Specify the password that is used when the CPM changes the password value. This parameter can only be specified when InitiateCPMAccountManagementOperations is set to True.

When InitiateCPMAccountManagementOperations

is set to False, this parameter is automatically set to False.

Type: Boolean

Valid values: True/False

RenameAccounts

Rename existing accounts in the Safe.

Type: Boolean

Valid values: True/False

DeleteAccounts

Delete existing passwords in the Safe.

Type: Boolean

Valid values: True/False

UnlockAccounts

Unlock accounts that are locked by other users.

Type: Boolean

Valid values: True/False

ManageSafe

Perform administrative tasks in the Safe, including:

  • Update Safe properties

  • Recover the Safe

  • Delete the Safe

Type: Boolean

Valid values: True/False

ManageSafeMembers

Add and remove Safe members, and update their authorizations in the Safe.

Type: Boolean

Valid values: True/False

BackupSafe

Create a backup of a Safe and its contents, and store in another location.

Type: Boolean

Valid values: True/False

ViewAuditLog

View account and user activity in the Safe.

Type: Boolean

Valid values: True/False

ViewSafeMembers

View Safe members` permissions.

Type: Boolean

Valid values: True/False

RequestsAuthorizationLevel1

Requests Authorization Level 1.

Type: Boolean

Valid values: True/False

RequestsAuthorizationLevel2

Requests Authorization Level 2.

Type: Boolean

Valid values: True/False

AccessWithoutConfirmation

Access the Safe without confirmation from authorized users. This overrides the Safe properties that specify that Safe members require confirmation to access the Safe.

Type: Boolean

Valid values: True/False

CreateFolders

Create folders in the Safe.

Type: Boolean

Valid values: True/False

DeleteFolders

Delete folders in the Safe.

Type: Boolean

Valid values: True/False

MoveAccountsAndFolders

Move accounts and folders in the Safe to different folders and subfolders.

Type: Boolean

Valid values: True/False

Result

Parameter

Description

safeUrlId

The unique ID of the Safe used when calling Safe APIs.

Type: String

safeName

The unique name of the Safe.

Type: String

safeNumber

The unique numerical ID of the Safe.

Type:  Integer

memberId

The Vault user ID, Domain user ID, or group ID of the Safe member.

Type:  String

memberName

The Vault user name, Domain user name or group name of the Safe member.

Type: String

memberType

The member type.

Type: String

Valid values: user\group

membershipExpirationDate

The member's expiration date for this Safe. For members that do not have an expiration date, this value will be null.

Type: DateTime

isExpiredMembershipEnable

Whether or not the membership for the Safe is expired. For expired members, the value will be True.

Type: Boolean

isReadOnly

Whether or not the current user can update the permissions of a member.

Type: Boolean

isPredefinedUser

Whether the member is a predefined user or group of the Vault.

Type: Boolean

permissions

The permissions that the user or group has for this Safe.

See Permissions parameters.

Permissions parameters

Parameter

Description

useAccounts

Use accounts but cannot view passwords.

Type: Boolean

retrieveAccounts

Retrieve and view accounts in the Safe.

Type: Boolean

listAccounts

View the Accounts list.

Type: Boolean

addAccounts

Add accounts in the Safe. Users who have this permission automatically have UpdateAccountProperties permissions as well.

Type: Boolean

updateAccountContent

Update existing account content.

Type: Boolean

updateAccountProperties

Update existing account properties.

Type: Boolean

initiateCPMAccountManagementOperations

Initiate password management operations through CPM, such as changing, verifying, and reconciling passwords.

When this parameter is set to False, the SpecifyNextAccountContent parameter is also automatically set to False.

Type: Boolean

specifyNextAccountContent

Specify the password that is used when the CPM changes the password value.

This parameter can only be specified when the InitiateCPMAccountManagementOperations parameter is set to True.

When InitiateCPMAccountManagementOperations is set to False, this parameter is automatically set to False.

Type: Boolean

renameAccounts

Rename existing accounts in the Safe.

Type: Boolean

deleteAccounts

Delete existing passwords in the Safe.

Type: Boolean

unlockAccounts

Unlock accounts that are locked by other users.

Type: Boolean

manageSafe

Perform administrative tasks in the Safe, including:

  • Update Safe properties
  • Recover the Safe
  • Delete the Safe

Type: Boolean

manageSafeMembers

Add and remove Safe members, and update their authorizations in the Safe.

Type: Boolean

backupSafe

Create a backup of a Safe and its contents, and store in another location.

Type: Boolean

viewAuditLog

View account and user activity in the Safe.

Type: Boolean

viewSafeMembers

View Safe members` permissions.

Type: Boolean

requestsAuthorizationLevel1

Request Authorization Level 1.

Type: Boolean

requestsAuthorizationLevel2

Request Authorization Level 2.

Type: Boolean

accessWithoutConfirmation

Access the Safe without confirmation from authorized users. This overrides the Safe properties that specify that Safe members require confirmation to access the Safe.

Type: Boolean

createFolders

Create folders in the Safe.

Type: Boolean

deleteFolders

Delete folders from the Safe.

Type:  Boolean

moveAccountsAndFolders

Move accounts and folders in the Safe to different folders and subfolders.

Type: Boolean

Return codes

For a complete list of return codes, see Return Codes.