Flint provides out-of-the-box or ready to use workflows for operations on cloud infrastructure/resources. Here are the details of workflows or Flintbits for Office365 -

Available Flintbits

Perform all standard application operations available through the Office365 connector, Some of them are listed below:

Office365 available Flintbits

  • get-all-users.rb

  • get-all-subscriptions.rb

  • get-user-licenses.rb

  • get-customer-roles.rb

  • get-available-licenses.rb

  • list-subscription-add-ons.rb

  • list-offer-id-add-ons.rb

  • create-customer.rb

  • create-order.rb

  • reset-user-account-password.rb

Get All Users

Input and output JSON for the  Get All Users operation

This section illustrates the Flintbit Input and output for Get All Users operations.

Sample Input JSON for the Get All Users operations
{
    "connector-name":"office365",
    "customer-id":"bc164b29-77da-4587-b584-b3cd019d1ca2"
}
Flintbit input elements for the Get All Users operation
ParameterDescriptionRequired
connector_nameName of the OFFICE365 Connector to be configured.true
actionOperation to be performedtrue
customer-idMicrosoft-id associated to the customertrue
Sample JSON output for the Get All Users operations
{
    "result": {
        "links": {
            "self": {
                "method": "GET",
                "uri": "/customers/ba168b29-77da-4587-b584-b3db019d1ca2/users",
                "headers": []
            }
        },
        "attributes": {
            "objectType": "Collection"
        },
        "totalCount": 12,
        "items": [
            {
                "firstName": "avi",
                "lastName": "test",
                "displayName": "displayname",
                "links": {
                    "self": {
                        "method": "GET",
                        "uri": "/customers/ba168b29-77da-4587-b584-b3fb019d1ca2/users/2f7acb5d-bb34-4815-8040-9b88342a920b",
                        "headers": []
                    }
                },
                "attributes": {
                    "objectType": "CustomerUser"
                },
                "usageLocation": "AT",
                "id": "2f7acb5d-bb34-4815-8040-9b88342a920b",
                "state": "active",
                "userDomainType": "none",
                "userPrincipalName": "admin@domain.onmicrosoft.com"
            },
            {
                "firstName": "First",
                "lastName": "Last",
                "displayName": "First131",
                "links": {
                    "self": {
                        "method": "GET",
                        "uri": "/customers/ba168b29-77da-4587-b584-b3eb019d1ca2/users/1680d501-c6e7-494d-965e-68d28dc38a6b",
                        "headers": []
                    }
                },
                "attributes": {
                    "objectType": "CustomerUser"
                },
                "usageLocation": "DE",
                "id": "1680d501-c6e7-494d-965e-68d28dc38a6b",
                "state": "active",
                "userDomainType": "none",
                "userPrincipalName": "First131@domain.onmicrosoft.com"
            },
            {
                "firstName": "First",
                "lastName": "Last",
                "displayName": "First141",
                "links": {
                    "self": {
                        "method": "GET",
                        "uri": "/customers/ba168b29-77da-4587-b584-b3eb019d1ca2/users/1685e9fa-85ba-4ca2-b8e9-9a8f30215d8e",
                        "headers": []
                    }
                },
                "attributes": {
                    "objectType": "CustomerUser"
                },
                "usageLocation": "DE",
                "id": "1685e9fa-85ba-4ca2-b8e9-9a8f30215d8e",
                "state": "active",
                "userDomainType": "none",
                "userPrincipalName": "first11@domain.onmicrosoft.com"
            },
            {
                "firstName": "First",
                "lastName": "Last",
                "displayName": "First151",
                "links": {
                    "self": {
                        "method": "GET",
                        "uri": "/customers/ba168b29-77da-4587-b584-b3eb019d1ca2/users/43553cd2-2dbf-4100-8e89-c851f4673176",
                        "headers": []
                    }
                },
                "attributes": {
                    "objectType": "CustomerUser"
                },
                "usageLocation": "DE",
                "id": "43553cd2-2dbf-4100-8e89-c851f4673176",
                "state": "active",
                "userDomainType": "none",
                "userPrincipalName": "first123@domain.onmicrosoft.com"
            },
            {
                "firstName": "John",
                "lastName": "John",
                "displayName": "John",
                "links": {
                    "self": {
                        "method": "GET",
                        "uri": "/customers/ba168b29-77da-4587-b584-b3eb019d1ca2/users/a7690e96-f321-42ba-8aad-3009f0f3ae6c",
                        "headers": []
                    }
                },
                "attributes": {
                    "objectType": "CustomerUser"
                },
                "usageLocation": "us",
                "id": "a7690e96-f321-42ba-8aad-3009f0f3ae6c",
                "state": "active",
                "userDomainType": "none",
                "userPrincipalName": "john@domain.onmicrosoft.com"
            },
            {
                "firstName": "Johny",
                "lastName": "Johny",
                "displayName": "Johny",
                "links": {
                    "self": {
                        "method": "GET",
                        "uri": "/customers/ba168b29-77da-4587-b584-b3eb019d1ca2/users/1c75db2c-47c7-4a64-99bb-889f8d577c4a",
                        "headers": []
                    }
                },
                "attributes": {
                    "objectType": "CustomerUser"
                },
                "usageLocation": "al",
                "id": "1c75db2c-47c7-4a64-99bb-889f8d577c4a",
                "state": "active",
                "userDomainType": "none",
                "userPrincipalName": "johnyyy@domain.onmicrosoft.com"
            },
            {
                "firstName": "pon",
                "lastName": "pon",
                "displayName": "pon",
                "links": {
                    "self": {
                        "method": "GET",
                        "uri": "/customers/ba168b29-77da-4587-b584-b3eb019d1ca2/users/e20f38d3-e99b-4747-8a25-f78ca1d9ac82",
                        "headers": []
                    }
                },
                "attributes": {
                    "objectType": "CustomerUser"
                },
                "usageLocation": "al",
                "id": "e20f38d3-e99b-4747-8a25-f78ca1d9ac82",
                "state": "active",
                "userDomainType": "none",
                "userPrincipalName": "pon@domain.onmicrosoft.com"
            },
            {
                "firstName": "test2",
                "lastName": "nov",
                "displayName": "test",
                "links": {
                    "self": {
                        "method": "GET",
                        "uri": "/customers/ba168b29-77da-4587-b584-b3eb019d1ca2/users/9305e2e6-5911-42fa-8aff-ffa9dd12b325",
                        "headers": []
                    }
                },
                "attributes": {
                    "objectType": "CustomerUser"
                },
                "usageLocation": "BS",
                "id": "9305e2e6-5911-42fa-8aff-ffa9dd12b325",
                "state": "active",
                "userDomainType": "none",
                "userPrincipalName": "test@domain.onmicrosoft.com"
            },
            {
                "firstName": "Test",
                "lastName": "Testing",
                "displayName": "Test",
                "links": {
                    "self": {
                        "method": "GET",
                        "uri": "/customers/bd168b29-77da-4587-b584-b3eb019d1ca2/users/afda6ab65-1f12-44de-8e14-cce7e1e5b63b",
                        "headers": []
                    }
                },
                "attributes": {
                    "objectType": "CustomerUser"
                },
                "usageLocation": "EG",
                "id": "afa6ab65-1f12-44de-8e14-cce7e1e5b63b",
                "state": "active",
                "userDomainType": "none",
                "userPrincipalName": "test@domain.onmicrosoft.com"
            },
            {
                "firstName": "Tom",
                "lastName": "Pom",
                "displayName": "Tom",
                "links": {
                    "self": {
                        "method": "GET",
                        "uri": "/customers/bd168b29-77da-4587-b584-b3eb019d1ca2/users/28cre17e-0c73-4d27-9087-a4f976d13bfc",
                        "headers": []
                    }
                },
                "attributes": {
                    "objectType": "CustomerUser"
                },
                "usageLocation": "us",
                "id": "28cbe17e-0c73-4d27-9087-a4f976d13bfc",
                "state": "active",
                "userDomainType": "none",
                "userPrincipalName": "admintom@domain.onmicrosoft.com"
            },
            {
                "firstName": "first",
                "displayName": "usr",
                "links": {
                    "self": {
                        "method": "GET",
                        "uri": "/customers/ba168b29-77da-4587-b584-b3eb019d1ca2/users/50bf3cdc-0791-432a-a206-a62d17a1711f",
                        "headers": []
                    }
                },
                "attributes": {
                    "objectType": "CustomerUser"
                },
                "usageLocation": "DE",
                "id": "50bf3cdc-0791-432a-a206-a62d17a1711f",
                "state": "active",
                "userDomainType": "none",
                "userPrincipalName": "testing1@domain.onmicrosoft.com"
            },
            {
                "firstName": "first",
                "displayName": "usr",
                "links": {
                    "self": {
                        "method": "GET",
                        "uri": "/customers/ba168b29-77da-4587-b584-b3eb019d1ca2/users/640d3243-2101-49cd-a579-b08ea48d9b44",
                        "headers": []
                    }
                },
                "attributes": {
                    "objectType": "CustomerUser"
                },
                "usageLocation": "DE",
                "id": "640d3243-2101-49cd-a579-b08ea48d9b44",
                "state": "active",
                "userDomainType": "none",
                "userPrincipalName": "testing2@domain.onmicrosoft.com"
            }
        ]
    }
}

