記事一覧 >
ブログ記事

Dataverse

Dataverse APIでsystemuserテーブルにAzure ADユーザーを同期

2022年10月27日 (更新)2022年10月27日 (公開)

Dataverse,Power Platform,Power Apps,Azure

はじめに

Microsoft Dataverse の systemuser テーブルに Azure AD ユーザーを同期しました。ユーザーが Dataverse（Power Apps）を使い始めたりすると、自動で同期するようですが、API でなんとかならないか、Postman を使って探ってみましたところ、なんとかなりましたので、紹介していきたいと思います。

systemuser テーブルに Azure AD ユーザーを同期するだけの場合、Power Platform 管理センターから手動、Power Automate、Power Apps、Power Shell といろいろやり方が有るようでしたが、今回は、Microsoft Dataverse Web API で同期の方法 の話です。

Postman や Azure 準備手順については、前回記事、「Postmanを使ってMicrosoft Dataverse Web APIで部署を追加」にありますので、省略します。Postman インストール、アクセストークン準備済みとします。Azure Active Directory へのアプリ登録済みとします。

Dataverse 等の状況は、2022年10月現在の状況を元にしています。

やり方

なんと！
一行で終了します！

GET [Organization URI]/api/data/v9.2/systemusers(azureactivedirectoryobjectid=<user object ID>)
例：GET https://***********.api.crm*.dynamics.com/api/data/v9.2/systemusers(azureactivedirectoryobjectid=c74a8***-****-****-****-*******abb78)

だけです。POST ではなく、GET です。

<user object ID> は、Azure Active Directory のユーザーのオブジェクト ID です。これに当たる人が Dataverse の ユーザー テーブル（ systemuser テーブル）にまだ登録されていない場合、登録されます。
既に登録されている場合、その人の systemuser テーブルのレコード情報を返します。

・<user object ID> 確認方法

・[Organization URI] 確認方法

ググりまくっても、なかなか分からず、API では、できないかと思いましたが、
learn.microsoft.com にサラっと書いてありました。

「Azure Active Directory グループのチームとの連携」（https://learn.microsoft.com/ja-jp/power-apps/developer/data-platform/aad-group-team）

「Azure ユーザーオブジェクト識別子 (ID) を使用してユーザー行を取得できます。ユーザーが Dataverse に存在しない場合、ユーザーが Dataverse に自動的に追加されます。」
↑
全く間違ったことを言っていないですが、あまりにもサラっと書いてあるので、別の話と思い、スルーしていました。

GET [Organization URI]/api/data/v9.0/SystemUser(azureactivedirectoryobjectid=<user object ID>)

は、2022年10月時点では、誤植のようです。

GET [Organization URI]/api/data/v9.2/systemusers(azureactivedirectoryobjectid=<user object ID>)

でうまくいきました。

英語版も同じでした。（https://learn.microsoft.com/en-us/power-apps/developer/data-platform/aad-group-team）

結果

PowerApps - Dataverse ユーザー テーブル（ systemuser テーブル）に以下のように登録されます。

GET https://***********.api.crm*.dynamics.com/api/data/v9.2/systemusers(azureactivedirectoryobjectid=c74a8***-****-****-****-*******abb78)

↓

PowerApps - Dataverse ユーザー テーブル（ systemuser テーブル）に挿入されていることを確認できました。

表示列は適当に選別しました。

PATCH

登録したら、所属部署等は、PATCH リクエストで適宜登録情報を変更できます。

PATCH https://***********.api.crm*.dynamics.com/api/data/v9.2/systemusers(azureactivedirectoryobjectid=c74a8***-****-****-****-*******abb78)

リクエストBody

{
    "lastname": "テスト",
    "firstname": "太郎",
    "address1_telephone1": "090-0000-0000",
    "businessunitid@odata.bind": "/businessunits(c74a8***-****-****-****-*******abb78)"
}

