Entities

An entity represents a unique identifier for a user. They can be auto-created when a user is added in, for example, the userpass list, or logs in through a OpenID Connect service.

Create a new entity

SecurityaccessToken

Request

query Parameters

validate

string <enumeration>

Validate the request but do not actually perform the requested operation

Value: "true"

Request Body schema:
application/yaml

name required	string <name>
	object
policies	Array of strings <name> Policies granted to the entity. Will be added to other policies.
disabled	boolean Default: false An entity can be disabled, which will disable all tokens associated with the entity as well.
	to (object) or sites (object) or deployments (object)

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict (instance exists)

503

Service Unavailable (strongbox sealed)

post/v1/config/strongbox/identity/entities

Request samples

Payload

name: userpass-92c0f779-joe@acme.com
metadata:
  username: Joe Smith
policies:
  - user
disabled: false
distribute:
  to: all

Retrieve the configuration of all entities

SecurityaccessToken

Request

query Parameters

fields	string Retrieve only requested fields from the resource See section fields
validate	string <enumeration> Validate the request but do not actually perform the requested operation Value: "true"
keys	string <enumeration> Retrieve only the keys for the list Value: "true"
count	string <enumeration> Retrieve only the number of elements in the list Value: "true"

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

412

Precondition Failed

503

Service Unavailable (strongbox sealed)

get/v1/config/strongbox/identity/entities

Response samples

200

- name: userpass-92c0f779-joe@acme.com
  metadata:
    username: Joe Smith
  policies:
    - user
  disabled: false
  distribute:
    to: all

Update an entity

SecurityaccessToken

Request

path Parameters

entity-name

required

string <name>

name of entity

query Parameters

validate

string <enumeration>

Validate the request but do not actually perform the requested operation

Value: "true"

Request Body schema:
application/yaml

name required	string <name>
	object
policies	Array of strings <name> Policies granted to the entity. Will be added to other policies.
disabled	boolean Default: false An entity can be disabled, which will disable all tokens associated with the entity as well.
	to (object) or sites (object) or deployments (object)

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

412

Precondition Failed

503

Service Unavailable (strongbox sealed)

patch/v1/config/strongbox/identity/entities/{entity-name}

Request samples

Payload

name: userpass-92c0f779-joe@acme.com
metadata:
  username: Joe Smith
policies:
  - user
disabled: false
distribute:
  to: all

Delete an entity

SecurityaccessToken

Request

path Parameters

entity-name

required

string <name>

name of entity

query Parameters

validate

string <enumeration>

Validate the request but do not actually perform the requested operation

Value: "true"

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

412

Precondition Failed

503

Service Unavailable (strongbox sealed)

delete/v1/config/strongbox/identity/entities/{entity-name}

Replace or create a new entity

SecurityaccessToken

Request

path Parameters

entity-name

required

string <name>

name of entity

query Parameters

validate

string <enumeration>

Validate the request but do not actually perform the requested operation

Value: "true"

Request Body schema:
application/yaml

name required	string <name>
	object
policies	Array of strings <name> Policies granted to the entity. Will be added to other policies.
disabled	boolean Default: false An entity can be disabled, which will disable all tokens associated with the entity as well.
	to (object) or sites (object) or deployments (object)

Responses

201

Created

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

412

Precondition Failed

503

Service Unavailable (strongbox sealed)

put/v1/config/strongbox/identity/entities/{entity-name}

Request samples

Payload

name: userpass-92c0f779-joe@acme.com
metadata:
  username: Joe Smith
policies:
  - user
disabled: false
distribute:
  to: all

Retrieve the configuration of an entity

SecurityaccessToken

Request

path Parameters

entity-name

required

string <name>

name of entity

query Parameters

fields	string Retrieve only requested fields from the resource See section fields
validate	string <enumeration> Validate the request but do not actually perform the requested operation Value: "true"

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

412

Precondition Failed

503

Service Unavailable (strongbox sealed)

get/v1/config/strongbox/identity/entities/{entity-name}

Response samples

200

name: userpass-92c0f779-joe@acme.com
metadata:
  username: Joe Smith
policies:
  - user
disabled: false
distribute:
  to: all

Retrieve the state of all entities

SecurityaccessToken

Request

query Parameters

fields	string Retrieve only requested fields from the resource See section fields
site	string Send the request to the specfifed site
content	string <enumeration> Filter descendant nodes in the response Enum: "config" "nonconfig"
keys	string <enumeration> Retrieve only the keys for the list Value: "true"
count	string <enumeration> Retrieve only the number of elements in the list Value: "true"

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

get/v1/state/strongbox/identity/entities

Response samples

200

- name: userpass-92c0f779-joe@acme.com
  metadata:
    username: Joe Smith
  policies:
    - user
  disabled: false
  distribute:
    to: all
  distribution-status:
    to: all
  creation-time: 2022-01-13T08:59:52.283793Z
  id: ce221f46-2e33-47c9-b504-dcd1328f01d3
  modified-time: 2022-01-13T08:59:52.283793Z
  aliases:
    - 9e07f97c-b3fd-43c5-8443-10b36a3c6b6a

Retrieve the state of an entity

SecurityaccessToken

Request

path Parameters

entity-name

required

string <name>

name of entity

query Parameters

fields	string Retrieve only requested fields from the resource See section fields
site	string Send the request to the specfifed site
content	string <enumeration> Filter descendant nodes in the response Enum: "config" "nonconfig"

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

get/v1/state/strongbox/identity/entities/{entity-name}

Response samples

200

name: userpass-92c0f779-joe@acme.com
metadata:
  username: Joe Smith
policies:
  - user
disabled: false
distribute:
  to: all
distribution-status:
  to: all
creation-time: 2022-01-13T08:59:52.283793Z
id: ce221f46-2e33-47c9-b504-dcd1328f01d3
modified-time: 2022-01-13T08:59:52.283793Z
aliases:
  - 9e07f97c-b3fd-43c5-8443-10b36a3c6b6a

Entities

Create a new entity

query Parameters

Request Body schema: application/yamlapplication/jsonapplication/yaml

Retrieve the configuration of all entities

query Parameters

Update an entity

path Parameters

query Parameters

Request Body schema: application/yamlapplication/jsonapplication/yaml

Delete an entity

path Parameters

query Parameters

Replace or create a new entity

path Parameters

query Parameters

Request Body schema: application/yamlapplication/jsonapplication/yaml

Retrieve the configuration of an entity

path Parameters

query Parameters

Retrieve the state of all entities

query Parameters

Retrieve the state of an entity

path Parameters

query Parameters

Request Body schema:
application/yaml

Request Body schema:
application/yaml

Request Body schema:
application/yaml