Get All Subscription

Input and output JSON for the  Get All subscription operation

This section illustrates the Flintbit Input and output for Get All Subscription operations.

Sample Input JSON for the Get All Subscription operations
{
    "connector-name":"office365",
    "customer-id":"bc164b29-77da-4587-b584-b3cd019d1ca2"
}

 

Flintbit input elements for the Get All Subscription operation
ParameterDescriptionRequired
connector_nameName of the OFFICE365 Connector to be configured.true
actionOperation to be performedtrue
customer-idMicrosoft-id associated to the customertrue
Sample JSON output for the Get All Subscription operations
{
    "result": {
        "totalCount": 10,
        "items": [
            {
                "commitmentEndDate": "2017-12-10T00:00:00Z",
                "offerName": "Office 365 Exchange Online Protection (Government Pricing)",
                "quantity": 1,
                "orderId": "8D8843C9-ED9E-4A13-A420-61ECE19BF78E",
                "contractType": "subscription",
                "creationDate": "2016-11-16T06:34:57.453Z",
                "unitType": "Licenses",
                "billingType": "license",
                "billingCycle": "monthly",
                "effectiveStartDate": "2016-11-16T00:00:00Z",
                "offerId": "0CCA44D6-68E9-4762-94EE-31ECE98783B9",
                "links": {
                    "offer": {
                        "method": "GET",
                        "uri": "/offers/0CCA44D6-68E9-4762-94EE-31ECE98783B9?country=DE",
                        "headers": []
                    },
                    "self": {
                        "method": "GET",
                        "uri": "/customers/ba168b29-77da-4587-b584-b3eb019d1ca2/subscriptions/EC9E9FB9-F751-4802-9B02-2CE396BB7B8A",
                        "headers": []
                    }
                },
                "attributes": {
                    "etag": "eyJpZCI6ImVjOWU5ZmI5LWY3NTEtNDgwMi05YjAyLTJjZTM5NmJiN2I4YSIsInZlcnNpb24iOjF9",
                    "objectType": "Subscription"
                },
                "id": "EC9E9FB9-F751-4802-9B02-2CE396BB7B8A",
                "autoRenewEnabled": true,
                "friendlyName": "Nickname",
                "status": "active"
            },
            {
                "commitmentEndDate": "2017-12-10T00:00:00Z",
                "offerName": "Office 365 Exchange Online Protection (Government Pricing)",
                "quantity": 1,
                "orderId": "79D3A3AE-6288-4C2E-B2BD-59AFA05083A1",
                "contractType": "subscription",
                "creationDate": "2016-11-15T10:41:01.687Z",
                "unitType": "Licenses",
                "billingType": "license",
                "billingCycle": "monthly",
                "effectiveStartDate": "2016-11-15T00:00:00Z",
                "offerId": "0CCA44D6-68E9-4762-94EE-31ECE98783B9",
                "links": {
                    "offer": {
                        "method": "GET",
                        "uri": "/offers/0CCA44D6-68E9-4762-94EE-31ECE98783B9?country=DE",
                        "headers": []
                    },
                    "self": {
                        "method": "GET",
                        "uri": "/customers/ba168b29-77da-4587-b584-b3eb019d1ca2/subscriptions/96E99BE4-1AC5-4ECF-833F-453F26F805EA",
                        "headers": []
                    }
                },
                "attributes": {
                    "etag": "eyJpZCI6Ijk2ZTk5YmU0LTFhYzUtNGVjZi04MzNmLTQ1M2YyNmY4MDVlYSIsInZlcnNpb24iOjF9",
                    "objectType": "Subscription"
                },
                "id": "96E99BE4-1AC5-4ECF-833F-453F26F805EA",
                "autoRenewEnabled": true,
                "friendlyName": "Nicknameee",
                "status": "active"
            },
            {
                "commitmentEndDate": "2017-11-10T00:00:00Z",
                "offerName": "Skype for Business Plus CAL",
                "quantity": 1,
                "orderId": "60DF7276-F225-4A79-8111-CAD1DF5E4FA3",
                "contractType": "subscription",
                "creationDate": "2016-10-18T11:12:26.417Z",
                "unitType": "Instances",
                "billingType": "license",
                "suspensionReasons": [
                    "CustomerCancellation"
                ],
                "billingCycle": "monthly",
                "effectiveStartDate": "2016-10-18T00:00:00Z",
                "offerId": "FC233C3F-25BC-4BBA-8984-860CE561AF86",
                "links": {
                    "offer": {
                        "method": "GET",
                        "uri": "/offers/FC233C3F-25BC-4BBA-8984-860CE561AF86?country=DE",
                        "headers": []
                    },
                    "parentSubscription": {
                        "method": "GET",
                        "uri": "/subscriptions?key=L2N1c3RvbWVycy9iYTE2OGIyOS03N2RhLTQ1ODctYjU4NC1iM2ViMDE5ZDFjYTIvc3Vic2NyaXB0aW9ucy82MjMwMzZBQy02MDQwLTREM0YtOTRDOS05RTc0QzM4MzBCMjE=",
                        "headers": []
                    },
                    "self": {
                        "method": "GET",
                        "uri": "/customers/ba168b29-77da-4587-b584-b3eb019d1ca2/subscriptions/150CFF30-BEB2-46C6-B584-53541041E962",
                        "headers": []
                    }
                },
                "attributes": {
                    "etag": "eyJpZCI6IjE1MGNmZjMwLWJlYjItNDZjNi1iNTg0LTUzNTQxMDQxZTk2MiIsInZlcnNpb24iOjJ9",
                    "objectType": "Subscription"
                },
                "id": "150CFF30-BEB2-46C6-B584-53541041E962",
                "autoRenewEnabled": true,
                "friendlyName": "",
                "parentSubscriptionId": "623036AC-6040-4D3F-94C9-9E74C3830B21",
                "status": "suspended"
            },
            {
                "commitmentEndDate": "2017-12-10T00:00:00Z",
                "offerName": "Dynamics 365 Plan 1, Enterprise Edition",
                "quantity": 1,
                "orderId": "6EA4A6FB-1FD8-482D-BDFF-99F3DDF81AE3",
                "contractType": "subscription",
                "creationDate": "2016-11-16T09:14:21.517Z",
                "unitType": "Licenses",
                "billingType": "license",
                "billingCycle": "monthly",
                "effectiveStartDate": "2016-11-16T00:00:00Z",
                "offerId": "BB30B486-53BE-4ECF-BB85-6F50979F0579",
                "links": {
                    "offer": {
                        "method": "GET",
                        "uri": "/offers/BB30B486-53BE-4ECF-BB85-6F50979F0579?country=DE",
                        "headers": []
                    },
                    "self": {
                        "method": "GET",
                        "uri": "/customers/ba168b29-77da-4587-b584-b3eb019d1ca2/subscriptions/7BE39D7D-B055-42CD-9ACB-5C8598483B35",
                        "headers": []
                    }
                },
                "attributes": {
                    "etag": "eyJpZCI6IjdiZTM5ZDdkLWIwNTUtNDJjZC05YWNiLTVjODU5ODQ4M2IzNSIsInZlcnNpb24iOjF9",
                    "objectType": "Subscription"
                },
                "id": "7BE39D7D-B055-42CD-9ACB-5C8598483B35",
                "autoRenewEnabled": true,
                "friendlyName": "Dynamics 365 Plan 1, Enterprise Edition",
                "status": "active"
            },
            {
                "commitmentEndDate": "2017-11-10T00:00:00Z",
                "offerName": "Azure Active Directory Basic",
                "quantity": 1,
                "orderId": "52EFC41E-2FB4-416D-9744-7F7D413B6E7A",
                "contractType": "subscription",
                "creationDate": "2016-10-12T01:53:51.61Z",
                "unitType": "Licenses",
                "billingType": "license",
                "billingCycle": "monthly",
                "effectiveStartDate": "2016-10-12T00:00:00Z",
                "offerId": "84A03D81-6B37-4D66-8D4A-FAEA24541538",
                "links": {
                    "offer": {
                        "method": "GET",
                        "uri": "/offers/84A03D81-6B37-4D66-8D4A-FAEA24541538?country=DE",
                        "headers": []
                    },
                    "self": {
                        "method": "GET",
                        "uri": "/customers/ba168b29-77da-4587-b584-b3eb019d1ca2/subscriptions/5AD1FACD-2C7B-49AA-84BE-686155D298C2",
                        "headers": []
                    }
                },
                "attributes": {
                    "etag": "eyJpZCI6IjVhZDFmYWNkLTJjN2ItNDlhYS04NGJlLTY4NjE1NWQyOThjMiIsInZlcnNpb24iOjN9",
                    "objectType": "Subscription"
                },
                "id": "5AD1FACD-2C7B-49AA-84BE-686155D298C2",
                "autoRenewEnabled": true,
                "friendlyName": "Azure Active Directory Basic",
                "status": "active"
            },
            {
                "commitmentEndDate": "2017-12-10T00:00:00Z",
                "offerName": "Office 365 Exchange Online Protection (Government Pricing)",
                "quantity": 1,
                "orderId": "70338927-87E4-415E-8AFA-F06082EDFBF0",
                "contractType": "subscription",
                "creationDate": "2016-11-16T06:07:03.533Z",
                "unitType": "Licenses",
                "billingType": "license",
                "billingCycle": "monthly",
                "effectiveStartDate": "2016-11-16T00:00:00Z",
                "offerId": "0CCA44D6-68E9-4762-94EE-31ECE98783B9",
                "links": {
                    "offer": {
                        "method": "GET",
                        "uri": "/offers/0CCA44D6-68E9-4762-94EE-31ECE98783B9?country=DE",
                        "headers": []
                    },
                    "self": {
                        "method": "GET",
                        "uri": "/customers/ba168b29-77da-4587-b584-b3eb019d1ca2/subscriptions/CA597F89-E8A1-42E6-B0DC-8E9886FD15E6",
                        "headers": []
                    }
                },
                "attributes": {
                    "etag": "eyJpZCI6ImNhNTk3Zjg5LWU4YTEtNDJlNi1iMGRjLThlOTg4NmZkMTVlNiIsInZlcnNpb24iOjF9",
                    "objectType": "Subscription"
                },
                "id": "CA597F89-E8A1-42E6-B0DC-8E9886FD15E6",
                "autoRenewEnabled": true,
                "friendlyName": "Nickname",
                "status": "active"
            },
            {
                "commitmentEndDate": "2017-11-10T00:00:00Z",
                "offerName": "Delve Analytics",
                "quantity": 1,
                "orderId": "60DF7276-F225-4A79-8111-CAD1DF5E4FA3",
                "contractType": "subscription",
                "creationDate": "2016-11-16T09:59:23.033Z",
                "unitType": "Licenses",
                "billingType": "license",
                "billingCycle": "monthly",
                "effectiveStartDate": "2016-11-16T00:00:00Z",
                "offerId": "45320EC9-9B8E-49D0-B900-F14141A0ABD1",
                "links": {
                    "offer": {
                        "method": "GET",
                        "uri": "/offers/45320EC9-9B8E-49D0-B900-F14141A0ABD1?country=DE",
                        "headers": []
                    },
                    "parentSubscription": {
                        "method": "GET",
                        "uri": "/subscriptions?key=L2N1c3RvbWVycy9iYTE2OGIyOS03N2RhLTQ1ODctYjU4NC1iM2ViMDE5ZDFjYTIvc3Vic2NyaXB0aW9ucy82MjMwMzZBQy02MDQwLTREM0YtOTRDOS05RTc0QzM4MzBCMjE=",
                        "headers": []
                    },
                    "self": {
                        "method": "GET",
                        "uri": "/customers/ba168b29-77da-4587-b584-b3eb019d1ca2/subscriptions/3147B7C8-B4CD-4739-9723-93AAF0897E85",
                        "headers": []
                    }
                },
                "attributes": {
                    "etag": "eyJpZCI6IjMxNDdiN2M4LWI0Y2QtNDczOS05NzIzLTkzYWFmMDg5N2U4NSIsInZlcnNpb24iOjF9",
                    "objectType": "Subscription"
                },
                "id": "3147B7C8-B4CD-4739-9723-93AAF0897E85",
                "autoRenewEnabled": true,
                "friendlyName": "",
                "parentSubscriptionId": "623036AC-6040-4D3F-94C9-9E74C3830B21",
                "status": "active"
            },
            {
                "commitmentEndDate": "2017-11-10T00:00:00Z",
                "offerName": "Office 365 Enterprise E1",
                "quantity": 1,
                "orderId": "60DF7276-F225-4A79-8111-CAD1DF5E4FA3",
                "contractType": "subscription",
                "creationDate": "2016-10-18T11:11:54.577Z",
                "unitType": "Licenses",
                "billingType": "license",
                "billingCycle": "monthly",
                "effectiveStartDate": "2016-10-18T00:00:00Z",
                "offerId": "91FD106F-4B2C-4938-95AC-F54F74E9A239",
                "links": {
                    "offer": {
                        "method": "GET",
                        "uri": "/offers/91FD106F-4B2C-4938-95AC-F54F74E9A239?country=DE",
                        "headers": []
                    },
                    "self": {
                        "method": "GET",
                        "uri": "/customers/ba168b29-77da-4587-b584-b3eb019d1ca2/subscriptions/623036AC-6040-4D3F-94C9-9E74C3830B21",
                        "headers": []
                    }
                },
                "attributes": {
                    "etag": "eyJpZCI6IjYyMzAzNmFjLTYwNDAtNGQzZi05NGM5LTllNzRjMzgzMGIyMSIsInZlcnNpb24iOjEzfQ==",
                    "objectType": "Subscription"
                },
                "id": "623036AC-6040-4D3F-94C9-9E74C3830B21",
                "autoRenewEnabled": true,
                "friendlyName": "Nickname",
                "status": "active"
            },
            {
                "commitmentEndDate": "2017-11-10T00:00:00Z",
                "offerName": "Customer Lockbox",
                "quantity": 3,
                "orderId": "60DF7276-F225-4A79-8111-CAD1DF5E4FA3",
                "contractType": "subscription",
                "creationDate": "2016-10-18T11:12:26.38Z",
                "unitType": "Licenses",
                "billingType": "license",
                "suspensionReasons": [
                    "CustomerCancellation"
                ],
                "billingCycle": "monthly",
                "effectiveStartDate": "2016-10-18T00:00:00Z",
                "offerId": "68F6373C-31CB-43F0-BFAA-85F3688F8CFB",
                "links": {
                    "offer": {
                        "method": "GET",
                        "uri": "/offers/68F6373C-31CB-43F0-BFAA-85F3688F8CFB?country=DE",
                        "headers": []
                    },
                    "parentSubscription": {
                        "method": "GET",
                        "uri": "/subscriptions?key=L2N1c3RvbWVycy9iYTE2OGIyOS03N2RhLTQ1ODctYjU4NC1iM2ViMDE5ZDFjYTIvc3Vic2NyaXB0aW9ucy82MjMwMzZBQy02MDQwLTREM0YtOTRDOS05RTc0QzM4MzBCMjE=",
                        "headers": []
                    },
                    "self": {
                        "method": "GET",
                        "uri": "/customers/ba168b29-77da-4587-b584-b3eb019d1ca2/subscriptions/7266DF72-4448-4936-AD30-B8ECEA92B954",
                        "headers": []
                    }
                },
                "attributes": {
                    "etag": "eyJpZCI6IjcyNjZkZjcyLTQ0NDgtNDkzNi1hZDMwLWI4ZWNlYTkyYjk1NCIsInZlcnNpb24iOjE4fQ==",
                    "objectType": "Subscription"
                },
                "id": "7266DF72-4448-4936-AD30-B8ECEA92B954",
                "autoRenewEnabled": true,
                "friendlyName": "",
                "parentSubscriptionId": "623036AC-6040-4D3F-94C9-9E74C3830B21",
                "status": "suspended"
            },
            {
                "commitmentEndDate": "2017-11-10T00:00:00Z",
                "offerName": "Yammer Enterprise",
                "quantity": 3,
                "orderId": "BFC0BE0E-B3CA-4D88-B3A0-E3D7F97A4AD6",
                "contractType": "subscription",
                "creationDate": "2016-10-21T11:48:56.757Z",
                "unitType": "Licenses",
                "billingType": "license",
                "billingCycle": "monthly",
                "effectiveStartDate": "2016-10-21T00:00:00Z",
                "offerId": "A3F4AB4E-6239-4ECB-A859-77369DCA1C08",
                "links": {
                    "offer": {
                        "method": "GET",
                        "uri": "/offers/A3F4AB4E-6239-4ECB-A859-77369DCA1C08?country=DE",
                        "headers": []
                    },
                    "self": {
                        "method": "GET",
                        "uri": "/customers/ba168b29-77da-4587-b584-b3eb019d1ca2/subscriptions/2FCB8ACC-1F85-49A1-AA2F-F8D614E40764",
                        "headers": []
                    }
                },
                "attributes": {
                    "etag": "eyJpZCI6IjJmY2I4YWNjLTFmODUtNDlhMS1hYTJmLWY4ZDYxNGU0MDc2NCIsInZlcnNpb24iOjMxfQ==",
                    "objectType": "Subscription"
                },
                "id": "2FCB8ACC-1F85-49A1-AA2F-F8D614E40764",
                "autoRenewEnabled": true,
                "friendlyName": "Yammer Enterprise",
                "status": "active"
            }
        ],
        "attributes": {
            "objectType": "Collection"
        }
    }
}

