Get group platforms

This method allows Vault Admins to retrieve basic information about all existing group platforms.

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/platforms/groups

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 parameter

Parameter	Description
search	Search for a string in the following field: Platform Name Type: string Example: `https://{server}/passwordvault/api/Platforms/Groups?search=SSH`

Parameter

Description

Search for a string in the following field:

Platform Name

Type: string

Example: https://{server}/passwordvault/api/Platforms/Groups?search=SSH

Body parameters

None.

Result

{
 "Platforms": [
 {
    "Active": true,
    "ID": 33,
    "PlatformID": "SampleGroup",
    "Name": "[Sample Password Group Platform]"
 },
 ],
 "Total": 1
}

Parameter	Description
general
id	Unique numeric ID of the platform. Type: number
platformID	Unique display ID of the platform. Type: string
name	Display name of the platform. Type: string
description	Description of the platform. Type: string
active	Indicates whether or not the platform is active. Type: boolean

Return codes

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