users

Download Spec

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

Get users.

offset

int

Offset where to start fetching the items

Default
0

limit

int

Number of items to return

Default
50

username

string

The username of the user

id

string

uuid

The ID of the user

Response

ExamplesSchema

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 new user.

comment

string

A comment describing the object

Example
"A comment"

tags

array[string]

Array of tag strings

username

string

required

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

windows_account

string

Windows account name

unix_account

string

Unix account name

full_name

string

Full name

display_name

string

Display name

job_title

string

Job title

company

string

Company

department

string

Department

email

string

Email address

telephone

string

Phone number

locale

string

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

Example
"fi_FI"

password

object (password)

attributes

array[object]

a list of user attributes in key/value string format

Request

{
  "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

ExamplesSchema

User successfully created

{
  "id": "5bf77342-221c-11ee-be56-0242ac120002"
}

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

Get a user.

user_id

string

uuid

required

User ID

Response

ExamplesSchema

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 new user.

comment

string

A comment describing the object

Example
"A comment"

tags

array[string]

Array of tag strings

username

string

required

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

windows_account

string

Windows account name

unix_account

string

Unix account name

full_name

string

Full name

display_name

string

Display name

job_title

string

Job title

company

string

Company

department

string

Department

email

string

Email address

telephone

string

Phone number

locale

string

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

Example
"fi_FI"

password

object (password)

attributes

array[object]

a list of user attributes in key/value string format

Request

{
  "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

ExamplesSchema

User successfully updated

Empty response

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

Delete a user.

user_id

string

uuid

required

User ID

Response

ExamplesSchema

User successfully deleted

Empty response

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

Set user's password

password

string

password

required

Password

created

string

date-time

When the password was created

Example
"2017-01-01T15:05:05Z"

Request

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

Response

ExamplesSchema

Password successfully changed

Empty response

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

Get list of host's tags.

offset

int

Offset where to start fetching the items

Default
0

limit

int

Number of items to return

Default
50

sortdir

string

Sort direction, asc or desc

Default
"ASC"
Enum
  • ASC
  • DESC

query

string

Query string matches the tags

Response

ExamplesSchema

Received list of host's tags

[
  "string"
]

Was this page helpful?