Get User Licenses

Input and output JSON for the Get User Licenses operation

This section illustrates the Flintbit Input and output for Get User Licenses operations.

Sample Input JSON for the Get User Licenses operations
{
    "connector-name":"office365",
    "customer-id":"bd168b29-77da-4587-b584-b3cb019d1ca2",
    "user-id":["2e7acb5d-bb34-4815-8040-9b88342a920b "]
}
Flintbit input elements for the Get User Licenses operation
ParameterDescriptionRequired
connector_nameName of the OFFICE365 Connector to be configured.true
actionOperation to be performedtrue
customer-idMicrosoft-id associated to the customertrue
user-id

Microsoft-id associated to the user belong to provided customer-id

true
Sample JSON output for the Get User Licenses operations
{
    "result": {
        "totalCount": 1,
        "items": [
            {
                "servicePlans": [
                    {
                        "capabilityStatus": "Assigned",
                        "targetType": "User",
                        "id": "7547a3fe-08ee-4ccb-b430-5077c5041653",
                        "serviceName": "YAMMER_ENTERPRISE",
                        "displayName": "Yammer Enterprise"
                    }
                ],
                "productSku": {
                    "name": "Yammer Enterprise Standalone",
                    "skuPartNumber": "YAMMER_ENTERPRISE_STANDALONE",
                    "id": "1c04cf66-908f-427c-b926-8678f550c87c"
                },
                "attributes": {
                    "objectType": "License"
                },
                "user-account-id": "2f7acb5d-bb34-4815-8040-9b88342a920b ",
                "licenseId": "1c04cf66-908f-427c-b926-8678f550c87c",
                "customer-id": "bc368b29-77db-4587-b584-b3vb019d1ca2"
            }
        ],
        "attributes": {
            "objectType": "Collection"
        }
    }
}

