命名空间:microsoft.graph
获取Viva Engage中分配给用户的所有角色的列表。
此 API 可用于以下国家级云部署。
| 全局服务 |
美国政府 L4 |
美国政府 L5 (DOD) |
由世纪互联运营的中国 |
| ✅ |
❌ |
❌ |
❌ |
权限
为此 API 选择标记为最低特权的权限。
只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考。
| 权限类型 |
最低特权权限 |
更高特权权限 |
| 委派(工作或学校帐户) |
EngagementRole.Read |
EngagementRole.ReadWrite.All |
| 委派(个人 Microsoft 帐户) |
不支持。 |
不支持。 |
| 应用程序 |
EngagementRole.Read.All |
EngagementRole.ReadWrite.All |
注意
调用 /me 终结点需要已登录的用户,因此需要委派权限。 使用 /me 终结点时,不支持应用程序权限。
HTTP 请求
GET /users/{userId}/employeeExperience/assignedRoles
GET /me/employeeExperience/assignedRoles
注意: 表示 {userId} Office 用户 ID。
可选的查询参数
此方法支持 $filter (eq) 、 $select和 $count OData 查询参数。 若要了解一般信息,请参阅 OData 查询参数。 只有 displayName 和 id 属性支持 $filter 参数。
下表显示了如何将 OData 查询参数用于此 API。
| 说明 |
HTTP 请求 |
| 按显示名称筛选分配的角色 |
GET /users/{userId}/employeeExperience/assignedRoles?$filter=displayName eq 'Corporate Communicator' |
| 仅获取已分配角色列表的 id 属性 |
GET /users/{userId}/employeeExperience/assignedRoles?$select=id |
| 包括已分配角色的总计数 |
GET /users/{userId}/employeeExperience/assignedRoles?$count=true |
| 名称 |
说明 |
| Authorization |
持有者 {token}。 必填。 详细了解 身份验证和授权。 |
请求正文
请勿提供此方法的请求正文。
响应
如果成功,此方法在 200 OK 响应正文中返回响应代码和 engagementRole 对象的集合。
示例
示例 1:获取在 Viva Engage 中分配给已登录用户的所有角色的列表
以下示例演示如何在 Viva Engage 中获取分配给已登录用户的所有角色的列表。
请求
以下示例显示了一个请求。
GET https://graph.microsoft.com/v1.0/me/employeeExperience/assignedRoles
// Code snippets are only available for the latest version. Current version is 5.x
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Me.EmployeeExperience.AssignedRoles.GetAsync();
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
// Code snippets are only available for the latest major version. Current major version is $v1.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
//other-imports
)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
assignedRoles, err := graphClient.Me().EmployeeExperience().AssignedRoles().Get(context.Background(), nil)
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
EngagementRoleCollectionResponse result = graphClient.me().employeeExperience().assignedRoles().get();
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
const options = {
authProvider,
};
const client = Client.init(options);
let assignedRoles = await client.api('/me/employeeExperience/assignedRoles')
.get();
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
<?php
use Microsoft\Graph\GraphServiceClient;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$result = $graphServiceClient->me()->employeeExperience()->assignedRoles()->get()->wait();
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
result = await graph_client.me.employee_experience.assigned_roles.get()
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
响应
以下示例显示了相应的响应。
注意:为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#me/employeeExperience/assignedRoles",
"value": [
{
"id": "ec791927-d09f-4f91-bd76-d3b05e1c1a31",
"displayName": "Network Admin"
},
{
"id": "b0de8e6d-4457-4722-bdc5-5a32a09bf064",
"displayName": "Verified Admin"
},
{
"id": "77aa7d76-bdf6-4cc0-80e2-fd1ac5a28471",
"displayName": "Corporate Communicator"
}
]
}
示例 2:获取Viva Engage中分配给用户的所有角色的列表
以下示例演示如何获取Viva Engage中分配给用户的所有角色的列表。
请求
以下示例显示了一个请求。
GET https://graph.microsoft.com/v1.0/users/e8d9f6a2-1c34-4b7a-9f11-2a4d8b7c9e01/employeeExperience/assignedRoles
// Code snippets are only available for the latest version. Current version is 5.x
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Users["{user-id}"].EmployeeExperience.AssignedRoles.GetAsync();
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
// Code snippets are only available for the latest major version. Current major version is $v1.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
//other-imports
)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
assignedRoles, err := graphClient.Users().ByUserId("user-id").EmployeeExperience().AssignedRoles().Get(context.Background(), nil)
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
EngagementRoleCollectionResponse result = graphClient.users().byUserId("{user-id}").employeeExperience().assignedRoles().get();
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
const options = {
authProvider,
};
const client = Client.init(options);
let assignedRoles = await client.api('/users/e8d9f6a2-1c34-4b7a-9f11-2a4d8b7c9e01/employeeExperience/assignedRoles')
.get();
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
<?php
use Microsoft\Graph\GraphServiceClient;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$result = $graphServiceClient->users()->byUserId('user-id')->employeeExperience()->assignedRoles()->get()->wait();
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
result = await graph_client.users.by_user_id('user-id').employee_experience.assigned_roles.get()
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
响应
以下示例显示了相应的响应。
注意:为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users/e8d9f6a2-1c34-4b7a-9f11-2a4d8b7c9e01/employeeExperience/assignedRoles",
"value": [
{
"id": "ec791927-d09f-4f91-bd76-d3b05e1c1a31",
"displayName": "Network Admin"
},
{
"id": "b0de8e6d-4457-4722-bdc5-5a32a09bf064",
"displayName": "Verified Admin"
},
{
"id": "77aa7d76-bdf6-4cc0-80e2-fd1ac5a28471",
"displayName": "Corporate Communicator"
}
]
}