Platform API

<back to all web services

GetPermissionTree

Get a list of grouped permissions for an appliance.

Requires Authentication
The following routes are available for this service:
All Verbs/api/permissions/
"use strict";
export class GetPermissionTreeResponse {
    /** @param {{Permissions?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Permissions;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class GetPermissionTree {
    /** @param {{ApplianceId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Appliance Id to retrieve permissions for. If not supplied the current appliance id will be used. */
    ApplianceId;
}

JavaScript GetPermissionTree DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/permissions/ HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ApplianceId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Permissions":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}