Get Customer Roles

Input and output JSON for the Get Customer Roles operation

This section illustrates the Flintbit Input and output for Get Customer Roles operations.

Sample Input JSON for the Get Customer Roles operations
{
    "connector-name":"office365",
    "customer-id":"bw158b29-77da-4587-b584-b3rc019d1ca2",
    "user-id":"2h7dcb5d-bb34-4815-8040-5c88342a920b "
}
Flintbit input elements for the Get Customer Roles operation
 ParameterDescriptionRequired
connector_nameName of the OFFICE365 Connector to be configured.true
actionOperation to be performedtrue
customer-idMicrosoft-id associated to the customertrue
user-id

Microsoft-id associated to the user belong to provided customer-id

true
Sample JSON output for the Get Customer Roles operations
    "result::": {
        "action": "get-customer-roles",
        "attributes": {
            "objectType": "Collection"
        },
        "totalCount": 1,
        "items": [
            {
                "name": "Company Administrator",
                "attributes": {
                    "objectType": "DirectoryRole"
                },
                "id": "62e90394-69f5-5679-9190-012177145e10"
            }
        ],
        "customer-id": "bd158c29-77da-4587-b584-b3wc019g1ca2"
    }
}

Get Available Licenses

Input and output JSON for the Get Available Licenses operation

