• Local User Store

trusted-clients

PrivX trusted clients

get/local-user-store/api/v1/trusted-clients

Gets trusted clients.

Authorizationstring

required

OAuth2 token

Default
"Bearer a-proper-token-goes-here"

Responses

Response examples

Successful response, returns an array of trusted clients, returns an empty array if no trusted clients defined

{
  "count": 123,
  "items": [
    {
      "id": "5bf77342-221c-11ee-be56-0242ac120002",
      "type": "string",
      "secret": "string",
      "name": "string",
      "access_group_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",
      "permissions": [
        "string"
      ],
      "subnets": [
        "string"
      ],
      "enabled": true,
      "registered": true,
      "extender_address": [
        "string"
      ],
      "oauth_client_id": "string",
      "oauth_client_secret": "string",
      "group_id": "string",
      "web_proxy_address": "string",
      "web_proxy_port": 123,
      "routing_prefix": "string"
    }
  ]
}
post/local-user-store/api/v1/trusted-clients

Create a new trusted client. ID, client_secret, author, created, updated, and updated_by fields are automatically populated by the server.

typestring

Trusted client type

namestring
access_group_idstring

Defines trusted client's access group which affects host and connection permissions

Format
uuid
permissionsarray

List of permissions possessed by the trusted client

subnetsarray

List of trusted-client subnets

extender_addressarray
group_idstring
web_proxy_addressstring
web_proxy_portint
routing_prefixstring

Responses

Request examples

{
  "type": "string",
  "name": "string",
  "access_group_id": "5bf77342-221c-11ee-be56-0242ac120002",
  "permissions": [
    "string"
  ],
  "subnets": [
    "string"
  ],
  "extender_address": [
    "string"
  ],
  "group_id": "string",
  "web_proxy_address": "string",
  "web_proxy_port": 123,
  "routing_prefix": "string"
}

Response examples

Trusted client successfully created

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

Gets trusted client object by id.

trusted_client_idstring

required

Trusted-client ID

Responses

Response examples

Successful response, returns a trusted client if found

{
  "id": "5bf77342-221c-11ee-be56-0242ac120002",
  "type": "string",
  "secret": "string",
  "name": "string",
  "access_group_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",
  "permissions": [
    "string"
  ],
  "subnets": [
    "string"
  ],
  "enabled": true,
  "registered": true,
  "extender_address": [
    "string"
  ],
  "oauth_client_id": "string",
  "oauth_client_secret": "string",
  "group_id": "string",
  "web_proxy_address": "string",
  "web_proxy_port": 123,
  "routing_prefix": "string"
}
put/local-user-store/api/v1/trusted-clients/{trusted_client_id}

Update a trusted client.

typestring

Trusted client type

namestring
access_group_idstring

Defines trusted client's access group which affects host and connection permissions

Format
uuid
permissionsarray

List of permissions possessed by the trusted client

subnetsarray

List of trusted-client subnets

enabledboolean
registeredboolean
extender_addressarray
web_proxy_addressstring
web_proxy_portint
routing_prefixstring

Responses

Request examples

{
  "type": "string",
  "name": "string",
  "access_group_id": "5bf77342-221c-11ee-be56-0242ac120002",
  "permissions": [
    "string"
  ],
  "subnets": [
    "string"
  ],
  "enabled": true,
  "registered": true,
  "extender_address": [
    "string"
  ],
  "web_proxy_address": "string",
  "web_proxy_port": 123,
  "routing_prefix": "string"
}

Response examples

Trusted client successfully updated

Empty response

delete/local-user-store/api/v1/trusted-clients/{trusted_client_id}

Delete a trusted client by ID.

trusted_client_idstring

required

Trusted-client ID

Responses

Response examples

Trusted client successfully deleted

Empty response

Was this page helpful?