Get Safe member

This method returns a member of a Safe.

The user who runs this web service must have View Safe Members permissions in the Safe.

URL

https://<subdomain>.privilegecloud.cyberark.com/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
GET	application/json

Header parameter

Parameter	Description
Authorization	The token that identifies the session, encoded in BASE 64. See Authentication. Type: String Mandatory: Yes Default value: None

URL parameters

https://localhost/passwordvault/api/safes/Fin1Safe/members/Alex/

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. Type: String Mandatory: Yes Default value: False
useCache	Whether or not to retrieve the cache from a session. Type: Boolean Mandatory: No Default value: False

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.

Type: String

Mandatory: Yes

Default value: False

useCache

Whether or not to retrieve the cache from a session.

Type: Boolean

Mandatory: No

Default value: False

Body parameters

None.

Result

{
"safeUrlId": "Fin1Safe",
"safeName": "Fin1Safe",
"safeNumber": 687,
"memberId": 217,
"memberName": "Alex",
"memberType": "User",
"membershipExpirationDate": null,
"isExpiredMembershipEnable": false,
"isPredefinedUser": false,
"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": true,
"moveAccountsAndFolders": true,
"requestsAuthorizationLevel1": true,
"requestsAuthorizationLevel2": false
}
}

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: Integer
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
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.
isReadOnly	Whether or not the current user can update the permissions of the member. Type: Boolean

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.