Get Functional Roles By Operator

Get Functional Roles By Operator

Returns all functional roles defined with the specified usertype.

Privileges required:

READ OPERATOR_SCOPED_ROLE

Request
URI
POST
https://{api_host}/portal/rest/functionalRole/getByOperator
COPY
Request Body

Show optional properties

{
    "userType": "string"
}
{
    "userType": "string",
    "excludeSuperRoles": false
}
string
userType
Required

userType

Possible values are : OPERATOR, MSP, ENTERPRISE,
boolean
excludeSuperRoles
Optional

excludeSuperRoles

Responses
200

Request was successfully processed

Returns Array of get_functional_roles_result_item of type(s) application/json 
[
    {
        "id": 0,
        "created": "string",
        "operatorId": 0,
        "networkId": 0,
        "enterpriseId": 0,
        "enterpriseProxyId": 0,
        "name": "string",
        "userType": "string",
        "fromUserType": "string",
        "roleType": "string",
        "isCustom": 0,
        "isSuper": 0,
        "description": "string",
        "precedence": 0,
        "modified": "string"
    }
]

400
Returns generic_400 of type(s) application/json
Operation doesn't return any data structure

500
Returns generic_500 of type(s) application/json
Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"userType:"string"}' https://{api_host}/portal/rest/functionalRole/getByOperator
On This Page
All Operations
POST
Get Functional Roles By Operator