Get rotational group platforms

This method allows Vault Admins to retrieve basic information about all existing rotational 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/rotationalGroups

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

URL parameter

Parameter

Description

search

Search for a string in the following field:

  • Platform Name

Type: string

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

Body parameters

None.

Result

 
{
 "Platforms": [
    {
        "Active": false,
        "GracePeriod": 0,
        "ID": 41,
        "PlatformID": "RotationalGroupExample",
        "Name": "Rotational Group Example"
    }
 ],
 "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.

Note: An inactive platform cannot be assigned to groups and groups assigned to it will not be managed.

Type: boolean

gracePeriod

Number of minutes between the rotation of roles between the accounts (active / inactive) and the beginning of the password change process for the current inactive account.

Type: number

Return codes

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