Create citationTemplate

Namespace: microsoft.graph.security

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.

Create a new citationTemplate object.

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) RecordsManagement.ReadWrite.All Not available.
Delegated (personal Microsoft account) Not supported. Not supported.
Application RecordsManagement.ReadWrite.All Not available.

HTTP request

POST /security/labels/citations

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/json. Required.

Request body

In the request body, supply a JSON representation of the microsoft.graph.security.citationTemplate object.

You can specify the following properties when creating a citationTemplate.

Property Type Description
displayName String Unique string that defines a citation name. Inherited from microsoft.graph.security.filePlanDescriptorTemplate.
citationUrl String Represents the URL to the published citation. Optional.
citationJurisdiction String Represents the jurisdiction or agency that published the citation. Optional.

Response

If successful, this method returns a 201 Created response code and a microsoft.graph.security.citationTemplate object in the response body.

Examples

Request

The following example shows a request.

POST https://graph.microsoft.com/beta/security/labels/citations
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.security.citationTemplate",
  "displayName": "Contoso Company Policy",
  "citationUrl": "www.citationUrl.com",
  "citationJurisdiction": "Contoso"
}

Response

Here's an example of the response.

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

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.security.citationTemplate",
  "id": "c0475d01-d532-8a53-6e26-14ea58c640bf",
  "displayName": "Contoso Company Policy",
  "createdBy":  {
    "user": {
      "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
      "displayName": "Admin"
    }
  },
  "createdDateTime" : "2021-03-24T02:09:08Z",
  "createdDateTime": "String (timestamp)",
  "citationUrl": "www.citationUrl.com",
  "citationJurisdiction": "String"
}