This section illustrates the Flintbit Input and output for Get Available Licenses operations.

Sample Input JSON for the Get Available Licenses operations
{
    "connector-name":"office365",
    "customer-id":"bw158b29-77da-4587-b584-b3rc019d1ca2"
}

Flintbit input elements for the Get Available Licenses operation
 ParameterDescriptionRequired
connector_nameName of the OFFICE365 Connector to be configured.true
actionOperation to be performedtrue
customer-idMicrosoft-id associated to the customertrue
Sample JSON output for the Get Available Licenses operations
{
    "result::": {
        "totalCount": 8,
        "items": [
            {
                "consumedUnits": 0,
                "availableUnits": 0,
                "productSku": {
                    "name": "Skype for Business Plus CAL",
                    "skuPartNumber": "MCOPLUSCAL",
                    "targetType": "Tenant",
                    "id": "d461b05e-e3d6-49c7-9780-58d4e83366af"
                },
                "suspendedUnits": 1,
                "customer-id": "be168b29-77da-4587-b584-b3db019d1ca2",
                "warningUnits": 0,
                "capabilityStatus": "Enabled",
                "action": "get-available-licenses",
                "servicePlans": [],
                "attributes": {
                    "objectType": "SubscribedSku"
                },
                "activeUnits": 0,
                "totalUnits": 0
            },
            {
                "consumedUnits": 0,
                "availableUnits": 1,
                "productSku": {
                    "name": "Delve Analytics",
                    "skuPartNumber": "EXCHANGE_ANALYTICS",
                    "targetType": "User",
                    "id": "90a8f363-da30-4ecd-90a7-d3a6b203486d"
                },
                "suspendedUnits": 0,
                "customer-id": "bd168b29-77da-4587-b584-b3cb019d1ca2",
                "warningUnits": 0,
                "capabilityStatus": "Enabled",
                "action": "get-available-licenses",
                "servicePlans": [],
                "attributes": {
                    "objectType": "SubscribedSku"
                },
                "activeUnits": 1,
                "totalUnits": 1
            },
            {
                "consumedUnits": 3,
                "availableUnits": 0,
                "productSku": {
                    "name": "Yammer Enterprise Standalone",
                    "skuPartNumber": "YAMMER_ENTERPRISE_STANDALONE",
                    "targetType": "User",
                    "id": "1c04cf66-908f-427c-b926-8678f550c87c"
                },
                "suspendedUnits": 0,
                "customer-id": "bd168b29-77da-4587-b584-b3cb019d1ca2",
                "warningUnits": 0,
                "capabilityStatus": "Enabled",
                "action": "get-available-licenses",
                "servicePlans": [],
                "attributes": {
                    "objectType": "SubscribedSku"
                },
                "activeUnits": 3,
                "totalUnits": 3
            },
            {
                "consumedUnits": 0,
                "availableUnits": 0,
                "productSku": {
                    "name": "Customer Lockbox",
                    "skuPartNumber": "LOCKBOX",
                    "targetType": "User",
                    "id": "4ae93e69-85d1-4d0f-a6f7-fc0bc62f44ef"
                },
                "suspendedUnits": 3,
                "customer-id": "bd168b29-77da-4587-b584-b3cb019d1ca2",
                "warningUnits": 0,
                "capabilityStatus": "Enabled",
                "action": "get-available-licenses",
                "servicePlans": [],
                "attributes": {
                    "objectType": "SubscribedSku"
                },
                "activeUnits": 0,
                "totalUnits": 0
            },
            {
                "consumedUnits": 1,
                "availableUnits": 0,
                "productSku": {
                    "name": "Azure Active Directory Basic",
                    "skuPartNumber": "AAD_BASIC",
                    "targetType": "User",
                    "id": "2b9c8e7c-319c-43a2-a2a0-48c5c6161de7"
                },
                "suspendedUnits": 0,
                "customer-id": "bd168b29-77da-4587-b584-b3cb019d1ca2",
                "warningUnits": 0,
                "capabilityStatus": "Enabled",
                "action": "get-available-licenses",
                "servicePlans": [],
                "attributes": {
                    "objectType": "SubscribedSku"
                },
                "activeUnits": 1,
                "totalUnits": 1
            },
            {
                "consumedUnits": 0,
                "availableUnits": 1,
                "productSku": {
                    "name": "Dynamics 365 Plan 1 Enterprise Edition",
                    "skuPartNumber": "DYN365_ENTERPRISE_PLAN1",
                    "targetType": "User",
                    "id": "ea126fc5-a19e-42e2-a731-da9d437bffcf"
                },
                "suspendedUnits": 0,
                "customer-id": "bd168b29-77da-4587-b584-b3cb019d1ca2",
                "warningUnits": 0,
                "capabilityStatus": "Enabled",
                "action": "get-available-licenses",
                "servicePlans": [
                    {
                        "capabilityStatus": "Enabled",
                        "targetType": "User",
                        "id": "0b03f40b-c404-40c3-8651-2aceb74365fa",
                        "serviceName": "POWERAPPS_DYN_P2",
                        "displayName": "PowerApps for Dynamics 365"
                    },
                    {
                        "capabilityStatus": "Enabled",
                        "targetType": "User",
                        "id": "b650d915-9886-424b-a08d-633cede56f57",
                        "serviceName": "FLOW_DYN_P2",
                        "displayName": "Flow for Dynamics 365"
                    },
                    {
                        "capabilityStatus": "Enabled",
                        "targetType": "User",
                        "id": "03acaee3-9492-4f40-aed4-bcb6b32981b6",
                        "serviceName": "NBENTERPRISE",
                        "displayName": "Microsoft Social Engagement Enterprise"
                    },
                    {
                        "capabilityStatus": "Enabled",
                        "targetType": "User",
                        "id": "e95bec33-7c88-4a70-8e19-b10bd9d0c014",
                        "serviceName": "SHAREPOINTWAC",
                        "displayName": "Office Online"
                    },
                    {
                        "capabilityStatus": "Enabled",
                        "targetType": "User",
                        "id": "5dbe027f-2339-4123-9542-606e4d348a72",
                        "serviceName": "SHAREPOINTENTERPRISE",
                        "displayName": "SharePoint Online (Plan 2)"
                    },
                    {
                        "capabilityStatus": "Enabled",
                        "targetType": "User",
                        "id": "fe71d6c3-a2ea-4499-9778-da042bf08063",
                        "serviceName": "SHAREPOINT_PROJECT",
                        "displayName": "Project Online Service"
                    },
                    {
                        "capabilityStatus": "Enabled",
                        "targetType": "User",
                        "id": "fafd7243-e5c1-4a3a-9e40-495efcb1d3c3",
                        "serviceName": "PROJECT_CLIENT_SUBSCRIPTION",
                        "displayName": "Project Online Desktop Client"
                    },
                    {
                        "capabilityStatus": "Enabled",
                        "targetType": "User",
                        "id": "d56f3deb-50d8-465a-bedb-f079817ccac1",
                        "serviceName": "DYN365_ENTERPRISE_P1",
                        "displayName": "Dynamics 365 P1"
                    }
                ],
                "attributes": {
                    "objectType": "SubscribedSku"
                },
                "activeUnits": 1,
                "totalUnits": 1
            },
            {
                "consumedUnits": 0,
                "availableUnits": 3,
                "productSku": {
                    "name": "Microsoft Office 365 Exchange Online Protection",
                    "skuPartNumber": "EOP_ENTERPRISE",
                    "targetType": "Tenant",
                    "id": "45a2423b-e884-448d-a831-d9e139c52d2f"
                },
                "suspendedUnits": 0,
                "customer-id": "bd168b29-77da-4587-b584-b3cb019d1ca2",
                "warningUnits": 0,
                "capabilityStatus": "Enabled",
                "action": "get-available-licenses",
                "servicePlans": [],
                "attributes": {
                    "objectType": "SubscribedSku"
                },
                "activeUnits": 3,
                "totalUnits": 3
            },
            {
                "consumedUnits": 2,
                "availableUnits": 0,
                "productSku": {
                    "name": "Office 365 Enterprise E1",
                    "skuPartNumber": "STANDARDPACK",
                    "targetType": "User",
                    "id": "18181a46-0d4e-45cd-891e-60aabd171b4e"
                },
                "suspendedUnits": 0,
                "customer-id": "bd168b29-77da-4587-b584-b3cb019d1ca2",
                "warningUnits": 0,
                "capabilityStatus": "Enabled",
                "action": "get-available-licenses",
                "servicePlans": [
                    {
                        "capabilityStatus": "Enabled",
                        "targetType": "User",
                        "id": "57ff2da0-773e-42df-b2af-ffb7a2317929",
                        "serviceName": "TEAMS1",
                        "displayName": "Microsoft Teams"
                    },
                    {
                        "capabilityStatus": "Enabled",
                        "targetType": "User",
                        "id": "e95bec33-7c88-4a70-8e19-b10bd9d0c014",
                        "serviceName": "SHAREPOINTWAC",
                        "displayName": "Office Online"
                    },
                    {
                        "capabilityStatus": "Enabled",
                        "targetType": "User",
                        "id": "b737dad2-2f6c-4c65-90e3-ca563267e8b9",
                        "serviceName": "PROJECTWORKMANAGEMENT",
                        "displayName": "Microsoft Planner"
                    },
                    {
                        "capabilityStatus": "Enabled",
                        "targetType": "User",
                        "id": "a23b959c-7ce8-4e57-9140-b90eb88a9e97",
                        "serviceName": "SWAY",
                        "displayName": "Sway"
                    },
                    {
                        "capabilityStatus": "PendingActivation",
                        "targetType": "Tenant",
                        "id": "882e1d05-acd1-4ccb-8708-6ee03664b117",
                        "serviceName": "INTUNE_O365",
                        "displayName": "Mobile Device Management for Office 365"
                    },
                    {
                        "capabilityStatus": "Enabled",
                        "targetType": "User",
                        "id": "7547a3fe-08ee-4ccb-b430-5077c5041653",
                        "serviceName": "YAMMER_ENTERPRISE",
                        "displayName": "Yammer Enterprise"
                    },
                    {
                        "capabilityStatus": "Enabled",
                        "targetType": "User",
                        "id": "0feaeb32-d00e-4d66-bd5a-43b5b83db82c",
                        "serviceName": "MCOSTANDARD",
                        "displayName": "Skype for Business Online (Plan 2)"
                    },
                    {
                        "capabilityStatus": "Enabled",
                        "targetType": "User",
                        "id": "c7699d2e-19aa-44de-8edf-1736da088ca1",
                        "serviceName": "SHAREPOINTSTANDARD",
                        "displayName": "SharePoint Online (Plan 1)"
                    },
                    {
                        "capabilityStatus": "Enabled",
                        "targetType": "User",
                        "id": "9aaf7827-d63c-4b61-89c3-182f06f82e5c",
                        "serviceName": "EXCHANGE_S_STANDARD",
                        "displayName": "Exchange Online (Plan 1)"
                    }
                ],
                "attributes": {
                    "objectType": "SubscribedSku"
                },
                "activeUnits": 1,
                "totalUnits": 1
            }
        ],
        "attributes": {
            "objectType": "Collection"
        }
    }
} 

