Создание customSecurityAttributeDefinition

Пространство имен: microsoft.graph

Важно!

API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.

Создайте объект customSecurityAttributeDefinition .

Этот API доступен в следующих национальных облачных развертываниях.

Глобальная служба Правительство США L4 Правительство США L5 (DOD) Китай управляется 21Vianet

Разрешения

Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.

Тип разрешения Разрешения с наименьшими привилегиями Более высокие привилегированные разрешения
Делегированные (рабочая или учебная учетная запись) CustomSecAttributeDefinition.ReadWrite.All Недоступно.
Делегированные (личная учетная запись Майкрософт) Не поддерживается. Не поддерживается.
Приложение CustomSecAttributeDefinition.ReadWrite.All Недоступно.

Вошедшего пользователя также должна быть назначена по крайней мере роль администратора каталогаопределения атрибутов. По умолчанию глобальный администратор и другие роли администратора не имеют разрешений на чтение, определение или назначение настраиваемых атрибутов безопасности.

HTTP-запрос

POST /directory/customSecurityAttributeDefinitions

Заголовки запросов

Имя Описание
Авторизация Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации.
Content-Type application/json. Обязательно.

Текст запроса

В тексте запроса укажите представление объекта customSecurityAttributeDefinition в формате JSON.

В следующей таблице показаны свойства, которые можно настроить при создании customSecurityAttributeDefinition.

Свойство Тип Описание
attributeSet String Имя набора атрибутов. Без учета регистра. Обязательный.
description String Описание настраиваемого атрибута безопасности. Может содержать до 128 символов и содержать символы Юникода. Не может содержать пробелы или специальные символы. Можно изменить позже. Необязательный параметр.
isCollection Логический Указывает, можно ли назначить настраиваемый атрибут безопасности несколько значений. Не удается изменить позже. Если для параметра type задано значение Boolean, isCollection не может быть задано значение true. Обязательно.
isSearchable Логический Указывает, индексируются ли значения настраиваемых атрибутов безопасности для поиска объектов, которым назначены значения атрибутов. Не удается изменить позже. Обязательно.
name String Имя настраиваемого атрибута безопасности. Должен быть уникальным в наборе атрибутов. Может содержать до 32 символов и содержать символы Юникода. Не может содержать пробелы или специальные символы. Не удается изменить позже. Без учета регистра. Обязательно.
status String Указывает, активен или деактивирован настраиваемый атрибут безопасности. Допустимые значения: Available и Deprecated. Можно изменить позже. Обязательно.
type String Тип данных для значений настраиваемых атрибутов безопасности. Поддерживаемые типы: Boolean, Integerи String. Не удается изменить позже. Обязательно.
usePreDefinedValuesOnly Логический Указывает, можно ли назначать настраиваемым атрибутам безопасности только предопределенные значения. Если задано значение false, допустимы значения в свободной форме. Позже может быть изменено с true на false, но не может быть изменено с false на true. Если тип имеет значение Boolean, параметр usePreDefinedValuesOnly не может быть задан как true. Обязательно.

Свойство id создается автоматически и не может быть задано.

Отклик

В случае успешного выполнения этот метод возвращает код отклика 201 Created и объект customSecurityAttributeDefinition в теле отклика.

Примеры

Пример 1. Добавление настраиваемого атрибута безопасности

В следующем примере добавляется новое определение настраиваемого атрибута безопасности, которое представляет собой одно значение свободной формы типа String.

  • Набор атрибутов: Engineering
  • Атрибут: ProjectDate

Запрос

Ниже показан пример запроса.

POST https://graph.microsoft.com/beta/directory/customSecurityAttributeDefinitions
Content-Type: application/json

{
    "attributeSet":"Engineering",
    "description":"Target completion date",
    "isCollection":false,
    "isSearchable":true,
    "name":"ProjectDate",
    "status":"Available",
    "type":"String",
    "usePreDefinedValuesOnly": false
}

Отклик

Ниже показан пример отклика.

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

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#directory/customSecurityAttributeDefinitions/$entity",
    "attributeSet": "Engineering",
    "description": "Target completion date",
    "id": "Engineering_ProjectDate",
    "isCollection": false,
    "isSearchable": true,
    "name": "ProjectDate",
    "status": "Available",
    "type": "String",
    "usePreDefinedValuesOnly": false
}

Пример 2. Добавление настраиваемого атрибута безопасности, который поддерживает несколько предопределенных значений

В следующем примере добавляется новое определение настраиваемого атрибута безопасности, которое поддерживает несколько стандартных значений типа String.

  • Набор атрибутов: Engineering
  • Атрибут: Project

Запрос

Ниже показан пример запроса.

POST https://graph.microsoft.com/beta/directory/customSecurityAttributeDefinitions
Content-Type: application/json
Content-length: 310

{
    "attributeSet":"Engineering",
    "description":"Active projects for user",
    "isCollection":true,
    "isSearchable":true,
    "name":"Project",
    "status":"Available",
    "type":"String",
    "usePreDefinedValuesOnly": true
}

Отклик

Ниже показан пример отклика.

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

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#directory/customSecurityAttributeDefinitions/$entity",
    "attributeSet": "Engineering",
    "description": "Active projects for user",
    "id": "Engineering_Project",
    "isCollection": true,
    "isSearchable": true,
    "name": "Project",
    "status": "Available",
    "type": "String",
    "usePreDefinedValuesOnly": true
}

Пример 3. Добавление настраиваемого атрибута безопасности со списком предопределенных значений

Ниже приведен пример, в который добавляется новое определение настраиваемого атрибута безопасности со списком предопределенных значений в виде коллекции строк.

  • Набор атрибутов: Engineering
  • Атрибут: Project
  • Тип данных атрибута: коллекция строк
  • Предопределенные значения: Alpine, Baker, Cascade

Запрос

Ниже показан пример запроса.

POST https://graph.microsoft.com/beta/directory/customSecurityAttributeDefinitions
Content-Type: application/json

{
    "attributeSet": "Engineering",
    "description": "Active projects for user",
    "isCollection": true,
    "isSearchable": true,
    "name": "Project",
    "status": "Available",
    "type": "String",
    "usePreDefinedValuesOnly": true,
    "allowedValues": [
        {
            "id": "Alpine",
            "isActive": true
        },
        {
            "id": "Baker",
            "isActive": true
        },
        {
            "id": "Cascade",
            "isActive": true
        }
    ]
}

Отклик

Ниже приводится пример отклика.

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

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#directory/customSecurityAttributeDefinitions/$entity",
    "attributeSet": "Engineering",
    "description": "Active projects for user",
    "id": "Engineering_Project",
    "isCollection": true,
    "isSearchable": true,
    "name": "Project",
    "status": "Available",
    "type": "String",
    "usePreDefinedValuesOnly": true
}