[英]MS Graph SDK How to Add/Update a Schema Extension property to a User object
我很难找到有关如何在 Azure AD 中针对用户添加架构扩展值的任何代码示例。
到目前为止,我已经成功创建了自己的架构扩展,标记为“用户”TargetType,并将状态更新为“可用”。 这一切都是通过 MS Graph SDK 实现的
下面是一个屏幕截图,显示了我在我的应用程序中创建并列出的扩展程序:
这个扩展非常基本,只有一个名为“name”的属性被设置为字符串类型。
我现在要执行以下功能:
MS Docs 给出的唯一示例是使用 MS Graph API,而不是我在我的应用程序中使用的 SDK。 此外,他们给出的唯一示例是在创建新组时添加模式扩展。
https://docs.microsoft.com/en-us/graph/extensibility-schema-groups
在他们的笔记中,MS 说了以下内容:注意:本主题向您展示如何在组资源上创建和读取架构扩展值(步骤 3-5)。 管理单元、设备、事件、消息、组织、帖子和用户资源类型也支持相同的方法。 您可以对任何这些资源执行与本文中的请求示例类似的操作。
有人可以建议我从哪里获得代码示例,该示例允许我使用此扩展创建/更新用户,以及对我的租户中的所有用户使用过滤搜索,这些用户在他们的个人资料中为此特定扩展设置了特定值?
更新:结合 Allen Wu 在下面的答案中的讨论,我已经实现了他的代码示例,在创建新用户时将模式扩展添加为“AdditionalData”。 我还没有设法让它工作,因为我收到一条错误消息“代码:BadRequest\r\nMessage: Unsupported Schema Extension Property value of type String\r\nInner error:\r\n\tAdditionalData:\r\n\tdate : 2021-03-31T18:51:32\r\n\trequest-id "
使用架构扩展创建新用户的代码示例:
var user = new User();
user.UserPrincipalName = TenantUser.UserPrincipalName + "@" + Domain; // * Required
//user.UserPrincipalName = TenantUser.UserPrincipalName; // * Required
user.DisplayName = TenantUser.GivenName + " " + TenantUser.Surname; // * Required
user.GivenName = TenantUser.GivenName; // * Required
user.Surname = TenantUser.Surname; // * Required
if (TenantUser.Password != null)
{
if (TenantUser.Password != TenantUser.ConfirmPassword)
{
ModelState.AddModelError(string.Empty, "\n Passwords do not match!");
return Page();
}
else
{
user.PasswordProfile = new PasswordProfile
{
Password = TenantUser.ConfirmPassword,
};
}
}
user.AccountEnabled = AccountEnabled;
user.JobTitle = TenantUser.JobTitle;
user.Department = TenantUser.Department;
user.EmployeeId = TenantUser.EmployeeId;
user.OfficeLocation = TenantUser.OfficeLocation;
user.CompanyName = TenantUser.CompanyName;
user.StreetAddress = TenantUser.StreetAddress;
user.State = TenantUser.State;
user.City = TenantUser.City;
user.PostalCode = TenantUser.PostalCode;
user.Country = TenantUser.Country;
user.MobilePhone = TenantUser.MobilePhone; // * Required
if (BusinessPhone != null)
{
user.BusinessPhones = new List<String>()
{
BusinessPhone // see public string
};
}
user.Mail = TenantUser.Mail; // * Required
user.MailNickname = TenantUser.MailNickname;
user.AdditionalData = new Dictionary<string, object>()
{
{"ext7bxc3e0l_appRoleTemplate", "{\"name\":\"Template1\"}"}
};
try
{
await graphClient.Users
.Request()
.AddAsync(user);
LogData = "New User with name [" + UserFullName + "] created by user with forename [" + currentUser.Forename + "] surname [" + currentUser.Surname + "] Succesfully";
// See helper method at bottom.
logExtension.WriteLogEvent<EditModel>("Information", "Users", "Created", UserFullName, currentUser.Id, currentUser.Username, currentUser.Forename, currentUser.Surname, LogData, null, _scopeFactory);
}
catch (ServiceException ex)
{
// Graph service exception friendly message
var errorMessage = ex.Error.Message;
LogData = " Error creating the User. Microsoft Graph API encountered a Service Exception with message [" + errorMessage + "]'";
logExtension.WriteLogEvent<EditModel>("Error", "User", "Created", $"User with Id = {currentUser.Id}", currentUser.Id, currentUser.Username, currentUser.Forename, currentUser.Surname, LogData, null, _scopeFactory);
ModelState.AddModelError(string.Empty, errorMessage + " Error creating the User.\n Please check the system logs for details");
return Page();
}
我创建了一个架构扩展:
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#schemaExtensions/$entity",
"id": "ext253rtfdu_name",
"description": "user name extensions",
"targetTypes": [
"User"
],
"status": "InDevelopment",
"properties": [
{
"name": "userId",
"type": "String"
},
{
"name": "userName",
"type": "String"
},
{
"name": "userType",
"type": "String"
}
]
}
创建一个带有ext253rtfdu_name
模式扩展的用户:
GraphServiceClient graphClient = new GraphServiceClient(authProvider);
string extStr = "{\"userId\":\"321\",\"userName\":\"Adele test02\",\"userType\":\"member\"}";
JObject jsonObj = JObject.Parse(extStr);
var user = new User
{
AccountEnabled = true,
DisplayName = "Adele test01",
MailNickname = "AdeleVtest01",
UserPrincipalName = "AdeleVtest01@contoso.onmicrosoft.com",
PasswordProfile = new PasswordProfile
{
ForceChangePasswordNextSignIn = true,
Password = "password-value"
},
AdditionalData = new Dictionary<string, object>()
{
{"ext253rtfdu_name", extStr}
}
};
await graphClient.Users
.Request()
.AddAsync(user);
更新用户:
GraphServiceClient graphClient = new GraphServiceClient(authProvider);
string extStr = "{\"userId\":\"456\",\"userName\":\"Adele test02\",\"userType\":\"member\"}";
JObject jsonObj = JObject.Parse(extStr);
var user = new User
{
AdditionalData = new Dictionary<string, object>()
{
{"ext253rtfdu_name", jsonObj}
}
};
await graphClient.Users["AdeleVtest01@contoso.onmicrosoft.com"]
.Request()
.UpdateAsync(user);
我尝试使用https://graph.microsoft.com/v1.0/users?$filter=ext253rtfdu_name/userId eq '456'&$select=displayName,id,userPrincipalName,ext253rtfdu_name
过滤扩展名以获取用户但它显示Invalid filter clause
。 但是根据Filtering on schema extension properties known questions ,应该是支持的。
我不明白这个过滤器会发生什么,但代码示例应该是:
var res = await _graphClient.Users.Request()
.Filter($"ext253rtfdu_name/userId eq '456'").GetAsync()
这里有一个类似的帖子供您参考。
你可以从你身边试一试。
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.