List Subscription Add-Ons

Input and output JSON for the List Subscription Add-Ons operation

This section illustrates the Flintbit Input and output for List Subscription Add-Ons operations.

Sample Input JSON for the List Subscription Add-Ons operations
{
    "connector-name":"office365",
    "customer-id":"ba168b29-77da-4587-b584-b3eb019d1ca2",
    "id-for-subscription":"623036AC-6040-4D3F-94C9-9E74C3830B21"
}
Flintbit input elements for the List Subscription Add-Ons operation
 ParameterDescriptionRequired
connector_nameName of the OFFICE365 Connector to be configured.true
actionOperation to be performedtrue
customer-idMicrosoft-id associated to the customertrue
Sample JSON output for the List Subscription Add-Ons operations
{
    "result::": {
        "totalCount": 3,
        "items": [
            {
                "commitmentEndDate": "2017-11-10T00:00:00Z",
                "offerName": "Skype for Business Plus CAL",
                "quantity": 1,
                "orderId": "60DF7276-F225-4A79-8111-CAD1DF5E4FA3",
                "contractType": "subscription",
                "creationDate": "2016-10-18T11:12:26.417Z",
                "unitType": "Instances",
                "billingType": "license",
                "suspensionReasons": [
                    "CustomerCancellation"
                ],
                "customer-id": "ba168b29-77da-4587-b584-b3eb019d1ca2",
                "billingCycle": "monthly",
                "effectiveStartDate": "2016-10-18T00:00:00Z",
                "offerId": "FC233C3F-25BC-4BBA-8984-860CE561AF86",
                "action": "list-subscription-add-ons",
                "links": {
                    "offer": {
                        "method": "GET",
                        "uri": "/offers/FC233C3F-25BC-4BBA-8984-860CE561AF86?country=DE",
                        "headers": []
                    },
                    "parentSubscription": {
                        "method": "GET",
                        "uri": "/customers/ba168b29-77da-4587-b584-b3eb019d1ca2/subscriptions/623036AC-6040-4D3F-94C9-9E74C3830B21",
                        "headers": []
                    },
                    "self": {
                        "method": "GET",
                        "uri": "/customers/ba168b29-77da-4587-b584-b3eb019d1ca2/subscriptions/150CFF30-BEB2-46C6-B584-53541041E962",
                        "headers": []
                    }
                },
                "attributes": {
                    "etag": "eyJpZCI6IjE1MGNmZjMwLWJlYjItNDZjNi1iNTg0LTUzNTQxMDQxZTk2MiIsInZlcnNpb24iOjJ9",
                    "objectType": "Subscription"
                },
                "id": "150CFF30-BEB2-46C6-B584-53541041E962",
                "autoRenewEnabled": true,
                "friendlyName": "",
                "parentSubscriptionId": "623036AC-6040-4D3F-94C9-9E74C3830B21",
                "status": "suspended"
            },
            {
                "commitmentEndDate": "2017-11-10T00:00:00Z",
                "offerName": "Delve Analytics",
                "quantity": 1,
                "orderId": "60DF7276-F225-4A79-8111-CAD1DF5E4FA3",
                "contractType": "subscription",
                "creationDate": "2016-11-16T09:59:23.033Z",
                "unitType": "Licenses",
                "billingType": "license",
                "customer-id": "ba168b29-77da-4587-b584-b3eb019d1ca2",
                "billingCycle": "monthly",
                "effectiveStartDate": "2016-11-16T00:00:00Z",
                "offerId": "45320EC9-9B8E-49D0-B900-F14141A0ABD1",
                "action": "list-subscription-add-ons",
                "links": {
                    "offer": {
                        "method": "GET",
                        "uri": "/offers/45320EC9-9B8E-49D0-B900-F14141A0ABD1?country=DE",
                        "headers": []
                    },
                    "parentSubscription": {
                        "method": "GET",
                        "uri": "/customers/ba168b29-77da-4587-b584-b3eb019d1ca2/subscriptions/623036AC-6040-4D3F-94C9-9E74C3830B21",
                        "headers": []
                    },
                    "self": {
                        "method": "GET",
                        "uri": "/customers/ba168b29-77da-4587-b584-b3eb019d1ca2/subscriptions/3147B7C8-B4CD-4739-9723-93AAF0897E85",
                        "headers": []
                    }
                },
                "attributes": {
                    "etag": "eyJpZCI6IjMxNDdiN2M4LWI0Y2QtNDczOS05NzIzLTkzYWFmMDg5N2U4NSIsInZlcnNpb24iOjF9",
                    "objectType": "Subscription"
                },
                "id": "3147B7C8-B4CD-4739-9723-93AAF0897E85",
                "autoRenewEnabled": true,
                "friendlyName": "",
                "parentSubscriptionId": "623036AC-6040-4D3F-94C9-9E74C3830B21",
                "status": "active"
            },
            {
                "commitmentEndDate": "2017-11-10T00:00:00Z",
                "offerName": "Customer Lockbox",
                "quantity": 3,
                "orderId": "60DF7276-F225-4A79-8111-CAD1DF5E4FA3",
                "contractType": "subscription",
                "creationDate": "2016-10-18T11:12:26.38Z",
                "unitType": "Licenses",
                "billingType": "license",
                "suspensionReasons": [
                    "CustomerCancellation"
                ],
                "customer-id": "ba168b29-77da-4587-b584-b3eb019d1ca2",
                "billingCycle": "monthly",
                "effectiveStartDate": "2016-10-18T00:00:00Z",
                "offerId": "68F6373C-31CB-43F0-BFAA-85F3688F8CFB",
                "action": "list-subscription-add-ons",
                "links": {
                    "offer": {
                        "method": "GET",
                        "uri": "/offers/68F6373C-31CB-43F0-BFAA-85F3688F8CFB?country=DE",
                        "headers": []
                    },
                    "parentSubscription": {
                        "method": "GET",
                        "uri": "/customers/ba168b29-77da-4587-b584-b3eb019d1ca2/subscriptions/623036AC-6040-4D3F-94C9-9E74C3830B21",
                        "headers": []
                    },
                    "self": {
                        "method": "GET",
                        "uri": "/customers/ba168b29-77da-4587-b584-b3eb019d1ca2/subscriptions/7266DF72-4448-4936-AD30-B8ECEA92B954",
                        "headers": []
                    }
                },
                "attributes": {
                    "etag": "eyJpZCI6IjcyNjZkZjcyLTQ0NDgtNDkzNi1hZDMwLWI4ZWNlYTkyYjk1NCIsInZlcnNpb24iOjE4fQ==",
                    "objectType": "Subscription"
                },
                "id": "7266DF72-4448-4936-AD30-B8ECEA92B954",
                "autoRenewEnabled": true,
                "friendlyName": "",
                "parentSubscriptionId": "623036AC-6040-4D3F-94C9-9E74C3830B21",
                "status": "suspended"
            }
        ],
        "attributes": {
            "objectType": "Collection"
        }
    }
}

 

