Overview

Groups must be created with the Cortado MDM in order to be accessed via the API.

Recommended:To authenticate use the api key, obtained as described here, on every request as the authorization header like this: Authorization: Api-Key my_api_key
To execute requests in a user context use the access token, obtained as described here, on the request as the json field token.
All additional request parameters are also added as json fields to the request body. The request content type must be application/json.
Using the Accept-Language request header the response localization can be set. Default is "en" for english, possible other value is "de" for german

Base API URL: https://go.mycortado.com/api/mdm/v2/group

Example Request

POST /api/mdm/v2/group/example HTTP/1.1
Host: go.mycortado.com
Content-Type: application/json
Authorization: Api-Key my_api_key

{
    ... all request parameters ...
}

Example Response

HTTP Status	Description
200	Request successfull. The response body will contain optional group data.
401	Authentication has failed. The access token was not passed or is invalid. You need to refresh the access token first.
403	Action forbidden. For example when a user access token is send in the request that is only usable with an admin access token.

Group Fields

The following fields can be returned by the API containing information about the user.

Field	Description
description	The description of the group
grouptype	The type of the group. 0: Local 1: Microsoft Entra
id	The id of the group
name	The name of the group

Get Groups

This request can only be used by sending an admin access token.
By sending such a token informations about all groups of the admin access tokens tenant can be retrieved.

Get Groups Request

POST /api/mdm/v2/group/list HTTP/1.1
Host: go.mycortado.com
Content-Type: application/json
Authorization: Api-Key my_api_key

{
}

Get Groups Response

HTTP/1.1 200 OK
Content-Type: application/json

{
    "errorcode": null,
    "errormessage": null,
    "success": true,
    "tokenstatus": null,
    "data": [
        {
            "description": "This group is used for ccs users that are not in a managed active directory group.",
            "id": 1,
            "name": "Default Group",
            "priority": 0,
            "sid": "default_user_template"
        },
        {
            "description": "Description",
            "id": 2,
            "name": "Test 1",
            "priority": 1,
            "sid": "b966e92c-13c6-4bb5-afc2-dbb2a079e697"
        },
        {
            "description": "",
            "id": 3,
            "name": "Test 2",
            "priority": 2,
            "sid": "49e962f0-d188-4100-9d68-43d6191157f3"
        }
    ],
    "pagecount": 1,
    "pageindex": 1,
    "totalcount": 3
}