NSX-T Data Center Global Manager REST API

NodeUserProperties (type)

{
  "additionalProperties": false,
  "extends": {
    "$ref": "Resource"
  },
  "id": "NodeUserProperties",
  "properties": {
    "_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"
    },
    "_schema": {
      "readonly": true,
      "title": "Schema for this resource",
      "type": "string"
    },
    "_self": {
      "$ref": "SelfResourceLink",
      "readonly": true,
      "title": "Link to this resource"
    },
    "account_expires": {
      "readonly": true,
      "title": "Node local user account expiration date (ISO-8601 date form, i.e. YYYY-MM-DD)\nor null when never expires\n",
      "type": "string"
    },
    "account_type": {
      "enum": [
        "administrator",
        "audit",
        "guest",
        "root",
        "service",
        "system"
      ],
      "readonly": true,
      "title": "Node local user account type",
      "type": "string"
    },
    "full_name": {
      "title": "Full name for the user",
      "type": "string"
    },
    "group_id": {
      "maximum": 2147483647,
      "minimum": 0,
      "readonly": true,
      "title": "Primary group id for the user",
      "type": "integer"
    },
    "home_dir": {
      "readonly": true,
      "title": "The absolute path of user home directory",
      "type": "string"
    },
    "last_password_change": {
      "maximum": 2147483647,
      "minimum": 0,
      "readonly": true,
      "title": "Number of days since password was last changed",
      "type": "integer"
    },
    "last_password_change_epoch": {
      "readonly": true,
      "title": "Node local user account last password change Unix Epoch timestamp or 0 when never changed\n",
      "type": "integer"
    },
    "locked": {
      "description": "<p><code>http</code> when the user account is currently locked to make any web authentication requests, because of many consecutive failed authentication attempts was made for a respective user (at max of configured auth-policy <code>api_failed_auth_lockout_period</code>).</p> <p><code>cli</code> when the user account is currently locked to make any NSX-CLI authentication requests as per configured cli-lockout policy</p> <p>Property is available only when list node users is issued with query parameter - internal=true, check ListNodeUsers [GET] /api/v1/node/users for more details.</p>",
      "items": {
        "type": "string"
      },
      "readonly": true,
      "title": "List indicating user is currently locked out for target interface",
      "type": "array"
    },
    "login_shell": {
      "readonly": true,
      "title": "The absolute path of login shell",
      "type": "string"
    },
    "old_password": {
      "sensitive": true,
      "title": "Old password for the user (required on PUT if password specified)",
      "type": "string"
    },
    "password": {
      "sensitive": true,
      "title": "Password for the user (optionally specified on PUT, unspecified on GET)",
      "type": "string"
    },
    "password_change_frequency": {
      "default": 90,
      "description": "Number of days password is valid before it must be changed. This can be set to 0 to indicate no password change is required or a positive integer up to 9999. For following account_types - <code>root, administrator, audit, guest</code>, VCF password management policy's <code>passwordExpirationDays</code> will be preferred by default, further overriding in request will error out with 409 CONFLICT. For other account_types, or when no VCF password management policy is configured, the default value is 90.",
      "maximum": 99999,
      "minimum": 0,
      "title": "Number of days password is valid before it must be changed",
      "type": "integer"
    },
    "password_change_warning": {
      "default": 7,
      "desciption": "Number of days before user receives warning message to change the password before it expires. By default users will receive 7 days prior warning message to change the password.",
      "maximum": 99999,
      "minimum": 0,
      "title": "Number of days before user receives warning message of password expiration",
      "type": "integer"
    },
    "password_expires": {
      "readonly": true,
      "title": "Node local user account password expiration date (ISO-8601 date form, i.e. YYYY-MM-DD)\nor null when never expires\n",
      "type": "string"
    },
    "password_expires_epoch": {
      "readonly": true,
      "title": "Node local user account password expiration Unix Epoch timestamp or 0 when never expires\n",
      "type": "integer"
    },
    "password_reset_required": {
      "title": "Boolean value that states if a password reset is required",
      "type": "boolean"
    },
    "status": {
      "description": "Status of the user. This value can be ACTIVE indicating authentication attempts will be successful if the correct credentials are specified. The value can also be PASSWORD_EXPIRED indicating authentication attempts will fail because the user's password has expired and must be changed. Or, this value can be NOT_ACTIVATED indicating the user's password has not yet been set and must be set before the user can authenticate.",
      "enum": [
        "ACTIVE",
        "PASSWORD_EXPIRED",
        "NOT_ACTIVATED"
      ],
      "readonly": true,
      "title": "User status",
      "type": "string"
    },
    "userid": {
      "maximum": 2147483647,
      "minimum": 0,
      "readonly": true,
      "title": "Numeric id for the user",
      "type": "integer"
    },
    "username": {
      "maxLength": 32,
      "minLength": 1,
      "pattern": "^[a-zA-Z][a-zA-Z0-9-_.\\-]*$",
      "title": "User login name (must be \"root\" if userid is 0)",
      "type": "string"
    }
  },
  "title": "Node user properties",
  "type": "object"
}