Versions Compared

Old Version 17

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Introduction

The provisioning API is an admin-only API used to create users and push synchronisations in MyTimetable. This API can be used in your user provisioning processes to support an push synchronisation 'opt-out' scenario. The API is supported from MyTimetable version 3.0, and only supports JSON output and form-encoded input.

User resources

/users

Method: GET

Description: Query all known usernames.

...

Code Block
languagenone
{
    "users": [
        "alicealice@example.org", 
        "bobbob@example.org", 
        "carolcarol@example.org"
    ]
}

/users/{username}

Method: PUTGET

Description: Ensures Query a specific user with the specified username exists.

Parameters

NameDescriptionDefault value
username(required)The username for which a user profile should be created if it doesn't exist alreadyto query.-

Example request URL

Code Block
languagenone
$base_url/api/v0/users/alicealice@example.org

Example response body: none (status code 204 indicates success/user already exists)

/users/{username}

Method: DELETE

Description: Deletes the user profile with the specified username if it exists.

Parameters

...

Example request URL

Code Block
languagenone
$base_url/api/v0/users/alice

Example response body: none (status code 204 indicates success; 404 indicates user not found)

/users/{username}/synchronizations

Method: GET

Description: Query all synchronizations for a user.

Parameters: 

...

Example request URL

Code Block
languagenone
$base_url/api/v0/users/alice/synchronizations

Example response body

...

languagenone

...


Info

Please note the attributes property can be null.


Code Block
languagenone
{
    "username": "alice@example.org",
    "displayName": "Alice",
    "locale": "nl",
    "attributes": [
        {
            "name": "urn:mace:dir:attribute-def:displayName",
            "values": [
{             "id": 1,  "Alice"
           "type": "ews", ]
        },
        {
            "usernamename": "alice"urn:mace:dir:attribute-def:mail",
            "values": [
    }     ]
}

/users/{username}/synchronizations

Method: DELETE

Description: Delete all synchronizations for a user.

Parameters: 

...

The unlink mode indicates what should happen to the events in the user's calendar:

...

       "alice@example.org"
            ]
        },
        {
            "name": "urn:mace:dir:attribute-def:eduPersonAffiliation",
            "values": [
                "member",
                "student"
            ]
        },
        {
            "name": "urn:mace:dir:attribute-def:eduPersonPrincipalName",
            "values": [
                "alice@example.org"
            ]
        }
    ],
    "roles": [
        "ROLE_MEMBER",
        "ROLE_STUDENT"
    ]
}

Response code

200 (OK), 404 (Not Found) if the user does not exist

/users (MyTimetable 2019.16+)

Method: POST

Description: Creates a user with the specified username.

Parameters: none

Request body form values:

NameDescriptionDefault value
username (required)
Username of the user.-
displayName Display Name of the usernull
localeLocale of the user, or empty for the default locale.null
attributesAttribute for the user. This form value can be set multiple times. The format used is attributeName=attributeValue. When multiple values with the same attributeName are given, all attributeValues are persisted. See example request below.[]
rolesRoles of the user. This form value can be set multiple times.[]

Request URL

Code Block
languagenone
$base_url/api/v0/users

Request Accept header

application/json

Request Content-Type header

application/x-www-form-urlencoded

Example request body

Code Block
languagenone
username=alice%40example.org&displayName=Alice&locale=nl&attributes=urn%3Amace%3Adir%3Aattribute-def%3AdisplayName%3DAlice&attributes=urn%3Amace%3Adir%3Aattribute-def%3AeduPersonAffiliation%3Dmember&attributes=urn%3Amace%3Adir%3Aattribute-def%3AeduPersonAffiliation%3Dstudent&attributes=urn%3Amace%3Adir%3Aattribute-def%3Amail%3Dalice%40example.org&attributes=urn%3Amace%3Adir%3Aattribute-def%3AeduPersonPrincipalName%3Dalice%40example.org&roles=ROLE_MEMBER&roles=ROLE_STUDENT

Decoded example request body

Code Block
languagenone
username=alice@example.org
displayName=Alice
locale=nl
attributes=urn:mace:dir:attribute-def:displayName=Alice
attributes=urn:mace:dir:attribute-def:eduPersonAffiliation=member
attributes=urn:mace:dir:attribute-def:eduPersonAffiliation=student
attributes=urn:mace:dir:attribute-def:mail=alice@example.org
attributes=urn:mace:dir:attribute-def:eduPersonPrincipalName=alice@example.org
roles=ROLE_MEMBER
roles=ROLE_STUDENT

Example response Body

