getOrgPskPortal

{
  "type": "object",
  "required": [
    "name",
    "ssid"
  ],
  "properties": {
    "auth": {
      "type": "string",
      "description": "Note: `sponsor` not yet available",
      "enum": [
        "sso",
        "sponsor"
      ]
    },
    "bg_image_url": {
      "type": "string"
    },
    "cleanup_psk": {
      "type": "boolean",
      "description": "used to cleanup exited psk when portal delete or ssid changed"
    },
    "created_time": {
      "type": "integer"
    },
    "expire_time": {
      "type": "integer",
      "description": "unit min"
    },
    "expiry_notification_time": {
      "type": "integer",
      "description": "Number of days before psk is expired. Used as to when to start sending reminder notification when the psk is about to expire"
    },
    "hide_psks_created_by_other_admins": {
      "type": "boolean",
      "description": "only if `type`==`admin`"
    },
    "id": {
      "type": "string"
    },
    "max_usage": {
      "type": "integer",
      "description": "`max_usage`==`0` means unlimited"
    },
    "modified_time": {
      "type": "integer"
    },
    "name": {
      "type": "string"
    },
    "notify_expiry": {
      "type": "boolean",
      "description": "If set to true, reminder notification will be sent when psk is about to expire"
    },
    "notify_on_create_or_edit": {
      "type": "boolean"
    },
    "org_id": {
      "type": "string"
    },
    "passphrase_rules": {
      "type": "object",
      "properties": {
        "alphaberts_enabled": {
          "type": "boolean"
        },
        "length": {
          "type": "integer"
        },
        "max_length": {
          "type": "integer",
          "description": "for valid `max_length` and `min_length`, passphrase size is set randomly from that range.\n- if `max_length` and/or `min_length` are invalid, passphrase size is equal to `length` parameter\n- if `length` is not set or is invalid, default passphrase size is 8.\nvalid `max_length`, `min_length`, `length` should be an integer between 8 to 63. Also, `max_length` > `min_length`"
        },
        "min_length": {
          "type": "integer",
          "description": "for valid `max_length` and `min_length`, passphrase size is set randomly from that range.\n- if `max_length` and/or `min_length` are invalid, passphrase size is equal to `length` parameter\n- if `length` is not set or is invalid, default passphrase size is 8.\nvalid `max_length`, `min_length`, `length` should be an integer between 8 to 63. Also, `max_length` > `min_length`"
        },
        "numerics_enabled": {
          "type": "boolean"
        },
        "symbols": {
          "type": "string"
        },
        "symbols_enabled": {
          "type": "boolean"
        }
      }
    },
    "required_fields": {
      "type": "array",
      "description": "what information to ask for (email is required by default)",
      "items": {
        "type": "string"
      }
    },
    "role": {
      "type": "string"
    },
    "ssid": {
      "type": "string",
      "description": "intended SSID"
    },
    "sso": {
      "type": "object",
      "description": "if `auth`==`sso`",
      "properties": {
        "allowed_roles": {
          "type": "array",
          "description": "// allowed roles for accessing psk portal, if none, any role is permitted",
          "items": {
            "type": "string"
          }
        },
        "idp_cert": {
          "type": "string"
        },
        "idp_sign_algo": {
          "type": "string"
        },
        "idp_sso_url": {
          "type": "string"
        },
        "issuer": {
          "type": "string"
        },
        "nameid_format": {
          "type": "string"
        },
        "role_mapping": {
          "type": "object",
          "description": "Property key is the role name, property value is the SSO Attribute"
        },
        "use_sso_role_for_psk_role": {
          "type": "boolean",
          "description": "if enabled, the `role` above will be ignored"
        }
      }
    },
    "template_url": {
      "type": "string",
      "description": "UI customization"
    },
    "thumbnail_url": {
      "type": "string"
    },
    "type": {
      "type": "string",
      "description": "for personal psk portal",
      "enum": [
        "byod",
        "admin"
      ]
    },
    "vlan_id": {
      "type": "integer"
    }
  }
}