Get group details

This method returns the details of a single user group.

The user running this Web service must have Audit users permissions.

Groups are retrieved only if they are on the same level as your user or lower in the the Vault hierarchy.

URL

https://<IIS_Server_Ip>/PasswordVault/API/UserGroups/{ID}/

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. Type: String Mandatory: Yes Default value: None

Parameter

Description

Authorization

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

Type: String

Mandatory: Yes

Default value: None

URL parameters

Parameter	Description
includeMembers	Whether or not to return members for each user group as part of the response. If not sent, the value will be False. Type: Boolean Default value: False

Parameter

Description

includeMembers

Whether or not to return members for each user group as part of the response. If not sent, the value will be False.

Type: Boolean

Default value: False

Body parameters

None.

Result

The following information is returned for the requested group.

{
  "id": 8,
  "groupType": "Vault",
  "members": [
    {
      "UserName": "Auditor",
      "id": 3
    }
  ],
  "groupName": "Auditors",
  "description": "Auditors group",
  "location": "\\"
}

Parameter	Description
id	The unique ID of the group. Type: Number
groupType	Whether this is a Vault group or Directory group. Type: String Valid values: Vault, Directory
groupName	The name of a group in the Vault. Type: String
description	The description of the group. Type: String
location	The location of the group in the Vault’s hierarchy. Type: String
directory	Displays the name of the LDAP external directory to which the external group belongs. This is relevant only for the Directory group type. Type String
dn	Displays the full LDAP DN of the user in the external directory to which the external user belongs. This is relevant only for the Directory group type. Type: String
members	A list of users that are members of the group. See Member parameters.

Member parameters

Parameter	Description
username	The name of the user. Type: String
id	The ID of the user. Type: Long

Parameter

Description

username

The name of the user.

Type: String

The ID of the user.

Type: Long

Return codes

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