Code Block
languagenone
{
    "username": "alice@example.org",
    "displayName": "Alice",
    "locale": "nl",
    "attributes": [
        {
            "name": "urn:mace:dir:attribute-def:displayName",
            "values": [
                "Alice"
            ]	
        },
        {
            "name": "urn:mace:dir:attribute-def:mail",
            "values": [
                "alice@example.org"
            ]
        },
        {
            "name": "urn:mace:dir:attribute-def:eduPersonAffiliation",
            "values": [
                "member",
                "student"
            ]
        },
        {
            "name": "urn:mace:dir:attribute-def:eduPersonPrincipalName",
            "values": [
                "alice@example.org"
            ]
        }
    ],
    "roles": [
        "ROLE_MEMBER",
        "ROLE_STUDENT"
    ]
}

Response code

201 (Created) if the user is created, 400 (Bad Request) if input validation fails, 409 (Conflict) if a user with the given username already exists

/users/{username}

Method: PUT

Description: Ensures a user with the specified username and properties exists.

Warning

Please note that properties of a user can be changed by other actions as well. For example, if you provision the user with two attributes, a subsequent login by the user might overwrite these two attributes with new values or add more attributes (as provided by the authentication provider). Another example is the user changing its locale in the interface. Please keep this in mind when updating user properties.


Parameters

NameDescriptionDefault value
username(required)The username for which a user profile should be created if it doesn't exist already.-


Request body form values (MyTimetable 2019.16+)

Info
titleBehaviour

If no request body is sent, the following behaviour is used:

  • User does not exist: user is created
  • User already exists: nothing is changed
  • In either case, no response body is returned

If a request body is sent, the following behaviour is used:

  • User does not exist: user is created with the properties set as requested via the request body
  • User already exists: the properties of the user are updated (or unset) with the properties set as requested via the request body
  • In either case, the user is returned as the response body


NameDescriptionDefault value
displayNameDisplay name of the usernull
localeLocale of the user, or empty for the default locale.null
attributesAttribute for the user. This form value can be set multiple times. The format used is attributeName=attributeValue. When multiple values with the same attributeName are given, all attributeValues are persisted. See example request below.[]
rolesRoles of the user. This form value can be set multiple times.[]

Request URL

Code Block
languagenone
$base_url/api/v0/users/alice@example.org

Request Accept header

application/json

Request Content-Type header

application/x-www-form-urlencoded

Example request body

Code Block
languagenone
displayName=Alice&locale=nl&attributes=urn%3Amace%3Adir%3Aattribute-def%3AdisplayName%3DAlice&attributes=urn%3Amace%3Adir%3Aattribute-def%3AeduPersonAffiliation%3Dmember&attributes=urn%3Amace%3Adir%3Aattribute-def%3AeduPersonAffiliation%3Dstudent&attributes=urn%3Amace%3Adir%3Aattribute-def%3Amail%3Dalice%40example.org&attributes=urn%3Amace%3Adir%3Aattribute-def%3AeduPersonPrincipalName%3Dalice%40example.org&roles=ROLE_MEMBER&roles=ROLE_STUDENT

Decoded example request body

Code Block
languagenone
displayName=Alice
locale=nl
attributes=urn:mace:dir:attribute-def:displayName=Alice
attributes=urn:mace:dir:attribute-def:eduPersonAffiliation=member
attributes=urn:mace:dir:attribute-def:eduPersonAffiliation=student
attributes=urn:mace:dir:attribute-def:mail=alice@example.org
attributes=urn:mace:dir:attribute-def:eduPersonPrincipalName=alice@example.org
roles=ROLE_MEMBER
roles=ROLE_STUDENT

Example response body

If no request body is sent, no response body is returned.

If a request body is sent, the user is returned as the response body:

Code Block
languagenone
{
    "username": "alice@example.org",
    "displayName": "Alice",
    "locale": "nl",
    "attributes": [
        {
            "name": "urn:mace:dir:attribute-def:displayName",
            "values": [
                "Alice"
            ]
        },
        {
            "name": "urn:mace:dir:attribute-def:mail",
            "values": [
                "alice@example.org"
            ]
        },
        {
            "name": "urn:mace:dir:attribute-def:eduPersonAffiliation",
            "values": [
                "member",
                "student"
            ]
        },
        {
            "name": "urn:mace:dir:attribute-def:eduPersonPrincipalName",
            "values": [
                "alice@example.org"
            ]
        }
    ],
    "roles": [
        "ROLE_MEMBER",
        "ROLE_STUDENT"
    ]
}

Response code

  • If no request body is sent: 204 No Content
  • If a request body is sent: 201 Created (user newly created), 200 OK (user updated), or 400 (Bad Request) if input validation fails

/users/{username}

Method: DELETE

Description: Deletes the user profile with the specified username if it exists.

Parameters

NameDescriptionDefault value
username(required)The username for which a user profile should be deleted if it exists.-

Example request URL

Code Block
languagenone
$base_url/api/v0/users/alice

Example response body: none (status code 204 indicates success; 404 indicates user not found)

