Get account group by Safe

This method returns all the account groups in a specific Safe. The user performing this task must have the following permissions in the Safe:

Add accounts
Update account content
Update account properties
Create folders

URL

  • 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/

 

 

https://<IIS_Server_Ip>/PasswordVault/API/AccountGroups?Safe=<SafeName>/

The following mandatory value is required in the URL:

Parameter

Safe

Type

String

Description

The name of the Safe where the account groups are.

Resource information

HTTP method

GET

Content type

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

Body parameters

None

Result

 
{

"GroupID":<The group ID>,

"GroupName":<The group name>,

"GroupPlatformID":<The group platform ID>,

"Safe":<The group Safe name>

}

 

Parameter

GroupID

Type

String

Description

The ID of the account group.

Parameter

GroupName

Type

String

Description

The name of the account group.

Parameter

GroupPlatformID

Type

String

Description

The ID of the platform associated with the account group.

Parameter

Safe

Type

String

Description

The name of the Safe where the account groups are.

Return codes

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