br_get_link

br_get_link

Description

Returns a list of available principal links. Each detail structure contains the “id”, “principal_id”, “principal_name”, “principal_username”, and optional “principal_shortname”. The “principal_id” and “principal_username” may be wildcards – if so they will be populated with an asterisk (*).

The “principal_shortname” value requires an optional boolean parameter to be passed.

Version

Available from version 6.18.0.

Access

Read-only, master access not required, available to all users.

Parameters

Number	Name	O/R	Version	Usage
1	Auth	Required	6.18.0+	Authentication structure.*
2	Search	Optional	6.18.0+	Search for specific principal names. This search may use * or % as wildcard characters.

*See call structure explanation.

Example

Request

{
    "method": "br_get_link",
    "params": [
        {
            "bridge_username":"username",
            "bridge_password":"password"
        },
        "",
        true
    ],
    "id": 1
}

Call

{
    "id": 1,
    "error": null,
    "result": [
        {
            "id": "3",
            "principal_id": "6001",
            "principal_name": "Test vagrant system 1",
            "principal_username": "api",
            "principal_shortname": "testsystem01"
        },
        {
            "id": "4",
            "principal_id": "6004",
            "principal_name": "Test (plinth) vagrant system 4",
            "principal_username": "censysad",
            "principal_shortname": "test04"
        },
        {
            "id": "2",
            "principal_id": "6006",
            "principal_name": "Test (plinth) vagrant system 6",
            "principal_username": "hansolo",
            "principal_shortname": "test06"
        }
    ]
}

br_get_link

Description

Version

Access

Parameters

Example

Keep up to date with us

Menu

Visit our website

ResRequest Modules