/users/{username}/synchronizations

Method: GET

Description: Query all synchronizations for a user.

Parameters: 

NameDescriptionDefault value
username(required)The username for which the synchronizations should be queried.-

Example request URL

Code Block
languagenone
$base_url/api/v0/users/alice/synchronizations

Example response body

Code Block
languagenone
{
    "synchronizations": [
        {
            "id": 1, 
            "type": "ews", 
            "username": "alice",
			"description": "alice@bob.test",
            "enabled": true,
		    "status": "OK",
            "lastResync": 1355320800000
        }
    ]
}

/users/{username}/synchronizations

Method: DELETE

Description: Delete all synchronizations for a user.

Parameters: 

NameDescriptionDefault value
username(required)The username for which the synchronizations should be deleted.-
unlinkMode(required)

The unlink mode indicates what should happen to the events in the user's calendar:

  • UNLINK_ONLYLeaves all events in place.
  • DELETE_FUTURE_EVENTSOnly events which have been pushed with this specific synchronization id and which have a start date in the future are removed.
  • DELETE_ALL_EVENTSAll events which have been pushed with this specific synchronization id are removed.
  • CLEANUPAll events which have been pushed by this MyTimetable instance are removed, even those with a different synchronization id.
-

...

Example response body: none (status code 204 indicates success)

/users/{username}/synchronizations/{type}

Method: DELETE

Description: Delete synchronizations of a certain type for a certain user.

Parameters: 

...

The unlink mode indicates what should happen to the events in the user's calendar:

...

Example request for a certain user.

Parameters: 

NameDescriptionDefault value
username(required)The username for which the synchronizations should be deleted.-
type(required)The synchronization type, which indicates the calendaring service provider.-
unlinkMode(required)

The unlink mode indicates what should happen to the events in the user's calendar:

  • UNLINK_ONLYLeaves all events in place.
  • DELETE_FUTURE_EVENTSOnly events which have been pushed with this specific synchronization id and which have a start date in the future are removed.
  • DELETE_ALL_EVENTSAll events which have been pushed with this specific synchronization id are removed.
  • CLEANUPAll events which have been pushed by this MyTimetable instance are removed, even those with a different synchronization id.
-

Example request URL

Code Block
languagenone
$base_url/api/v0/users/alice/synchronizations/ews?unlinkMode=DELETE_ALL_EVENTS

Example response body: none (status code 204 indicates success; 404 indicates no synchronizations found; 422 indicates invalid synchronisation type)

Synchronization resources

/synchronizations

Method: GET

Description: Query all synchronizations.

Parameters: none

Request URL

Code Block
languagenone
$base_url/api/v0/users/alice/synchronizations/ews?unlinkMode=DELETE_ALL_EVENTS

Example response body: none (status code 204 indicates success; 404 indicates no synchronizations found; 422 indicates invalid synchronisation type)

Synchronization resources

/synchronizations

Method: GET

Description: Query all synchronizations.

Parameters: none

Request URL

Code Block
languagenone
$base_url/api/v0/synchronizations

Example response body

Code Block
languagenone
{
    "synchronizations": [
        {
    synchronizations

Example response body

Code Block
languagenone
{
    "synchronizations": [
        {
            "id": 1, 
            "type": "o365", 
            "username": "alice",
			"description": "alice@bob.test",
            "enabled": true,
		    "status": "OK",
            "lastResync": 1355320800000
        },
       "id": 1, {
            "usernameid": "alice"1, 
            "type": "o365googlecalendar", 
       },     "username": "bob",
  {			"description": "bob@google.test",
            "idenabled": 2true,
 		           "username"status": "bobOK",
            "typelastResync": "googlecalendar"1355320800000
        }
    ]
}

/synchronizations

Method: PUT

Description: Sets up a synchronization with a user's external calendar.

...

Code Block
languagenone
username=alicealice@example.org&type=ews&provisioning_smtpAddress=alice@examplealice@bob.org

Example response body:

Code Block
languagenone
{test

Example response body:

Code Block
languagenone
{
    "synchronization":
        {
            "id": 1, 
            "synchronizationtype": "ews", 
      {       "username": "alice@example.org",
			"description": "alice@bob.test",
            "idenabled": 1true,
     		       "usernamestatus": "aliceOK",
            "typelastResync": "ews"1355320800000
        }
}

Response code: 200 OK, 422 Unprocessable Entity (username does not exist or synchronization type is not known), 550 Permission Denied (access not granted to mailbox)

/synchronizations/{id}

Method: DELETE

Description: Deletes the synchronization with the specified id.

...

Example response body: none (status code 204 indicates success; 404 indicates synchronization not found)

Sample usage

If you want to create a large number of synchronisations, create a text file with the username and email address of the users. Then you can run the following shell script to create the users:

...