Powered by Redocly

Entity Aliases

An entity alias represents the specific for a user when logged in through some specific authentication facility. It can, as a convenience, be auto-created when a user is added in the userpass list. If different policies are desired for a given user depending on which facility is used to authenticate, then those can be specified in the entity alias.

Create a new entity alias

SecurityaccessToken
Request
query Parameters
validate
string <enumeration>

Validate the request but do not actually perform the requested operation

Value: "true"
Request Body schema:
name
required
string <name>

The name consists of a combination of mount accessor and entity name

object
policies
Array of strings <name>
canonical-id
string

The canonical-id uniquely pinpoints an entity. Multiple entity-aliases may point to the same entity using the canonical-id reference.

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/entity-aliases
Request samples 
name: auth-userpass-92c0f779-joe@acme.com
metadata:
  username: userpass-92c0f779-joe@acme.com
policies:
  - user
canonical-id: ce221f46-2e33-47c9-b504-dcd1328f01d3
distribute:
  to: all

Retrieve the configuration of all entity aliases

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/entity-aliases
Response samples 
- name: auth-userpass-92c0f779-joe@acme.com
  metadata:
    username: userpass-92c0f779-joe@acme.com
  policies:
    - user
  canonical-id: ce221f46-2e33-47c9-b504-dcd1328f01d3
  distribute:
    to: all

Update an entity alias

SecurityaccessToken
Request
path Parameters
entity-alias-name
required
string <name>

The name consists of a combination of mount accessor and entity name

query Parameters
validate
string <enumeration>

Validate the request but do not actually perform the requested operation

Value: "true"
Request Body schema:
name
required
string <name>

The name consists of a combination of mount accessor and entity name

object
policies
Array of strings <name>
canonical-id
string

The canonical-id uniquely pinpoints an entity. Multiple entity-aliases may point to the same entity using the canonical-id reference.

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/entity-aliases/{entity-alias-name}
Request samples 
name: auth-userpass-92c0f779-joe@acme.com
metadata:
  username: userpass-92c0f779-joe@acme.com
policies:
  - user
canonical-id: ce221f46-2e33-47c9-b504-dcd1328f01d3
distribute:
  to: all

Delete an entity alias

SecurityaccessToken
Request
path Parameters
entity-alias-name
required
string <name>

The name consists of a combination of mount accessor and entity name

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/entity-aliases/{entity-alias-name}

Replace or create a new entity alias

SecurityaccessToken
Request
path Parameters
entity-alias-name
required
string <name>

The name consists of a combination of mount accessor and entity name

query Parameters
validate
string <enumeration>

Validate the request but do not actually perform the requested operation

Value: "true"
Request Body schema:
name
required
string <name>

The name consists of a combination of mount accessor and entity name

object
policies
Array of strings <name>
canonical-id
string

The canonical-id uniquely pinpoints an entity. Multiple entity-aliases may point to the same entity using the canonical-id reference.

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/entity-aliases/{entity-alias-name}
Request samples 
name: auth-userpass-92c0f779-joe@acme.com
metadata:
  username: userpass-92c0f779-joe@acme.com
policies:
  - user
canonical-id: ce221f46-2e33-47c9-b504-dcd1328f01d3
distribute:
  to: all

Retrieve the configuration of an entity alias

SecurityaccessToken
Request
path Parameters
entity-alias-name
required
string <name>

The name consists of a combination of mount accessor and entity name

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/entity-aliases/{entity-alias-name}
Response samples 
name: auth-userpass-92c0f779-joe@acme.com
metadata:
  username: userpass-92c0f779-joe@acme.com
policies:
  - user
canonical-id: ce221f46-2e33-47c9-b504-dcd1328f01d3
distribute:
  to: all

Retrieve the state of all entity aliases

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/entity-aliases
Response samples 
- name: auth-userpass-92c0f779-joe@acme.com
  metadata:
    username: userpass-92c0f779-joe@acme.com
  policies:
    - user
  canonical-id: ce221f46-2e33-47c9-b504-dcd1328f01d3
  distribute:
    to: all
  distribution-status:
    to: all
  creation-time: 2022-01-13T08:59:52.283794Z
  id: 9e07f97c-b3fd-43c5-8443-10b36a3c6b6a
  modified-time: 2022-01-13T08:59:52.283794Z

Retrieve the state of an entity alias

SecurityaccessToken
Request
path Parameters
entity-alias-name
required
string <name>

The name consists of a combination of mount accessor and entity name

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/entity-aliases/{entity-alias-name}
Response samples 
name: auth-userpass-92c0f779-joe@acme.com
metadata:
  username: userpass-92c0f779-joe@acme.com
policies:
  - user
canonical-id: ce221f46-2e33-47c9-b504-dcd1328f01d3
distribute:
  to: all
distribution-status:
  to: all
creation-time: 2022-01-13T08:59:52.283794Z
id: 9e07f97c-b3fd-43c5-8443-10b36a3c6b6a
modified-time: 2022-01-13T08:59:52.283794Z
➔ Next to Kubernetes Authentication