Update User Security Settings

client.user.security.update(, ?): UserSecurity { source_ip_rule, created_at, updated_at }

PATCH/v1/user/security

Update the current user’s security settings

ParametersExpand Collapse

body: SecurityUpdateParams { source_ip_rule }

source_ip_rule?: SourceIPRule { allowed, blocked }

IP filter rules.

allowed?: Array<string>

List of IPv4 CIDR addresses to allow.

blocked?: Array<string>

List of IPv4 CIDR addresses to deny.

ReturnsExpand Collapse

UserSecurity { source_ip_rule, created_at, updated_at }

User security settings response.

source_ip_rule: SourceIPRuleResponse { allowed, blocked }

IP filter rules.

allowed: Array<string>

List of IPv4 CIDR addresses to allow.

blocked: Array<string>

List of IPv4 CIDR addresses to deny.

created_at?: string

When the user security settings were created.

formatdate-time

updated_at?: string

When the user security settings were updated.

formatdate-time

Update User Security Settings

import NirvanaLabs from '@nirvana-labs/nirvana';

const client = new NirvanaLabs({
  apiKey: process.env['NIRVANA_LABS_API_KEY'], // This is the default and can be omitted
});

const userSecurity = await client.user.security.update();

console.log(userSecurity.source_ip_rule);

{
  "source_ip_rule": {
    "allowed": [
      "192.168.1.0/24",
      "10.0.0.0/8"
    ],
    "blocked": [
      "192.168.1.100/32"
    ]
  },
  "created_at": "2025-01-01T00:00:00Z",
  "updated_at": "2025-01-01T00:00:00Z"
}

Returns Examples

{
  "source_ip_rule": {
    "allowed": [
      "192.168.1.0/24",
      "10.0.0.0/8"
    ],
    "blocked": [
      "192.168.1.100/32"
    ]
  },
  "created_at": "2025-01-01T00:00:00Z",
  "updated_at": "2025-01-01T00:00:00Z"
}