NSX-T Data Center REST API

DirectoryGroup (type)

{
  "extends": {
    "$ref": "ManagedResource"
  },
  "id": "DirectoryGroup",
  "module_id": "DirectoryService",
  "polymorphic-type-descriptor": {
    "mode": "enabled"
  },
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp",
      "can_sort": true,
      "description": "Timestamp of resource creation",
      "readonly": true
    },
    "_create_user": {
      "description": "ID of the user who created this resource",
      "readonly": true,
      "type": "string"
    },
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp",
      "can_sort": true,
      "description": "Timestamp of last modification",
      "readonly": true
    },
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource",
      "readonly": true,
      "type": "string"
    },
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
      "items": {
        "$ref": "ResourceLink"
      },
      "readonly": true,
      "title": "References related to this resource",
      "type": "array"
    },
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.",
      "readonly": true,
      "title": "Indicates protection status of this resource",
      "type": "string"
    },
    "_revision": {
      "computed": true,
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.",
      "title": "Generation of this resource config",
      "type": "int"
    },
    "_schema": {
      "readonly": true,
      "title": "Schema for this resource",
      "type": "string"
    },
    "_self": {
      "$ref": "SelfResourceLink",
      "readonly": true,
      "title": "Link to this resource"
    },
    "_system_owned": {
      "description": "Indicates system owned resource",
      "readonly": true,
      "type": "boolean"
    },
    "description": {
      "can_sort": true,
      "maxLength": 1024,
      "title": "Description of this resource",
      "type": "string"
    },
    "display_name": {
      "can_sort": true,
      "computed": true,
      "description": "Defaults to ID if not set",
      "maxLength": 255,
      "title": "Identifier to use when displaying entity in logs or GUI",
      "type": "string"
    },
    "distinguished_name": {
      "required": true,
      "title": "Directory group distinguished name",
      "type": "string"
    },
    "domain_id": {
      "description": "Domain ID this directory group belongs to.",
      "required": true,
      "title": "Domain id",
      "type": "string"
    },
    "domain_name": {
      "description": "Each active directory domain has a domain naming context (NC), which contains domain-specific data. The root of this naming context is represented by a domain's distinguished name (DN) and is typically referred to as the NC head.",
      "required": true,
      "title": "Directory domain distinguished name",
      "type": "string"
    },
    "domain_sync_node_id": {
      "description": "Domain sync node under which this directory group is located. We currently sync only from Root node and hence this attribute doesn't have a specific value set.",
      "required": false,
      "title": "Domain synchronization root node id",
      "type": "string"
    },
    "id": {
      "can_sort": true,
      "title": "Unique identifier of this resource",
      "type": "string"
    },
    "is_global": {
      "description": "This property indicates whether the directory group was | synced from the LDAP server using global config or  | local config.",
      "required": true,
      "title": "This flag indicates sync using either global config or local config",
      "type": "boolean"
    },
    "resource_type": {
      "description": "Directory group resource type comes from multiple sub-classes extending this base class. For example, DirectoryAdGroup is one accepted resource_type. If there are more sub-classes defined, they will also be accepted resource_type.",
      "required": true,
      "title": "Directory group resource type for this domain",
      "type": "string"
    },
    "tags": {
      "items": {
        "$ref": "Tag"
      },
      "maxItems": 30,
      "title": "Opaque identifiers meaningful to the API user",
      "type": "array"
    }
  },
  "type": "object"
}