entity
Create an Entity
This endpoint creates or updates an Entity.
Method | Path |
---|---|
POST | /identity/entity |
Parameters
name
(string: entity-<UUID>)
– Name of the entity.id
(string: <optional>)
- ID of the entity. If set, updates the corresponding existing entity.metadata
(key-value-map: {})
– Metadata to be associated with the entity.policies
(list of strings: [])
– Policies to be tied to the entity.disabled
(bool: false)
– Whether the entity is disabled. Disabled entities' associated tokens cannot be used, but are not revoked.
Sample Payload
Sample Request
Sample Response
Read Entity by ID
This endpoint queries the entity by its identifier.
Method | Path |
---|---|
GET | /identity/entity/id/:id |
Parameters
id
(string: <required>)
– Identifier of the entity.
Sample Request
Sample Response
Update Entity by ID
This endpoint is used to update an existing entity.
Method | Path |
---|---|
POST | /identity/entity/id/:id |
Parameters
id
(string: <required>)
– Identifier of the entity.name
(string: entity-<UUID>)
– Name of the entity.metadata
(key-value-map: {})
– Metadata to be associated with the entity.policies
(list of strings: [])
– Policies to be tied to the entity.disabled
(bool: false)
– Whether the entity is disabled. Disabled entities' associated tokens cannot be used, but are not revoked.
Sample Payload
Sample Request
Sample Response
Delete Entity by ID
This endpoint deletes an entity and all its associated aliases.
Method | Path |
---|---|
DELETE | /identity/entity/id/:id |
Parameters
id
(string: <required>)
– Identifier of the entity.
Sample Request
Batch Delete Entities
This endpoint deletes all entities provided.
Method | Path |
---|---|
POST | /identity/entity/batch-delete |
Parameters
entity_ids
([]string: <required>)
– List of entity identifiers to delete.
Sample Payload
Sample Request
List Entities by ID
This endpoint returns a list of available entities by their identifiers.
Method | Path |
---|---|
LIST | /identity/entity/id |
GET | /identity/entity/id?list=true |
Sample Request
Sample Response
Create/Update Entity by Name
This endpoint is used to create or update an entity by a given name.
Method | Path |
---|---|
POST | /identity/entity/name/:name |
Parameters
name
(string: entity-<UUID>)
– Name of the entity.metadata
(key-value-map: {})
– Metadata to be associated with the entity.policies
(list of strings: [])
– Policies to be tied to the entity.disabled
(bool: false)
– Whether the entity is disabled. Disabled entities' associated tokens cannot be used, but are not revoked.
Sample Payload
Sample Request
Sample Response
Read Entity by Name
This endpoint queries the entity by its name.
Method | Path |
---|---|
GET | /identity/entity/name/:name |
Parameters
name
(string: <required>)
– Name of the entity.
Sample Request
Sample Response
Delete Entity by Name
This endpoint deletes an entity and all its associated aliases, given the entity name.
Method | Path |
---|---|
DELETE | /identity/entity/name/:name |
Parameters
name
(string: <required>)
– Name of the entity.
Sample Request
List Entities by Name
This endpoint returns a list of available entities by their names.
Method | Path |
---|---|
LIST | /identity/entity/name |
GET | /identity/entity/name?list=true |
Sample Request
Sample Response
Merge Entities
This endpoint merges many entities into one entity. Additionally, all groups associated with from_entity_ids
are merged with those of to_entity_id
.
Method | Path |
---|---|
POST | /identity/entity/merge |
Parameters
from_entity_ids
(array: <required>)
- Entity IDs which needs to get merged.to_entity_id
(string: <required>)
- Entity ID into which all the other entities need to get merged.force
(bool: false)
- Setting this will follow the 'mine' strategy for merging MFA secrets. If there are secrets of the same type both in entities that are merged from and in entity into which all others are getting merged, secrets in the destination will be unaltered. If not set, this API will throw an error containing all the conflicts.
Sample Payload
Sample Request