次の方法で共有

ロールの一覧表示

名前空間: microsoft.graph

Viva Engageで割り当てることができるすべてのロールの一覧を取得します。

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国
✅ ❌ ❌ ❌

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アクセス許可の種類 最小特権アクセス許可 より高い特権のアクセス許可
委任 (職場または学校のアカウント) EngagementRole.Read.All EngagementRole.ReadWrite.All
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション EngagementRole.Read.All EngagementRole.ReadWrite.All

HTTP 要求

GET /employeeExperience/roles

オプションのクエリ パラメーター

このメソッドは、OData クエリ パラメーターの $filter (eq)、 $select、 $top、 $count をサポートします。 一般的な情報については、「OData クエリ パラメーター」を参照してください。 $filter パラメーターをサポートするのは、displayName プロパティと id プロパティのみです。

次の表は、この API で OData クエリ パラメーターを使用する方法を示しています。

Description HTTP 要求
最初の 10 個のロールを取得し、ロールの合計数を含める GET /employeeExperience/roles?$top=10&$count=true
表示名でロールをフィルター処理する Network Admin GET /employeeExperience/roles?$filter=displayName eq 'Network Admin'
ロールの一覧の id プロパティと displayName プロパティのみを取得します GET /employeeExperience/roles?$select=id,displayName

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。

要求本文

このメソッドには、要求本文を指定しません。

応答

成功した場合、このメソッドは応答コード 200 OK と応答本文の engagementRole オブジェクトのコレクションを返します。

例

要求

次の例は要求を示しています。

GET https://graph.microsoft.com/v1.0/employeeExperience/roles

応答

次の例は応答を示しています。

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#employeeExperience/roles",
  "value": [
    {
      "id": "ec759127-089f-4f91-8dfc-03a30b51cb38",
      "displayName": "Network Admin"
    },
    {
      "id": "966b8ec4-6457-4f22-bd3c-5a2520e98f4a",
      "displayName": "Verified Admin"
    },
    {
      "id": "77aa47ad-96fe-4ecc-8024-fd1ac5e28f17",
      "displayName": "Corporate Communicator"
    }
  ]
}
  • Last updated on