Get Functional Roles By Enterprise

Get Functional Roles By Enterprise

Returns all functional roles defined with the specified usertype and enterpriseId.

Privileges required:

READ ENTERPRISE_SCOPED_ROLE

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

Show optional properties

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

userType

integer
enterpriseId
Required

enterpriseId

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","enterpriseId:"integer"}' https://{api_host}/portal/rest/functionalRole/getByEnterprise
On This Page
All Operations
POST
Enterprise Get Enterprise Alert Definitions
POST
Enterprise Delete Enterprise
POST
Enterprise Delete Enterprise Gateway Records
POST
Enterprise Delete Enterprise Network Allocation
POST
Enterprise Delete Enterprise Network Segment
POST
Enterprise Delete Enterprise Service
POST
Enterprise Get Enterprise Addresses
POST
Enterprise Get Enterprise Alert Configurations
POST
Enterprise Get Enterprise Alerts
POST
Enterprise Get Enterprise All Alert Recipients
POST
Enterprise Get Enterprise Configurations
POST
Enterprise Get Enterprise Network Allocations
POST
Enterprise Get Enterprise Network Segments
POST
Enterprise Get Enterprise Operator Configuration
POST
Enterprise Get Enterprise Route Configuration
POST
Enterprise Get Enterprise Route Table
POST
Enterprise Get Enterprise Services
POST
Enterprise Get Enterprises Missinggateway
POST
Enterprise Insert Enterprise Service
POST
Enterprise Insert Or Update Enterprise Alert Configurations
POST
Enterprise Set Enterprise All Alert Recipients
POST
Enterprise Set Enterprise Operator Configuration
POST
Enterprise Log Export Test Connectivity
POST
Enterprise Update Enterprise Route
POST
Enterprise Update Enterprise Route Configuration
POST
Enterprise Update Enterprise Service
POST
Get Functional Roles By Enterprise