API docs by Redocly

Dinotronic Management API (1.0.0)

Download OpenAPI specification:Download

API for management in Dinotronic AG.

teams

Operations related to Teams management.

Update User PhoneNumber

Update the PhoneNumber of a user.

header Parameters
api-key
required
string
Request Body schema: application/json
phonenumber
string

The new PhoneNumber.

policy
string

The to be assigned Policy.

user
string

The Primary User's User Principal Name (UPN).

tenant
string

The Tenant ID or Domain of the customer.

Responses

Request samples

Content type
application/json
{
  • "phonenumber": "+41441234567",
  • "policy": "Example_Policy",
  • "user": "example@email.com",
  • "tenant": "example.com"
}

Delete User PhoneNumber

Delete the PhoneNumber of a user.

header Parameters
api-key
required
string
Request Body schema: application/json
user
string

The Primary User's User Principal Name (UPN).

tenant
string

The Tenant ID or Domain of the customer.

Responses

Request samples

Content type
application/json
{
  • "user": "example@email.com",
  • "tenant": "example.com"
}

Get User PhoneNumber

Retrieve the PhoneNumber of a user.

query Parameters
tenant
required
string
Example: tenant=example.com

The Tenant ID or Domain of the customer.

user
required
string
Example: user=example@email.com

The Primary User's User Principal Name (UPN).

header Parameters
api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "phonenumber": "+41441234567",
  • "user": "example@email.com",
  • "tenantId": "12a3b4c5-abc1-1234-a123-a12b34c5de67",
  • "tenantDomain": "example.com"
}

groups

Operations related to Groups & Group Members management.

Create new group

Create a new group.

header Parameters
api-key
required
string
Request Body schema: application/json
groupType
string

The group type for the to be modified group. The group types are referred as Microsoft Groups, where 'security' stands for Microsoft Security Groups and 'mailEnabledSecurity' for Microsoft Exchange Online Mail Enabled Security Groups.

The following Methods can only be used by Mail Enabled Security Groups:

  • 'externalSendingAllowed'

If used otherwise, a response code of 400 will be returned.

groupName
string

The group name. Max Length 64 Characters.

groupDisplayName
string

The Display name of the group. Max Length 256 Characters.

groupDescription
string

The Description of the group. Max Length 256 Characters.

groupSMTP
string

The new group SMTP E-Mail Address.

Info: Only the name of the SMTP E-Mail Address needs to be provided for Security Groups. Max Length 64 Characters.

Info: The Whole E-Mail Address needs to be provided for Mail Enabled Security Groups. Max Length 256 Characters.

externalSendingAllowed
boolean

WARNING: Can only be used and is required with groupType 'mailEnabledSecurity'!

Allow external E-Mails.

tenant
string

The Tenant ID or Domain of the customer.

Responses

Request samples

Content type
application/json
{
  • "groupType": {
    },
  • "groupName": "test-group",
  • "groupDisplayName": "test-group",
  • "groupDescription": "This is a test Group",
  • "groupSMTP": "test",
  • "externalSendingAllowed": true,
  • "tenant": {
    }
}

Response samples

Content type
application/json
{
  • "groupId": "XXXXXX-XXXXXX-XXXXXX"
}

Modify Existing Group

Modify a existing group.

header Parameters
api-key
required
string
Request Body schema: application/json
groupType
string

The group type for the to be modified group. The group types are referred as Microsoft Groups, where 'security' stands for Microsoft Security Groups and 'mailEnabledSecurity' for Microsoft Exchange Online Mail Enabled Security Groups.

The following Methods can only be used by Mail Enabled Security Groups:

  • 'groupAlias'
  • 'externalSendingAllowed'

If used otherwise, a response code of 400 will be returned.

groupGUID
string

The to be changed group GUID.

groupName
string

WARNING: Can only be used with groupType 'mailEnabledSecurity'!

The new Group Name. Max Length 64 Characters.

groupDisplayName
string

The new Display name of the group. Max Length 256 Characters.

groupDescription
string

The new Description of the group. Max Length 256 Characters.

groupSMTP
string

The new group SMTP E-Mail Address.

Info: Only the name of the SMTP E-Mail Address needs to be provided for Security Groups. Max Length 64 Characters.

Info: The Whole E-Mail Address needs to be provided for Mail Enabled Security Groups. Max Length 256 Characters.

groupAlias
string

WARNING: Can only be used with groupType 'mailEnabledSecurity'!

Create an Alias for the group. Max Length 64 Characters.

Info: Only the name of the new Alias needs to be provided, not the whole E-Mail address (See example).

externalSendingAllowed
boolean

WARNING: Can only be used with groupType 'mailEnabledSecurity'!

Allow external E-Mails.

tenant
string

The Tenant ID or Domain of the customer.

Responses

Request samples

Content type
application/json
{
  • "groupType": {
    },
  • "groupGUID": "XXXXXX-XXXXXX-XXXXXX",
  • "groupName": "test-group",
  • "groupDisplayName": "test-group",
  • "groupDescription": "This is a test Group",
  • "groupSMTP": "test",
  • "groupAlias": "string",
  • "externalSendingAllowed": true,
  • "tenant": {
    }
}

Delete Group

Delete a group.

header Parameters
api-key
required
string
Request Body schema: application/json
groupType
string

The group type for the to be modified group. The group types are referred as Microsoft Groups, where 'security' stands for Microsoft Security Groups and 'mailEnabledSecurity' for Microsoft Exchange Online Mail Enabled Security Groups.

If used otherwise, a response code of 400 will be returned. example:

groupGUID
string

The to be deleted group GUID.

tenant
string

The Tenant ID or Domain of the customer.

Responses

Request samples

Content type
application/json
{
  • "groupType": {
    },
  • "groupGUID": "XXXXXX-XXXXXX-XXXXXX",
  • "tenant": {
    }
}

Modify Group Member(s)

Modify group member(s)

header Parameters
api-key
required
string
Request Body schema: application/json
groupType
string

The group type for the to be modified group. The group types are referred as Microsoft Groups, where 'security' stands for Microsoft Security Groups and 'mailEnabledSecurity' for Microsoft Exchange Online Mail Enabled Security Groups.

If used otherwise, a response code of 400 will be returned.

actionType
string

The action which should be executed for the user(s). The actions are referred for Adding and Removing Members from a group.

users
string

The user(s) which should be modified. Max UPN Length 256 Characters.

groupGUID
string

The to be modified group GUID.

tenant
string

The Tenant ID or Domain of the customer.

Responses

Request samples

Content type
application/json
{
  • "groupType": {
    },
  • "actionType": {
    },
  • "users": {
    },
  • "groupGUID": "XXXXXX-XXXXXX-XXXXXX",
  • "tenant": {
    }
}