Skip to main content

Web Service Method: Request Roles

Abstract

Web Service Method: Request Roles

Description

Returns the available roles of PoolParty.

Note

Roles can not be configured in PoolParty at the moment. See also: User Roles in PoolParty

URL: /PoolParty/api/user/roles

Request

Supported Methods

GET

Content-Type

application/x-www-form-urlencoded

Response

http status code 200if OK.

JSON formatted response:

Attribute

Type

Comment

name

String

Role name

Example

URL Pattern
https://<server-url>/PoolParty/api/user/roles

JSON Formatted Response Example 

[
    {
        "name": "WikiEditor"
    },
    {
        "name": "PoolPartyUser"
    },
    {
        "name": "PoolPartyAdmin"
    },
    {
        "name": "PoolPartySuperAdmin"
    }
]
In this section: