Get Composite Roles By Enterprise

Get Composite Roles By Enterprise

Returns all composite roles defined with the specified userTypes and enterpriseId.

Privileges required:

READ ENTERPRISE_SCOPED_ROLE

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

Show optional properties

{
    "userTypes": [
        {}
    ]
}
{
    "userTypes": [
        "string"
    ],
    "enterpriseId": 0,
    "roleIds": [
        0
    ]
}
array of string
userTypes
Required

userTypes

integer
enterpriseId
Optional

enterpriseId

array of integer
roleIds
Optional

roleIds

Responses
200

Request was successfully processed

Returns Array of get_composite_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 '{"userTypes:"array"}' https://{api_host}/portal/rest/compositeRole/getByEnterprise
On This Page
All Operations
POST
Create Composite Role By Enterprise
POST
Create Composite Role By Msp
POST
Create Composite Role By Operator
POST
Delete Composite Roles By Enterprise
POST
Delete Composite Roles By Msp
POST
Delete Composite Roles By Operator
POST
Get Composite Roles By Enterprise
POST
Get Composite Roles By Msp
POST
Get Composite Roles By Operator
POST
Update Composite Role By Enterprise
POST
Update Composite Role By Msp
POST
Update Composite Role By Operator