List Offer Id Add-Ons

Input and output JSON for the List Subscription Add-Ons operation

This section illustrates the Flintbit Input and output for List Subscription Add-Ons operations.

Sample Input JSON for the List Subscription Add-Ons operations
{
    "connector-name":"office365",
    "offer-id":"0CCA44D6-68E9-4762-94EE-31ECE98783B9",
    "country":"DE"
}

Flintbit input elements for the List Offer-id Add-Ons operation
 ParameterDescriptionRequired
connector_nameName of the OFFICE365 Connector to be configured.true
actionOperation to be performedtrue
offer-idA ID corresponding to the Offer.true
countryA ID corresponding to the Country(ISO2 code).true
Sample JSON output for the List Offer-id Add-Ons operations
{
    "result::": {
        "action": "list-offer-id-add-ons",
        "attributes": {
            "objectType": "Collection"
        },
        "totalCount": 0,
        "offer-id": "0CCA44D6-68E9-4762-94EE-31ECE98783B9",
        "items": []
    }
}

Create Customer

To Create a new customer.

Input and output JSON for the Create Customer operation

This section illustrates the Flintbit Input and output for Create Customer operations.

Sample Input JSON for the Create Customer operations
{
    "connector-name":"office365",
    "customer-id":"bq168b29-77da-4577-b584-b3wb019d1ca2",
    "billing-fisrt-name":"zzztest",
    "billing-last-name":"testzzz",
    "email":"zzz@gmail.com",
    "culture":"EN-US",
    "language":"En",
    "company-name":"CompanyName",
    "country":"DE",
    "city":"Berlin",
    "State":"Berlin",
    "address-line1":"1 Microsoft Way",
    "postal-code":"98052",
    "phone-number":"4255555555",
    "first-name":"samule",
    "last-name":"jorge",
    "domain":"test331234.onmicrosoft.com"
    
}
Flintbit input elements for the Create Customer operation
 ParameterDescriptionRequired
