Skip to main content

User management API

This API is based on the Device Configuration API framework. For guidance on how to use these APIs, please refer to the Device Configuration APIs section in the VAPIX Library.

Description​

The VAPIX® User Management API v2 allows the user to view possible passphrase-complexity policies, as well as manage the passphrase-complexity policy currently in use.

Use cases​

Get available passphrase-complexity policies​

Check the user-management.v2.settings.passphraseComplexity.policies to view the currently available passphrase-complexity policies.

The policies are available for users without access rights until the first account is registered on the device. This exception is only available on a factory reset unit.

Example:

GET /config/rest/user-management/v2/settings/passPhraseComplexity/policies HTTP/1.1
HOST: my-device
Content-Type: application/json
HTTP/1.1 200 OK
Content-Type: application/json

{
    "status": "success",
    "data": [
        {
            "desc": "No passphrase complexity requirements",
            "id": "none",
        },
        {
            "desc": "Passwords must be at least 15 characters long. No additional complexity requirements are required. This policy follows U.S. NIST 800-638 and Hapan JC-Star.",
            "id": "length",
        },
        {
            "desc": "Passwords must be at least 12 characters long and include one uppercase letter, one lowercase letter, one numeric digit, and one special character. This policy follows South Korea NIS, German BSI, France ANSSI and Singapore CLS among others.",
            "id": "complex",
        }
    ]
}

Manage the current passphrase-complexity policy​

Get or set the property user-management.v2.settings.passphraseComplexity.policy to manage which passphrase-complexity policy is currently in use.

The policies are available for users without access rights until the first account is registered on the device. This exception is only available on a factory reset unit.

Example:

PATCH /config/rest/user-management/v2/settings/passphraseComplexity/policy HTTP/1.1
HOST: my-device
Content-Type: application/json
HTTP/1.1 200 OK
Content-Type: application/json

{
    "status": "success",
    "data": "length"
}
PATCH /config/rest/user-management/v2/settings/passPhraseComplexity/policy HTTP/1.1
HOST: my-device
Content-Type: application/json

{
    "data": "complex"
}
HTTP/1.1 200 OK
Content-Type: application/json

{
    "status": "success"
}

API definition​

Structure​

user-management.v2 (Root Entity)
    ├── settings (Entity Collection)
        ├── passphraseComplexity (Entity Collection)
            ├── policies (Property)
            ├── policy (Property)

Entities​

user-management.v2​

  • Description: User Management configuration
  • Type: Singleton
  • Operations
    • GET
  • Attributes
    • Dynamic Support: No
Properties​

This entity has no properties.

Actions​

This entity has no actions.

user-management.v2.settings​

  • Description: Global settings for User Management
  • Type: Singleton
  • Operations
    • GET
  • Attributes
    • Dynamic Support: No
Properties​

This entity has no properties.

Actions​

This entity has no actions.

user-management.v2.settings.passphraseComplexity​

  • Description: Passhrase complexity
  • Type: Singleton
  • Operations
    • Get
  • Attributes
    • Dynamic Support: No
Properties​
policies​
  • Description: Available passphrase complexity policies
  • Datatype: PassphrasePolicyList
  • Operations
    • GET (Permissions: admin, operator, viewer)
  • Attributes
    • Nullable: No
    • Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No
policy​
  • Description: Selected passphrase complexity policy
  • Datatype: string
  • Operations
    • GET (Permissions: admin, operator, viewer)
    • SET (Permissions: admin)
  • Attributes
    • Nullable: No
    • Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No
Actions​

This entity has no actions.

Data types​

PassphrasePolicy​

  • Description: A passphrase policy
  • Type: complex
  • Fields
    • desc
      • Description: The description of the policy
      • Type: string
      • Nullable: No / Gettable: Yes
    • id
      • Description: Unique identifier for a PassphraseProfile
      • Type: string
      • Nullable: No / Gettable: Yes

PassphrasePolicyList​

  • Description: A list of passphrase policies
  • Type: array
  • Element type: PassphrasePolicy
  • Null Value: No