Dataverse ユーザー テーブル（ systemuser テーブル）は、以下のようになります。

Azure Active Directory - <テナント> - ユーザーには反映されません。

DELETE

削除することもできました。

いきなり削除しようとすると、以下のエラーになりますので、いったん、状態 列（ isdisabled 列）を true にする必要があります。

error

{
    "error": {
        "code": "0x80048356",
        "message": "User with SystemUserId=020fc***-****-****-****-*******279c8 is not disabled. Disable user before deletion.\""
    }
}

PATCH https://***********.api.crm*.dynamics.com/api/data/v9.2/systemusers(azureactivedirectoryobjectid=c74a8***-****-****-****-*******abb78)

リクエストBody

{
    "isdisabled": true
}

これで、削除できると思いましたが、まだ問題ありです。Azure Active Directory - <テナント> - ユーザーの方を先に削除してくださいと言ってきます。

error

{
    "error": {
        "code": "0x80048359",
        "message": "User with SystemUserId=020fc***-****-****-****-*******279c8 and AzureActiveDirectoryObjectId=c74a8***-****-****-****-*******abb78 is present in Azure Active Directory with state Exists. Please permanently delete user in Azure first."
    }
}

無効にしたのだから、実質消えたようなものですが、なにがなんでも削除したい場合、Azure Active Directory - <テナント> - ユーザーの方を先に削除すると、Dataverse ユーザー テーブル（ systemuser テーブル）から削除できました。
指示通り、Azure Active Directory - <テナント> - ユーザーの方を先に削除してもまだダメでした。

error

{
    "error": {
        "code": "0x80048359",
        "message": "User with SystemUserId=020fc***-****-****-****-*******279c8 and AzureActiveDirectoryObjectId=c74a8***-****-****-****-*******abb78 is present in Azure Active Directory with state SoftDeleted. Please permanently delete user in Azure first."
    }
}

完全に削除が必要でした。

DELETE https://***********.api.crm*.dynamics.com/api/data/v9.2/systemusers(azureactivedirectoryobjectid=c74a8***-****-****-****-*******abb78)

Dataverse ユーザー テーブル（ systemuser テーブル）から消えます。

<user object ID> 確認方法

方法その１

PowerApps - Dataverse AAD User テーブル（ aaduser テーブル）で確認できます。

A unique identifer for AAD User 列（ id 列） AAD user id 列（ aaduserid 列）が <user object ID> に該当します。

方法その２

API で Get して確認できます。
GET https://***********.api.crm*.dynamics.com/api/data/v9.2/aadusers?$select=displayname

Response例

{
    "@odata.context": "https://***********.api.crm*.dynamics.com/api/data/v9.2/$metadata#aadusers(displayname)",
    "value": [
        {
            "displayname": "te st2",
            "aaduserid": "********-****-****-****-************"
        },
        {
            "displayname": "Test User1",
            "aaduserid": "c74a8***-****-****-****-*******abb78"
        },
        {
            "displayname": "test1",
            "aaduserid": "********-****-****-****-************"
        }
    ]
}

あるいは、ユーザープリンシパル ID（サインイン ID）が分かっている場合、以下のようにもできます。

GET https://***********.api.crm*.dynamics.com/api/data/v9.2/aadusers?$select=aaduserid&$filter=userprincipalname eq 'testuser1@example.onmicrosoft.com'

Response例

{
    "@odata.context": "https://***********.api.crm*.dynamics.com/api/data/v9.2/$metadata#aadusers(aaduserid)",
    "value": [
        {
            "aaduserid": "c74a8***-****-****-****-*******abb78"
        }
    ]
}

方法その３

Azure ポータル → Azure Active Directory → ユーザー → <該当ユーザー>
の オブジェクト ID で確認できます。

[Organization URI] 確認方法

Power Apps 右上の歯車 → 開発者リソース → Web API エンドポイント に表示される URL です。