connector_nameName of the OFFICE365 Connector to be configured.true
actionOperation to be performedtrue
microsoft-idMicrosoft-id associated to the customertrue
billing-first-nameThe first name.false
billing-last-nameThe surname.false
emailThe email address.true
cultureThe default local (e.g., en-US).true
language
The default language; 2 char language codes, (e.g., en, fr) are supportedtrue
State
The region of the address, often a state or province.true
country
The country code uses ISO2, 2-digit format.true
city
The city.true
address-line1
The first line of the address.true
address-line2
The second line of the address.false
address-line3
The third line of the address.false
postal-code
The postal code or ZIP code.true
phone-number
The phone number.flase
first-name
The given name of the addressee.true
last-name
The surname of the addressee.true
domain
The company profile information that represents the customer you wish to create.true
company-name
The registered company/organization name.true
Sample JSON output for the Create Customer operations
{
    "result::": {
        "customer-id": "bq168b29-77da-4577-b584-b3wb019d1ca2",
        "billingProfile": {
            "culture": "en-US",
            "companyName": "CompanyName",
            "language": "En",
            "attributes": {
                "etag": "-777677716382459585",
                "objectType": "CustomerBillingProfile"
            },
            "id": "2c8eb1c6-9f79-5f33-6ff0-c15095766fdf",
            "email": "zzz@gmail.com",
            "defaultAddress": {
                "country": "DE",
                "firstName": "samule",
                "lastName": "jorge",
                "city": "Berlin",
                "postalCode": "98052",
                "addressLine1": "1 Microsoft Way",
                "state": "Berlin"
            }
        },
        "relationshipToPartner": "none",
        "userCredentials": {
            "userName": "admin",
            "password": "6H9um-4V"
        },
        "action": "create-customer",
        "attributes": {
            "objectType": "Customer"
        },
        "id": "bac64344-ccd6-43f2-89de-11cc26f89174",
        "companyProfile": {
            "tenantId": "bac64344-ccd6-43f2-89de-11cc26f89174",
            "attributes": {
                "objectType": "CustomerCompanyProfile"
            },
            "domain": "mes22si.onmicrosoft.com"
        },
        "commerceId": "1a1b4fd7-bffc-4639-920f-7eb3c4684b99"
    }
}

Create Order

To Create an order for a customer.

Input and output JSON for the Create Order operation

This section illustrates the Flintbit Input and output for Create Order operations.

Sample Input JSON for the Create Order operations
{
    "connector-name":"office365",
    "customer-id":"ba168b29-77da-4587-b584-b3eb019d1ca2",
    "line-item-number":"0",
    "offer-id":"0CCA44D6-68E9-4762-94EE-31ECE98783B9",
    "friendly-name":"Nickname",
    "quantity": 1
}
Flintbit input elements for the Create Order operation
ParameterDescriptionRequired
connector_nameName of the OFFICE365 Connector to be configured.true
actionOperation to be performedtrue
microsoft-idMicrosoft-id associated to the customertrue
line-item-number -false
offer-idA ID corresponding to the Offer.true
friendly-nameThe friendly namefalse
quantity Quantity of the orderfalse
Sample JSON output for the Create Order operations
{
    "result::": {
        "lineItems": [
            {
                "offerId": "0CCA44D6-68E9-4762-94EE-31ECE98783B9",
                "links": {
                    "subscription": {
                        "method": "GET",
                        "uri": "/customers/wa168b29-77da-4587-v584-b3rb019d1ca2/subscriptions/EC9E9FB9-F751-4802-9B02-2CE396BB7B8A",
                        "headers": []
                    }
                },
                "quantity": 1,
                "subscriptionId": "EC9E9FB9-F751-4802-9B02-2CE396BB7B8A",
                "lineItemNumber": 0,
                "friendlyName": "Nickname"
            }
        ],
        "customer-id": "wa168b29-77da-4587-v584-b3rb019d1ca2",
        "billingCycle": "monthly",
        "action": "create-order",
        "links": {
            "self": {
                "method": "GET",
                "uri": "/customers/ba168b29-77da-4587-b584-b3eb019d1ca2/orders/8d8843c9-ed9e-4a13-a420-61ece19bf78e",
                "headers": []
            }
        },
        "attributes": {
            "etag": "eyJpZCI6IjhkODg0M2M5LWVkOWUtNGExMy1hNDIwLTYxZWNlMTliZjc4ZSIsInZlcnNpb24iOjF9",
            "objectType": "Order"
        },
        "id": "8d8843c9-ed9e-4a13-a420-61ece19bf78e",
        "creationDate": "2016-11-15T22:34:57.377-08:00",
        "referenceCustomerId": "wa168b29-77da-4587-v584-b3rb019d1ca2"
    }
}

Reset user account password

Resetting a password of an existing user account for your customer.

Input and output JSON for the Reset user account password operation

This section illustrates the Flintbit Input and output for Reset user account password operations.

Request parameters
ParameterDescriptionRequired
connector_nameName of the OFFICE365 Connector to be configured.true
actionOperation to be performedtrue
microsoft-idMicrosoft-id associated to the customertrue
user-id Microsoft-id associated to the user belong to provided customer-idtrue
user-passwordNew password to resettrue
friendly-force-change-passwordIt's a boolean field, Make it 'true' to reset passwordtrue
Sample JSON output for the Reset user account password operations
{
    "result::": {
        "firstName": "xyz",
        "lastName": "test",
        "customer-id": "wa168b29-77da-4587-v584-b3rb019d1ca2",
        "displayName": "flintautomation",
        "action": "reset-user-account-password",
        "links": {
            "self": {
                "method": "GET",
                "uri": "/customers/bE168b29-77ba-4587-b554-b3cb019d1ca2/users/2f7acb5d-bb34-4815-8140-9b88342a920b",
                "headers": []
            }
        },
        "attributes": {
            "objectType": "CustomerUser"
        },
        "usageLocation": "AT",
        "id": "2f7acb5d-bb34-4815-8140-9b88342a920b",
        "state": "active",
        "userDomainType": "none",
        "userPrincipalName": "admin@domain.onmicrosoft.com"
    }
}
  • No labels