• Local User Store

users

PrivX local users

get/local-user-store/api/v1/users

List users

Get all users.

offsetint

Collection query offset

Default
0
Min
0
limitint

Maximum number of collection items to return

Default
50
usernamestring

The username of the user

idstring

The ID of the user

Format
uuid

Responses

Response examples

Successful response, returns an array of users, returns an empty array if no users found

{
  "count": 123,
  "items": [
    {
      "id": "5bf77342-221c-11ee-be56-0242ac120002",
      "created": "2017-01-01T15:05:05Z",
      "updated": "2017-01-01T15:05:05Z",
      "updated_by": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
      "author": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
      "comment": "A comment",
      "tags": [
        "string"
      ],
      "username": "string",
      "windows_account": "string",
      "unix_account": "string",
      "full_name": "string",
      "display_name": "string",
      "job_title": "string",
      "company": "string",
      "department": "string",
      "email": "string",
      "telephone": "string",
      "locale": "fi_FI",
      "password": {
        "password": "string",
        "created": "2017-01-01T15:05:05Z"
      },
      "password_change_required": true,
      "attributes": [
        {
          "key": "windows_sid",
          "value": "some_value"
        }
      ]
    }
  ]
}
post/local-user-store/api/v1/users

Create a user

Create a new user.

commentstring

A comment describing the object

Example
"A comment"
tagsarray

Array of tag strings

usernamestring

required

A unique principal name for the user, a username or an email address

windows_accountstring

Windows account name

unix_accountstring

Unix account name

full_namestring

Full name

display_namestring

Display name

job_titlestring

Job title

companystring

Company

departmentstring

Department

emailstring

Email address

telephonestring

Phone number

localestring

User's locale. Language code ISO 639-1 & country code ISO 3166-1 separated by a "_"

Example
"fi_FI"
passwordobject (password)
passwordstring

required

Password

Format
password
createdstring

When the password was created

Format
date-time
Example
"2017-01-01T15:05:05Z"
attributesarray

a list of user attributes in key/value string format

keystring

the name of the user attribute

Example
"windows_sid"
valuestring

the value of the user attribute

Example
"some_value"

Responses

Request examples

{
  "comment": "A comment",
  "tags": [
    "string"
  ],
  "username": "string",
  "windows_account": "string",
  "unix_account": "string",
  "full_name": "string",
  "display_name": "string",
  "job_title": "string",
  "company": "string",
  "department": "string",
  "email": "string",
  "telephone": "string",
  "locale": "fi_FI",
  "password": {
    "password": "string",
    "created": "2017-01-01T15:05:05Z"
  },
  "attributes": [
    {
      "key": "windows_sid",
      "value": "some_value"
    }
  ]
}

Response examples

User successfully created

{
  "id": "5bf77342-221c-11ee-be56-0242ac120002"
}
get/local-user-store/api/v1/users/{user_id}

Get a user

Get a user by ID.

user_idstring

required

User ID

Format
uuid

Responses

Response examples

Successful response, returns a user object

{
  "id": "5bf77342-221c-11ee-be56-0242ac120002",
  "created": "2017-01-01T15:05:05Z",
  "updated": "2017-01-01T15:05:05Z",
  "updated_by": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
  "author": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
  "comment": "A comment",
  "tags": [
    "string"
  ],
  "username": "string",
  "windows_account": "string",
  "unix_account": "string",
  "full_name": "string",
  "display_name": "string",
  "job_title": "string",
  "company": "string",
  "department": "string",
  "email": "string",
  "telephone": "string",
  "locale": "fi_FI",
  "password": {
    "password": "string",
    "created": "2017-01-01T15:05:05Z"
  },
  "password_change_required": true,
  "attributes": [
    {
      "key": "windows_sid",
      "value": "some_value"
    }
  ]
}
put/local-user-store/api/v1/users/{user_id}

Update a user

Update a user by ID.

commentstring

A comment describing the object

Example
"A comment"
tagsarray

Array of tag strings

usernamestring

required

A unique principal name for the user, a username or an email address

windows_accountstring

Windows account name

unix_accountstring

Unix account name

full_namestring

Full name

display_namestring

Display name

job_titlestring

Job title

companystring

Company

departmentstring

Department

emailstring

Email address

telephonestring

Phone number

localestring

User's locale. Language code ISO 639-1 & country code ISO 3166-1 separated by a "_"

Example
"fi_FI"
passwordobject (password)
passwordstring

required

Password

Format
password
createdstring

When the password was created

Format
date-time
Example
"2017-01-01T15:05:05Z"
attributesarray

a list of user attributes in key/value string format

keystring

the name of the user attribute

Example
"windows_sid"
valuestring

the value of the user attribute

Example
"some_value"

Responses

Request examples

{
  "comment": "A comment",
  "tags": [
    "string"
  ],
  "username": "string",
  "windows_account": "string",
  "unix_account": "string",
  "full_name": "string",
  "display_name": "string",
  "job_title": "string",
  "company": "string",
  "department": "string",
  "email": "string",
  "telephone": "string",
  "locale": "fi_FI",
  "password": {
    "password": "string",
    "created": "2017-01-01T15:05:05Z"
  },
  "attributes": [
    {
      "key": "windows_sid",
      "value": "some_value"
    }
  ]
}

Response examples

User successfully updated

Empty response

delete/local-user-store/api/v1/users/{user_id}

Delete a user

Delete a user by ID.

user_idstring

required

User ID

Format
uuid

Responses

Response examples

User successfully deleted

Empty response

put/local-user-store/api/v1/users/{user_id}/password

Set user's password

Set user's password

passwordstring

required

Password

Format
password
createdstring

When the password was created

Format
date-time
Example
"2017-01-01T15:05:05Z"

Responses

Request examples

{
  "password": "string",
  "created": "2017-01-01T15:05:05Z"
}

Response examples

Password successfully changed

Empty response

get/local-user-store/api/v1/users/tags

List user's tags

Get all of user's tags.

offsetint

Collection query offset

Default
0
Min
0
limitint

Maximum number of collection items to return

Default
50
sortdirstring

Sort direction, asc or desc

Default
"ASC"
Enum
  • ASC
  • DESC
querystring

Query string matches the tags

Responses

Response examples

Received list of host's tags

[
  "string"
]

Was this page helpful?