Skip to main content
POST
/
radius
/
users
Create a User
curl --request POST \
  --url https://api.altostrat.io/radius/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "username": "jane.doe@altostrat.io",
  "password": "S3cur3P@ssw0rd!",
  "status": "active",
  "groups": [
    "rad_grp_01HGM5V65A5A5A5A5A5A5A5A5B"
  ],
  "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>

Body

application/json
โ€‹
username
string
required

The user's username. Must be unique within your workspace.

Example:

"jane.doe@altostrat.io"

โ€‹
password
string
required

The user's password.

Example:

"S3cur3P@ssw0rd!"

โ€‹
status
enum<string>
default:active
required

The status of the user account.

Available options:
active,
disabled
โ€‹
groups
string[]

An array of group IDs to which this user should belong.

Example:
["rad_grp_01HGM5V65A5A5A5A5A5A5A5A5B"]
โ€‹
check_attributes
any
โ€‹
reply_attributes
any
โ€‹
metadata
any

Response

The user was created successfully.

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.