CoreView — Operators API resources

Beta version updated on December 13th 2024

This article provides a quick guide to the properties and types associated with the OperatorUser and OperatorGroup object. It includes detailed descriptions, example objects, and usage guidelines to help you understand and integrate with CoreView API.

Please note that API design is still a beta version and the contents are subject to change as we continue to refine and improve our API.

Detailed schema

Properties of OperatorUser

The OperatorUser object contains the following properties:

Property	Type	Description
Id	string	The unique identifier for operator user.
DisplayName	string	The display name of the operator user.
UserName	string	The username of the operator user.
Email	string	The email of the operator user.
Roles	array of strings	The roles of the operator user.
InheritedRoles	array of strings	The inherited roles of the operator user.
Groups	array of strings	The groups of the operator user.

Properties of OperatorGroup

The OperatorGroup object contains the following properties:

Property	Type	Description
Id	string	The unique identifier for the group.
Name	string	The name of the group.
Roles	array of strings	The name list of the roles assigned to the group.
GroupType	enum	The type of the group. Options are DistributionGroup, Microsoft365Group, SecurityGroup.

Examples

Example of a OperatorUser Object

Here’s an example of a OperatorUser object:

{
    "email": "firstname.lastname@domain.ext",
    "userName": "firstname.lastname@domain.ext",
    "firstName": "Firstname",
    "lastName": "Lastname",
    "roles": [
        "Management"
    ]
}

Example of a OperatorGroup Object

Here’s an example of a OperatorGroup object:

{
    "id": "eafbaefb-f17b-453a-989c-8e2b5fac7e62",
    "name": "OperatorUserTest",
    "groupType": "SecurityGroup",
    "roles": [
        "GlobalLicenses"
    ]
}

Download

Visualize and interact with our API by downloading Swagger UI:

Download the operators API Swagger UI

Understand our API’s data structure by downloading the JSON schema:
Download the operatos JSON schema

API

Operators API resources