Créer customSecurityAttributeDefinition

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Créez un objet SecurityAttributeDefinition personnalisé .

Cette API est disponible dans les déploiements cloud nationaux suivants.

Service global Gouvernement américain L4 Gouvernement américain L5 (DOD) Chine exploitée par 21Vianet

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme étant les moins privilégiées pour cette API. Utilisez une ou plusieurs autorisations privilégiées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, voir Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez la référence des autorisations.

Type d’autorisation Autorisations les moins privilégiées Autorisations à privilèges plus élevés
Déléguée (compte professionnel ou scolaire) CustomSecAttributeDefinition.ReadWrite.All Non disponible.
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application CustomSecAttributeDefinition.ReadWrite.All Non disponible.

Importante

Pour l’accès délégué à l’aide de comptes professionnels ou scolaires, l’utilisateur connecté doit disposer d’un rôle Microsoft Entra pris en charge ou d’un rôle personnalisé qui accorde les autorisations requises pour cette opération.

  • L’administrateur de définition d’attribut est le seul rôle privilégié pris en charge pour cette opération.
  • Par défaut, les administrateurs généraux et les autres rôles d’administrateur ne disposent pas des autorisations de lecture, de définition ou d’attribution d’attributs de sécurité personnalisés.

Requête HTTP

POST /directory/customSecurityAttributeDefinitions

En-têtes de demande

Nom Description
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et les autorisations.
Content-Type application/json. Obligatoire.

Corps de la demande

Dans le corps de la demande, fournissez une représentation JSON de l’objet customSecurityAttributeDefinition .

Le tableau suivant présente les propriétés que vous pouvez configurer lorsque vous créez une customSecurityAttributeDefinition.

Propriété Type Description
attributeSet String Nom du jeu d’attributs. Respecte la casse. Obligatoire.
description String Description de l’attribut de sécurité personnalisé. Peut comporter jusqu’à 128 caractères et inclure des caractères Unicode. Ne peut pas contenir d’espaces ni de caractères spéciaux. Peut être modifié ultérieurement. Facultatif.
isCollection Booléen Indique si plusieurs valeurs peuvent être attribuées à l’attribut de sécurité personnalisé. Ne peut pas être modifié ultérieurement. Si type est défini sur Boolean, isCollection ne peut pas être défini sur true. Obligatoire.
is_searchable Booléen Indique si les valeurs d’attribut de sécurité personnalisées sont indexées pour la recherche sur les objets auxquels des valeurs d’attribut ont été attribuées. Ne peut pas être modifié ultérieurement. Obligatoire.
nom String Nom de l’attribut de sécurité personnalisé. Doit être unique au sein d’un jeu d’attributs. Peut comporter jusqu’à 32 caractères et inclure des caractères Unicode. Ne peut pas contenir d’espaces ni de caractères spéciaux. Ne peut pas être modifié ultérieurement. Respecte la casse. Obligatoire.
status String Indique si l’attribut de sécurité personnalisé est actif ou désactivé. Les valeurs acceptables sont Available et Deprecated. Peut être modifié ultérieurement. Obligatoire.
type String Type de données pour les valeurs d’attribut de sécurité personnalisé. Les types pris en charge sont les suivants : , BooleanIntegeret String. Ne peut pas être modifié ultérieurement. Obligatoire.
usePreDefinedValuesOnly Booléen Indique si seules des valeurs prédéfinies peuvent être attribuées à l’attribut de sécurité personnalisé. Si la valeur est , falseles valeurs de forme libre sont autorisées. Peut être changé ultérieurement de true à false, mais ne peut pas être changé de false à true. Si type est défini sur Boolean, usePreDefinedValuesOnly ne peut pas être défini sur true. Obligatoire.

La propriété id est générée automatiquement et ne peut pas être définie.

Réponse

En cas de réussite, cette méthode renvoie un 201 Created code de réponse et un objet customSecurityAttributeDefinition dans le corps de la réponse.

Exemples

Exemple 1 : ajouter un attribut de sécurité personnalisé

L’exemple suivant ajoute une nouvelle définition d’attribut de sécurité personnalisée qui est une valeur unique de forme libre de type Chaîne.

  • Jeu d’attributs : Engineering
  • Attribut : ProjectDate

Demande

L’exemple suivant illustre une demande.

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
}

Réponse

L’exemple suivant illustre la réponse.

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
}

Exemple 2 : ajouter un attribut de sécurité personnalisé qui prend en charge plusieurs valeurs prédéfinies

L’exemple suivant ajoute une nouvelle définition d’attribut de sécurité personnalisée qui prend en charge plusieurs valeurs de type Chaîne prédéfinies.

  • Jeu d’attributs : Engineering
  • Attribut : Project

Demande

L’exemple suivant illustre une demande.

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
}

Réponse

L’exemple suivant illustre la réponse.

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
}

Exemple 3 : ajouter un attribut de sécurité personnalisé avec une liste de valeurs prédéfinies

L’exemple suivant montre comment ajouter une nouvelle définition d’attribut de sécurité personnalisée avec une liste de valeurs prédéfinies sous forme de collection de chaînes.

  • Jeu d’attributs : Engineering
  • Attribut : Project
  • Type de données d’attribut : collection de chaînes
  • Valeurs prédéfinies : Alpine, Baker, Cascade

Demande

L’exemple suivant illustre une demande.

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
        }
    ]
}

Réponse

L’exemple suivant illustre la réponse.

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
}