Create group

This method adds a new Vault group.

To run this Web service, you must have the following permissions:

  • Add Users
  • Update Users

URL

 

Make sure there are no spaces in the URL.

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

 

 
https://<IIS_Server_Ip>/PasswordVault/api/UserGroups

Resource information

HTTP method

POST

Content type

application/json

Header parameter

Parameter

Authorization

Type

String

Description

The token that identifies the session.

Valid values

A session token that was returned from the “Logon” method.

Body parameters

 
{
   "groupName": "unique-group-name",
  "description": "The users in this group all have the same authorizations",
  "location": "\\"
}

 

Parameter

Description

groupName

The name of a group in the Vault.

location

The location of the group in the Vault’s hierarchy.

description

The description of the group.

Result

 
{
  "id": 25,
  "groupType": "Vault",
  "groupName": "unique-group-name",
  "description": "The users in this group all have the same authorizations",
  "location": "\\"
}

 

Parameter

Description

id

The unique ID of the group.

groupType

For this API, the value is Vault.

groupName

The name of a group in the Vault.

location

The location of the group in the Vault’s hierarchy.

description

The description of the group.

Return codes

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