ReDoc documentation
Get the company roles assigned to the given customer, filtered/paged per $searchCriteria. Returns one entry per company assignment in which the customer holds a role — not one per company assignment: a company the customer is assigned to but holds no role in contributes no entry at all. Returns an empty result when the customer is not a member of any company, holds no role in any of them, or when none of their companies/roles match $searchCriteria's filters. Supported filter fields: company_id, company_name (restrict which companies are considered), and resource_id, permission (restrict each matching role's permissions — a role left with no permissions after that narrowing is dropped from the result entirely). A single filter group (its filters are OR'd together) must not mix company fields with permission fields — throws otherwise. Supported condition types: eq and in on every field, plus like (SQL-style %/_ wildcards) on company_name. Sortable fields: id, company_id, role_name — applied to the result items themselves, after filtering and before paging (there's no sortable field within permissions).
200 Success.
401 Unauthorized
Internal Server error
Unexpected error
{- "items": [
- {
- "company_id": 0,
- "id": 0,
- "permissions": [
- {
- "permission": "string",
- "resource_id": "string"
}
], - "role_name": "string"
}
], - "search_criteria": {
- "current_page": 0,
- "filter_groups": [
- {
- "filters": [
- {
- "condition_type": "string",
- "field": "string",
- "value": "string"
}
]
}
], - "page_size": 0,
- "sort_orders": [
- {
- "direction": "string",
- "field": "string"
}
]
}, - "total_count": 0
}