Skip to main content
PATCH
/
radius
/
users
/
{userId}
Update a User
curl --request PATCH \
  --url https://api.altostrat.io/radius/users/{userId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "status": "active",
  "groups": [
    "rad_grp_01HGM5V65A5A5A5A5A5A5A5A5B",
    "rad_grp_01HGM5V65A5A5A5A5A5A5A5A5F"
  ],
  "check_attributes": "<any>",
  "reply_attributes": "<any>",
  "metadata": "<any>"
}'
{
  "id": "rad_usr_01HGM5V65A5A5A5A5A5A5A5A5A",
  "username": "john.doe@altostrat.io",
  "status": "active",
  "group_count": 2,
  "check_attributes": [
    {
      "attribute": "Session-Timeout",
      "op": ":=",
      "value": "3600"
    }
  ],
  "reply_attributes": [
    {
      "attribute": "Session-Timeout",
      "op": ":=",
      "value": "3600"
    }
  ],
  "metadata": {
    "employee_id": "E12345"
  },
  "tags": [
    "rad_tag_01HGM5V65A5A5A5A5A5A5A5A5D"
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Enter your API key in the format: Bearer <token>

Path Parameters

​
userId
string
required

The unique identifier for the user, prefixed with rad_usr_.

Body

application/json
​
status
enum<string>

The new status for the user account.

Available options:
active,
disabled
​
groups
string[]

A complete list of group IDs for the user. This will replace the user's existing group memberships.

Example:
[
  "rad_grp_01HGM5V65A5A5A5A5A5A5A5A5B",
  "rad_grp_01HGM5V65A5A5A5A5A5A5A5A5F"
]
​
check_attributes
any
​
reply_attributes
any
​
metadata
any

Response

The updated user object.

Represents a RADIUS user account.

​
id
string

Unique identifier for the user.

Example:

"rad_usr_01HGM5V65A5A5A5A5A5A5A5A5A"

​
username
string

The username used for authentication.

Example:

"john.doe@altostrat.io"

​
status
enum<string>

The current status of the user account.

Available options:
active,
disabled
Example:

"active"

​
group_count
integer

The number of groups this user is a member of.

Example:

2

​
check_attributes
object[]

A list of RADIUS attributes used to check against the user's request during authorization.

​
reply_attributes
object[]

A list of RADIUS attributes to be returned in the Access-Accept response.

​
metadata
object

A set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

Example:
{ "employee_id": "E12345" }
​
tags
string[]

A list of tag IDs associated with this user.

Example:
["rad_tag_01HGM5V65A5A5A5A5A5A5A5A5D"]
​
created_at
string<date-time>

Time at which the object was created.

​
updated_at
string<date-time>

Time at which the object was last updated.