Edit

Share via

teamsPolicyAssignment: getPolicyId

Namespace: microsoft.graph.teamsAdministration

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Get the policy ID for a given policy name and policy type within Teams administration.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet
✅ ❌ ❌ ❌

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) TeamsPolicyUserAssign.ReadWrite.All Not available.
Delegated (personal Microsoft account) Not supported. Not supported.
Application TeamsPolicyUserAssign.ReadWrite.All Not available.

HTTP request

GET /admin/teams/policy/getPolicyId(type='{policyType}',name='{policyName}')

Function parameters

In the request URL, provide the following query parameters with values.

Parameter Type Description
name String The name of the policy instance, such as allOn.
type String The policy type, such as teamsMeetingBroadcastPolicy and teamsMeetingPolicy.

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

If successful, this function returns a 200 OK response code and a collection of microsoft.graph.teamsAdministration.policyIdentifierDetail objects in the response body.

Examples

Request

The following example shows a request.

GET https://graph.microsoft.com/beta/admin/teams/policy/getPolicyId(type='TeamsMeetingPolicy',name='AllOn')

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

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

{
  "value": [
    {
      "@odata.type": "#microsoft.graph.teamsAdministration.policyIdentifierDetail",
      "name": "Tag:AllOn",
      "policyId": "VnMAaN3X2X1B9tEHx1CJWfC76PSaKEzA4NoUuqIMRUo"
    }
  ]
}